id4_common.utils.load_vortex#

Utilities for loading and connecting Vortex detector devices.

Module Contents#

id4_common.utils.load_vortex.logger#
id4_common.utils.load_vortex.DETECTORS#
id4_common.utils.load_vortex.load_vortex(electronic: str, pv: str = None, name: str = 'vortex', labels: list = None, baseline: bool = False, **kwargs)#

Load Vortex detector. kwargs are passed to the detector class.

If a device named name already exists in the registry it is removed first. A warning is issued, and the warning is more prominent when the existing device is a different electronics type than the one being loaded.

The device is added to the __main__ namespace under name so it is available in the interactive session without capturing the return value.

Parameters:

  • electronic (string) – Name of the electronic. Must be one of the keys in DETECTORS: “dante1”, “dante4”, “xmap”, “xspress4”, “xspress7”.

  • pv (string, optional) – PV prefix of detector. If None it will use the default.

  • name (str, optional) – Bluesky name of the detector. Defaults to ‘vortex’.

  • labels (list of strings, optional) – Bluesky labels. Defaults to [“detector”].

  • baseline (bool, optional) – Flag to add the device to the baseline. Defaults to False.

Returns:

vortex_detector

Return type:

Ophyd device