id4_common.devices.ad_mixins

AD mixins

Module Contents

id4_common.devices.ad_mixins.logger

id4_common.devices.ad_mixins.USE_DM_PATH = True

id4_common.devices.ad_mixins.DM_ROOT_PATH = '/gdata/dm/4ID'

class id4_common.devices.ad_mixins.PluginMixin

Bases: ophyd.areadetector.plugins.PluginBase_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.TransformPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.TransformPlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.ImagePlugin

Bases: PluginMixin, ophyd.areadetector.plugins.ImagePlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.PvaPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.PvaPlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.ProcessPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.ProcessPlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.ROIPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.ROIPlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.StatsPlugin(*args, **kwargs)

Bases: PluginMixin, ophyd.areadetector.plugins.StatsPlugin_V34

Remove property attribute found in AD IOCs now.

sigma_x = None

sigma_y = None

start_auto_kind()

Subscribe all compute signals to auto-update component kinds.

stop_auto_kind()

Unsubscribe all compute signals from auto kind updates.

class id4_common.devices.ad_mixins.CodecPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.CodecPlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.ROIStatPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.ROIStatPlugin_V34

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.ROIStatNPlugin

Bases: PluginMixin, ophyd.areadetector.plugins.ROIStatNPlugin_V25

Remove property attribute found in AD IOCs now.

class id4_common.devices.ad_mixins.AttributePlugin

Bases: PluginMixin, ophyd.areadetector.plugins.AttributePlugin_V34

Remove property attribute found in AD IOCs now.

ts_acquiring = None

ts_control = None

ts_current_point = None

ts_num_points = None

ts_read = None

class id4_common.devices.ad_mixins.EigerDetectorCam

Bases: apstools.devices.CamMixin_V34, EigerDetectorCam

Revise EigerDetectorCam for ADCore revisions.

initialize

counting_mode

file_number_sync = None

file_number_write = None

fw_clear = None

link_0 = None

link_1 = None

link_2 = None

link_3 = None

dcu_buff_free = None

offset = None

class id4_common.devices.ad_mixins.VortexDetectorCam

Bases: apstools.devices.CamMixin_V34, ophyd.areadetector.Xspress3DetectorCam

Vortex fluorescence detector camera with simplified trigger and erase controls.

trigger_mode

erase_on_start

offset = None

num_exposures = None

acquire_period = None

class id4_common.devices.ad_mixins.FileStorePluginBaseEpicsName(*args, ioc_path_root=None, **kwargs)

Bases: ophyd.areadetector.filestore_mixins.FileStoreBase

FileStore base that derives file paths from EPICS PV values rather than templates.

property use_dm

Return True if data management path is used for file writing.

make_write_read_paths(path=None)

Return the IOC write path, full file path, and relative file path.

stage()

Stage the file plugin, checking path existence and file collision.

class id4_common.devices.ad_mixins.FileStoreHDF5IterativeWriteEpicsName(*args, **kwargs)

Bases: FileStorePluginBaseEpicsName

HDF5 iterative-write filestore that reads file name from EPICS PVs.

filestore_spec = 'AD_HDF5'

get_frames_per_point()

Return the number of frames expected per scan point.

stage()

Stage the HDF5 plugin and generate the resource document.

unstage()

Unstage the HDF5 plugin and reset the point counter.

generate_datum(key, timestamp, datum_kwargs)

Generate a datum document with the current point number.

class id4_common.devices.ad_mixins.HDF5Plugin

Bases: PluginMixin, ophyd.areadetector.plugins.HDF5Plugin_V34

HDF5 plugin with the property attribute removed for compatibility.

class id4_common.devices.ad_mixins.PolarHDF5Plugin(*args, write_path_template='', **kwargs)

Bases: HDF5Plugin, FileStoreHDF5IterativeWriteEpicsName

Using the filename from EPICS.

autosave

stage()

Stage the HDF5 plugin, enabling image saving if autosave is on.

unstage()

Unstage the HDF5 plugin, disabling image saving if autosave is on.

property warmup_signals

Return ordered dict of (signal, value) pairs used for detector warmup.

warmup()

Run the warmup sequence to prime the HDF5 plugin for fast acquisition.

class id4_common.devices.ad_mixins.TriggerBase(*args, acquisition_signal_dev='cam.acquire', acquire_busy_signal_dev='cam.acquire_busy', **kwargs)

Bases: ophyd.BlueskyInterface

Base class for trigger mixin classes

Subclasses must define a method with this signature:

acquire_changed(self, value=None, old_value=None, **kwargs)

class id4_common.devices.ad_mixins.ADTriggerStatus

Bases: ophyd.areadetector.trigger_mixins.ADTriggerStatus

AreaDetector trigger status that clears array-counter subscriptions on completion.