Skip to content

reference_alignment

reference_alignment #

The aligned-capture reference-alignment enum.

ReferenceAlignment #

Bases: Enum

Whether an aligned capture may fire before matching its reference.

  • REQUIRED — the shutter stays held until the camera aligns with the reference image (default).
  • OPTIONAL — alignment guides the user but never blocks the capture.
Source code in capturegraph-lib/capturegraph/types/scalars/imaging/reference_alignment.py 
 8
 9
10
11
12
13
14
15
16
17
class ReferenceAlignment(Enum, name="edu.cornell.reference_alignment"):
    """Whether an aligned capture may fire before matching its reference.

    - ``REQUIRED`` — the shutter stays held until the camera aligns with the
      reference image (default).
    - ``OPTIONAL`` — alignment guides the user but never blocks the capture.
    """

    REQUIRED = "required"
    OPTIONAL = "optional"