enums
=====

.. py:module:: quantify_scheduler.enums 

.. autoapi-nested-parse::

   Enums for quantify-scheduler.



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

Classes
~~~~~~~

.. autoapisummary::

   quantify_scheduler.enums.StrEnum
   quantify_scheduler.enums.BinMode
   quantify_scheduler.enums.TimeSource
   quantify_scheduler.enums.TimeRef




.. py:class:: StrEnum

   Bases: :py:obj:`enum.Enum`


   Enum that can be directly serialized to string.


.. py:class:: BinMode

   Bases: :py:obj:`enum.StrEnum`


   Describes how to handle `Acquisitions` that write to the same `AcquisitionIndex`.

   A BinMode is a property of an `AcquisitionChannel` that describes how to
   handle multiple
   :class:`~quantify_scheduler.operations.acquisition_library.Acquisition` s
   that write data to the same `AcquisitionIndex` on a channel.

   The most common use-case for this is when iterating over multiple
   repetitions of a :class:`~quantify_scheduler.schedules.schedule.Schedule`
   When the BinMode is set to `APPEND` new entries will be added as a list
   along the `repetitions` dimension.

   When the BinMode is set to `AVERAGE` the outcomes are averaged together
   into one value.

   Note that not all `AcquisitionProtocols` and backends support all possible
   BinModes. For more information, please see the :ref:`sec-acquisition-protocols`
   reference guide and some of the Qblox-specific :ref:`acquisition details
   <sec-qblox-acquisition-details>`.


   .. py:attribute:: APPEND
      :value: 'append'



   .. py:attribute:: AVERAGE
      :value: 'average'



   .. py:attribute:: FIRST
      :value: 'first'



   .. py:attribute:: DISTRIBUTION
      :value: 'distribution'



.. py:class:: TimeSource

   Bases: :py:obj:`enum.StrEnum`


   Selects the timetag data source for timetag (trace) acquisitions.

   See :class:`~quantify_scheduler.operations.acquisition_library.Timetag` and
   :class:`~quantify_scheduler.operations.acquisition_library.TimetagTrace`.


   .. py:attribute:: FIRST
      :value: 'first'



   .. py:attribute:: SECOND
      :value: 'second'



   .. py:attribute:: LAST
      :value: 'last'



.. py:class:: TimeRef

   Bases: :py:obj:`enum.StrEnum`


   Selects the event that counts as a time reference (i.e. t=0) for timetags.

   See :class:`~quantify_scheduler.operations.acquisition_library.Timetag` and
   :class:`~quantify_scheduler.operations.acquisition_library.TimetagTrace`.


   .. py:attribute:: START
      :value: 'start'



   .. py:attribute:: END
      :value: 'end'



   .. py:attribute:: FIRST
      :value: 'first'



   .. py:attribute:: TIMESTAMP
      :value: 'timestamp'