id4_common.devices.ad_vimba
===========================

.. py:module:: id4_common.devices.ad_vimba

.. autoapi-nested-parse::

   Vimba cameras





Module Contents
---------------

.. py:class:: Trigger(*args, image_name=None, **kwargs)

   Bases: :py:obj:`id4_common.devices.ad_mixins.TriggerBase`


   This trigger mixin class takes one acquisition per trigger.


   .. py:method:: setup_manual_trigger()

      Configure stage_sigs for single-image manual-trigger mode.



   .. py:method:: setup_external_trigger()
      :abstractmethod:


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



   .. py:method:: stage()

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



   .. py:method:: unstage()

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



   .. py:method:: trigger()

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



.. py:class:: VimbaCam

   Bases: :py:obj:`ophyd.areadetector.CamBase`


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


   .. py:attribute:: pool_max_buffers
      :value: None



   .. py:attribute:: serial_number


   .. py:attribute:: sdk_version


   .. py:attribute:: driver_version


   .. py:attribute:: adcore_version


   .. py:attribute:: num_exposures


   .. py:attribute:: connected_signal


   .. py:attribute:: trigger_source


   .. py:attribute:: trigger_overlap


   .. py:attribute:: trigger_exposure_mode


   .. py:attribute:: trigger_button


   .. py:attribute:: exposure_auto


   .. py:attribute:: frame_rate


   .. py:attribute:: image_mode


   .. py:attribute:: acquire_busy


   .. py:attribute:: wait_for_plugins


   .. py:attribute:: frames_delivered


   .. py:attribute:: frames_dropped


   .. py:attribute:: frames_underrun


   .. py:attribute:: packets_received


   .. py:attribute:: packets_missed


   .. py:attribute:: packets_errors


   .. py:attribute:: packets_requested


   .. py:attribute:: packets_resent


   .. py:attribute:: poll_features


   .. py:attribute:: temperature


   .. py:attribute:: gain_auto


.. py:class:: VimbaDetector(*args, default_folder='', hdf1_name_template='%s/%s_%6.6d', hdf1_file_extension='h5', max_num_images=65535, **kwargs)

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


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


   .. py:attribute:: cam


   .. py:attribute:: hdf1


   .. py:attribute:: roi1


   .. py:attribute:: roi2


   .. py:attribute:: roi3


   .. py:attribute:: roi4


   .. py:attribute:: stats1


   .. py:attribute:: stats2


   .. py:attribute:: stats3


   .. py:attribute:: stats4


   .. py:attribute:: stats5


   .. py:attribute:: default_folder
      :value: ''



   .. py:attribute:: hdf1_name_format
      :value: '%s/%s_%6.6d.h5'



   .. py:attribute:: max_num_images
      :value: 65535



   .. py:method:: wait_for_connection(all_signals=False, timeout=2)

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



   .. py:method:: align_on(time=0.1)

      Start detector in alignment mode



   .. py:method:: align_off()

      Stop detector



   .. py:method:: save_images_on()

      Enable the HDF1 plugin to save images.



   .. py:method:: save_images_off()

      Disable the HDF1 plugin so images are not saved.



   .. py:method:: auto_save_on()

      Enable HDF1 autosave mode.



   .. py:method:: auto_save_off()

      Disable HDF1 autosave mode.



   .. py:method:: default_settings()

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



   .. py:method:: plot_select(rois)

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

      This assumes that 4 ROIs are setup in Bluesky.

      :param rois: List with the ROIs numbers to be plotted.
      :type rois: iterable of ints



   .. py:method:: plot_allrois()

      Set all five stats ROIs to hinted kind for plotting.



   .. py:method:: plot_roi1()

      Set only ROI1 stats to hinted kind for plotting.



   .. py:method:: plot_roi2()

      Set only ROI2 stats to hinted kind for plotting.



   .. py:method:: plot_roi3()

      Set only ROI3 stats to hinted kind for plotting.



   .. py:method:: plot_roi4()

      Set only ROI4 stats to hinted kind for plotting.



   .. py:method:: plot_roi5()

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



   .. py:method:: setup_images(base_path, name_template, file_number, flyscan=False)

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



   .. py:property:: save_image_flag

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


   .. py:property:: label_option_map

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


   .. py:property:: plot_options

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


   .. py:method:: select_plot(channels)

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



   .. py:method:: field_for_label(label)

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



   .. py:method:: select_read(channels)

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