pyaml.common.constants

Shared constants and callback action identifiers.

pyaml.common.constants.HORIZONTAL_KICK_SIGN

Sign convention applied to horizontal kicks and kick angles. A value of -1.0 follows the convention used by the PyAML orbit and response-matrix tools.

Classes

Action(*values)

Identify callback points in measurement-tool workflows.

class pyaml.common.constants.Action(*values)

Bases: Enum

Identify callback points in measurement-tool workflows.

Attributes

APPLY	Callback triggered immediately after an actuator excitation.
RESTORE	Callback triggered immediately after restoring the actuator.
MEASURE	Callback triggered immediately after taking a measurement.

APPLY = 0

Triggered immediately after actuator excitation.

INIT = 3

Triggered once before the measurement starts

MEASURE = 2

Triggered immediately after taking a measurement.

RESTORE = 1

Triggered immediately after restoring the actuator to its initial value.