id4_common.devices.vortex_xmap
==============================

.. py:module:: id4_common.devices.vortex_xmap

.. autoapi-nested-parse::

   Vortex with DXP







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

.. py:data:: MAX_ROIS
   :value: 32


.. py:class:: MyDXP

   Bases: :py:obj:`ophyd.mca.SaturnDXP`


   SaturnDXP subclass that removes unused live_time_output and trigger_output
   components.


   .. py:attribute:: live_time_output
      :value: None



   .. py:attribute:: trigger_output
      :value: None



.. py:class:: MyMCA

   Bases: :py:obj:`ophyd.mca.EpicsMCARecord`


   EpicsMCARecord subclass that adds a check_acquiring signal for polling
   acquisition state.


   .. py:attribute:: check_acquiring


.. py:class:: SingleTrigger(*args, **kwargs)

   Bases: :py:obj:`ophyd.Device`


   This trigger mixin class takes one acquisition per trigger.
   .. rubric:: Examples

   >>> class SimDetector(SingleTrigger):
   ...     pass
   >>> det = SimDetector('..pv..')
   # optionally, customize name of image
   >>> det = SimDetector('..pv..', image_name='fast_detector_image')


   .. py:method:: stage()

      Subscribe the status-signal callback and delegate to parent stage.



   .. py:method:: unstage()

      Unsubscribe the status-signal callback and delegate to parent unstage.



   .. py:method:: trigger()

      Trigger one acquisition.



.. py:class:: TotalCorrectedSignal(prefix, roi_index=0, **kwargs)

   Bases: :py:obj:`ophyd.SignalRO`


   Signal that returns the deadtime corrected total counts


   .. py:attribute:: roi_index
      :value: 0



   .. py:method:: get(**kwargs)

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



.. py:class:: VortexXMAP(*args, **kwargs)

   Bases: :py:obj:`SingleTrigger`, :py:obj:`id4_common.devices.counters_mixin.ROICountersMixin`


   Four-element Vortex detector driven by an XIA XMAP DXP controller.


   .. py:attribute:: start


   .. py:attribute:: stop_


   .. py:attribute:: erase_start


   .. py:attribute:: erase


   .. py:attribute:: status


   .. py:attribute:: collection_mode


   .. py:attribute:: preset_mode


   .. py:attribute:: instant_deadtime


   .. py:attribute:: average_deadtime


   .. py:attribute:: poll_time


   .. py:attribute:: real_preset


   .. py:attribute:: live_preset


   .. py:attribute:: real_elapsed


   .. py:attribute:: live_elapsed


   .. py:attribute:: events_preset


   .. py:attribute:: triggers_preset


   .. py:attribute:: total


   .. py:attribute:: mca1


   .. py:attribute:: mca2


   .. py:attribute:: mca3


   .. py:attribute:: mca4


   .. py:attribute:: dxp1


   .. py:attribute:: dxp2


   .. py:attribute:: dxp3


   .. py:attribute:: dxp4


   .. py:method:: default_kinds()

      Set default read/configuration attribute lists for MCA channels
      (placeholder).



   .. py:method:: default_settings()

      Set default stage signals for erase-on-start and real-time preset mode.



   .. py:property:: read_rois

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


   .. py:method:: select_roi(rois)

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



   .. py:method:: plot_roi0()

      Set ROI 0 as the hinted plot channel.



   .. py:method:: plot_roi1()

      Set ROI 1 as the hinted plot channel.



   .. py:method:: plot_roi2()

      Set ROI 2 as the hinted plot channel.



   .. py:method:: plot_roi3()

      Set ROI 3 as the hinted plot channel.



   .. py:method:: plot_roi4()

      Set ROI 4 as the hinted plot channel.



   .. py:property:: label_option_map

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