id4_common.devices.ad_vimba#

Vimba cameras

Module Contents#

class id4_common.devices.ad_vimba.Trigger(*args, image_name=None, **kwargs)#

Bases: id4_common.devices.ad_mixins.TriggerBase

This trigger mixin class takes one acquisition per trigger.

setup_manual_trigger()#

Configure stage_sigs for single-image manual-trigger mode.

abstractmethod setup_external_trigger()#

Raise NotImplementedError — external trigger is not supported for Vimba detectors.

stage()#

Disarm the detector, subscribe to busy signal, and call parent stage.

unstage()#

Call parent unstage, stop acquisition, clear busy subscription, and restore manual trigger.

trigger()#

Trigger one acquisition and return a status object that completes when acquire_busy drops.

class id4_common.devices.ad_vimba.VimbaCam#

Bases: ophyd.areadetector.CamBase

CamBase subclass for AVT Vimba cameras with trigger, gain, and statistics signals.

pool_max_buffers = None#
serial_number#
sdk_version#
driver_version#
adcore_version#
num_exposures#
connected_signal#
trigger_source#
trigger_overlap#
trigger_exposure_mode#
trigger_button#
exposure_auto#
frame_rate#
image_mode#
acquire_busy#
wait_for_plugins#
frames_delivered#
frames_dropped#
frames_underrun#
packets_received#
packets_missed#
packets_errors#
packets_requested#
packets_resent#
poll_features#
temperature#
gain_auto#
class id4_common.devices.ad_vimba.VimbaDetector(*args, default_folder='', hdf1_name_template='%s/%s_%6.6d', hdf1_file_extension='h5', max_num_images=65535, **kwargs)#

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

Vimba area detector with ROI/stats plugins, HDF5 output, and alignment helpers.

cam#
hdf1#
roi1#
roi2#
roi3#
roi4#
stats1#
stats2#
stats3#
stats4#
stats5#
default_folder = ''#
hdf1_name_format = '%s/%s_%6.6d.h5'#
max_num_images = 65535#
wait_for_connection(all_signals=False, timeout=2)#

Wait for the cam to fully connect before calling the parent wait_for_connection.

align_on(time=0.1)#

Start detector in alignment mode

align_off()#

Stop detector

save_images_on()#

Enable the HDF1 plugin to save images.

save_images_off()#

Disable the HDF1 plugin so images are not saved.

auto_save_on()#

Enable HDF1 autosave mode.

auto_save_off()#

Disable HDF1 autosave mode.

default_settings()#

Configure detector defaults: single-image mode, HDF1 template, and warmup sequence.

plot_select(rois)#

Selects which ROIs will be plotted. All are being read.

This assumes that 4 ROIs are setup in Bluesky.

Parameters:

rois (iterable of ints) – List with the ROIs numbers to be plotted.

plot_allrois()#

Set all five stats ROIs to hinted kind for plotting.

plot_roi1()#

Set only ROI1 stats to hinted kind for plotting.

plot_roi2()#

Set only ROI2 stats to hinted kind for plotting.

plot_roi3()#

Set only ROI3 stats to hinted kind for plotting.

plot_roi4()#

Set only ROI4 stats to hinted kind for plotting.

plot_roi5()#

Set only ROI5 (full detector) stats to hinted kind for plotting.

setup_images(base_path, name_template, file_number, flyscan=False)#

Configure HDF1 file path, name, and number for an upcoming acquisition.

property save_image_flag#

Return True if HDF1 plugin is enabled or autosave is active.

property label_option_map#

Return a mapping from ROI label strings to ROI numbers for plot selection.

property plot_options#

Return a list of all ROI label strings available for plot selection.

select_plot(channels)#

Set hinted kind for the given channel label list, delegating to plot_select.

field_for_label(label)#

Return the ophyd field name for a plot-option label.

select_read(channels)#

No-op: all stats channels are always read (only hinted/normal differ).