Source code for quantify_scheduler.enums

# Repository: https://gitlab.com/quantify-os/quantify-scheduler
# Licensed according to the LICENCE file on the main branch
"""Enums for quantify-scheduler."""

from enum import Enum, unique


[docs]class StrEnum(Enum):
    """
    This class functions to include explicit string serialization without adding `str`
    as a base class.
    """

    def __str__(self):
        return self.value


@unique
[docs]class SignalModeType(str, Enum):

    """
    The signal output enum type.

    Used to set the output signal type to a
    modulated or real respectively.
    """

[docs]    COMPLEX = "complex"
[docs]    REAL = "real"


@unique
[docs]class ReferenceSourceType(str, Enum):

    """
    The reference source enum type.

    Used to set the source trigger type to
    internal or external respectively.
    """

[docs]    NONE = "none"
[docs]    INTERNAL = "int"
[docs]    EXTERNAL = "ext"


@unique
[docs]class ModulationModeType(str, Enum):

    """
    The modulation mode enum type.

    Used to set the modulation type to

    1. no modulation. ('none')
    2. Software premodulation applied in the numerical waveforms. ('premod')
    3. Hardware real-time modulation. ('modulate')

    See also :class:`~quantify_scheduler.backends.types.common.Modulation` for the use.
    """

[docs]    NONE = "none"
[docs]    PREMODULATE = "premod"
[docs]    MODULATE = "modulate"


@unique
[docs]class BinMode(StrEnum):

    """
    The acquisition protocol bin mode enum type.

    Used to set the bin type to
    append or average respectively.

    BinMode `APPEND` uses a list where every new
    result will be appended to the list.

    BinMode `AVERAGE` incrementally stores the weighted
    average result.
    """

[docs]    APPEND = "append"
[docs]    AVERAGE = "average"


@unique
[docs]class InstrumentOperationMode(str, Enum):
    """
    The InstrumentOperationMode enum defines in what operational mode an instrument is
    in.

    OPERATING mode sets the Instrument in its default operation mode.
    CALIBRATING mode sets the Instrument in calibration mode in which for example the
    numeric pulses generated by a backend for an AWG are set to np.ones.
    """

[docs]    OPERATING = "operate"
[docs]    CALIBRATING = "calibrate"