id4_common.devices.vortex_xspress3_me4#

Eiger 1M setup

Module Contents#

id4_common.devices.vortex_xspress3_me4.logger#
id4_common.devices.vortex_xspress3_me4.MAX_IMAGES = 12216#
id4_common.devices.vortex_xspress3_me4.MAX_ROIS = 8#
class id4_common.devices.vortex_xspress3_me4.Trigger(*args, image_name=None, **kwargs)#

Bases: ophyd.areadetector.trigger_mixins.TriggerBase

This trigger mixin class takes one acquisition per trigger.

setup_manual_trigger()#

Configure stage_sigs for internal single-image triggered acquisition.

setup_external_trigger()#

Configure stage_sigs for TTL-veto flyscan triggering.

setup_sgzbca_trigger()#

Configure stage_sigs for SoftGlue BCA TTL-veto triggering.

stage()#

Erase the detector, configure the trigger mode, and arm the Xspress3 before staging.

unstage()#

Stop the Xspress3, unsubscribe the busy callback, and restore manual- trigger mode.

trigger()#

Start one Xspress3 acquisition and return a status object that completes when done.

arm_plan()#

Bluesky plan that arms the Xspress3 and waits until the detector is ready.

class id4_common.devices.vortex_xspress3_me4.ROIStatN#

Bases: ophyd.Device

Single ROI statistics device with name, bounds, and integrated-count readbacks.

roi_name#
use#
max_sizex#
roi_startx#
roi_sizex#
max_sizey#
roi_startxy#
roi_sizey#
bdg_width#
min_value#
max_value#
mean_value#
total_value#
net_value#
reset_button#
class id4_common.devices.vortex_xspress3_me4.VortexROIStatPlugin#

Bases: id4_common.devices.ad_mixins.ROIStatPlugin

ROIStatPlugin with eight named ROI statistics sub-devices for the Vortex Xspress3.

roi1#
roi2#
roi3#
roi4#
roi5#
roi6#
roi7#
roi8#
class id4_common.devices.vortex_xspress3_me4.VortexSCA#

Bases: id4_common.devices.ad_mixins.AttributePlugin

Xspress3 per-channel SCA providing deadtime and event-count attributes.

clock_ticks#
reset_ticks#
reset_counts#
all_events#
all_good#
window1#
window2#
pileup#
event_width#
dt_factor#
dt_percent#
class id4_common.devices.vortex_xspress3_me4.VortexHDF1Plugin(*args, write_path_template='', **kwargs)#

Bases: id4_common.devices.ad_mixins.PolarHDF5Plugin

HDF5 plugin for the Xspress3 4-element Vortex with a separate array-counter readback PV.

array_counter#
array_counter_readback#
class id4_common.devices.vortex_xspress3_me4.TotalCorrectedSignal(prefix, roi_index, **kwargs)#

Bases: ophyd.SignalRO

Signal that returns the deadtime corrected total counts

roi_index#
get(**kwargs)#

Return the sum of deadtime-corrected ROI counts across all Xspress3 channels.

class id4_common.devices.vortex_xspress3_me4.VortexXspress34(*args, default_folder=Path('/net/s4data/export/sector4/4idd/bluesky_images/vortex'), hdf1_file_format='%s/%s_%6.6d.h5', **kwargs)#

Bases: Trigger, id4_common.devices.counters_mixin.ROICountersMixin, ophyd.areadetector.DetectorBase

Four-element Vortex detector driven by an Xspress3 controller with HDF5 file saving.

cam#
chan1#
chan2#
chan3#
chan4#
stats1#
stats2#
stats3#
stats4#
sca1#
sca2#
sca3#
sca4#
total#
hdf1#
default_folder#
hdf1_file_format = '%s/%s_%6.6d.h5'#
align_on(time=0.1)#

Start detector in alignment mode

align_off()#

Stop detector

save_images_on()#

Enable the HDF5 plugin so acquisitions are written to disk.

save_images_off()#

Disable the HDF5 plugin so acquisitions are not written to disk.

auto_save_on()#

Enable HDF5 autosave so files are written automatically.

auto_save_off()#

Disable HDF5 autosave.

wait_for_detector()#

Bluesky plan that waits until the detector array counter stops incrementing.

default_settings()#

Configure HDF5 path, stage signals, ROIs, and manual-trigger mode.

property read_rois#

Return the list of ROI indices that are currently included in reads.

select_roi(rois)#

Set the hinted ROI totals to those in rois, keeping other read_rois as normal.

plot_roi1()#

Set ROI 1 as the hinted plot channel.

plot_roi2()#

Set ROI 2 as the hinted plot channel.

plot_roi3()#

Set ROI 3 as the hinted plot channel.

plot_roi4()#

Set ROI 4 as the hinted plot channel.

property label_option_map#

Return a mapping from human-readable ROI label strings to ROI index integers.

setup_images(base_folder, file_name_base, file_number, flyscan=False)#

Configure HDF5 file name, number, path, and flysetup flag for an upcoming scan.

property save_image_flag#

Return True if the HDF5 plugin is enabled or autosave is on.