id4_common.devices.ad_eiger1M
=============================

.. py:module:: id4_common.devices.ad_eiger1M

.. autoapi-nested-parse::

   Eiger 1M setup





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

.. py:class:: TriggerTime(*args, image_name=None, min_period=0.0, delay=0.3, **kwargs)

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


   This trigger mixin class takes one acquisition per trigger.


   .. py:property:: acquisition_signal

      Return the acquisition signal object.


   .. py:property:: delay

      Return the post-trigger delay in seconds.


   .. py:property:: min_period

      Return the minimum time between triggers in seconds.


   .. py:method:: setup_manual_trigger()

      Configure detector stage signals for manual (software) triggering.



   .. py:method:: setup_external_trigger(trigger_type='gate')

      Configure detector stage signals for external hardware triggering.



   .. py:method:: stage()

      Stage the detector, optionally enabling external trigger for flyscans.



   .. py:method:: unstage()

      Unstage the detector, stopping acquisition and waiting for processing to
      finish.



   .. py:method:: trigger()

      Trigger one acquisition.



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

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


   Eiger 1M area detector with HDF5 file writing and statistics plugins.


   .. py:attribute:: cam


   .. py:attribute:: codec1


   .. py:attribute:: codec2


   .. py:attribute:: proc


   .. py:attribute:: trans


   .. py:attribute:: image


   .. 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: 600000



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

      Start detector in alignment mode



   .. py:method:: align_off()

      Stop detector



   .. py:method:: save_images_on()

      Enable HDF5 image saving.



   .. py:method:: save_images_off()

      Disable HDF5 image saving.



   .. py:method:: auto_save_on()

      Enable automatic HDF5 saving on each acquisition.



   .. py:method:: auto_save_off()

      Disable automatic HDF5 saving on each acquisition.



   .. py:method:: default_settings()

      Apply default detector settings and stage signal configuration.



   .. py:method:: plot_all()

      Set all five stats channels to be plotted.



   .. py:method:: plot_stats1()

      Set only Stats1 total to be plotted.



   .. py:method:: plot_stats2()

      Set only Stats2 total to be plotted.



   .. py:method:: plot_stats3()

      Set only Stats3 total to be plotted.



   .. py:method:: plot_stats4()

      Set only Stats4 total to be plotted.



   .. py:method:: plot_stats5()

      Set only Stats5 total to be plotted.



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

      Configure HDF5 file path, name, and number for the upcoming scan.



   .. py:method:: plot_select(stats)

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

      This assumes that 5 stats are setup in Bluesky.

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



   .. py:property:: save_image_flag

      Return True if images will be saved on next acquisition.


   .. py:property:: label_option_map

      Return mapping of stats channel label names to their index numbers.


   .. py:property:: plot_options

      Return list of available channel names for plot selection.


   .. py:method:: select_plot(channels)

      Select which stats channels to plot by label name.



   .. 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).