malcolm.modules.xmap.parts

class malcolm.modules.xmap.parts.XmapDriverPart(name: Anno(name='APartName', typ=<class 'str'>, description='The name of the Part within the Controller'), mri: Anno(name='AMri', typ=<class 'str'>, description='Malcolm resource id of child object'), soft_trigger_modes: Optional[Union[Anno(name='ASoftTriggerModes', typ=<class 'str'>, description='List of trigger modes that do not use hardware triggers'), Sequence[str]]] = None, multiple_image_mode: Anno(name='AMultipleImageMode', typ=<class 'str'>, description='Name of image mode for taking multiple images') = 'Multiple', main_dataset_useful: Anno(name='AMainDatasetUseful', typ=<class 'bool'>, description='Is main detector dataset useful to publish in DatasetTable?') = True, runs_on_windows: Anno(name='APartRunsOnWindows', typ=<class 'bool'>, description='Is the IOC this part connects to running on Windows?') = False, required_version: Optional[Anno(name='AVersionRequirement', typ=<class 'str'>, description='Minimum required version for compatibility')] = None, min_acquire_period: Anno(name='AMinAcquirePeriod', typ=<class 'float'>, description='Minimum acquire period the detector is capable of') = 0.0)[source]

Part for using xmap_driver_block in a scan

Parameters
  • name (str) – The name of the Part within the Controller

  • mri (str) – Malcolm resource id of child object

  • soft_trigger_modes (str) – List of trigger modes that do not use hardware triggers

  • multiple_image_mode (str) – Name of image mode for taking multiple images

  • main_dataset_useful (bool) – Is main detector dataset useful to publish in DatasetTable?

  • runs_on_windows (bool) – Is the IOC this part connects to running on Windows?

  • required_version (str) – Minimum required version for compatibility

  • min_acquire_period (float) – Minimum acquire period the detector is capable of