OpticalPathAnnotation

Key/value annotation attached to an interval of an optical path.

The value type decides the group’s shape. Boolean groups state membership and may overlap; string and numeric groups are single valued, so their intervals may not overlap. A group becomes a patch coordinate at enrichment, so it may not take a reserved name — a structural coordinate, a typed track, or a coordinate label.

Aliases: Ann, Annotation

Attributes

Name Type Description
start_distance float Start optical distance of this annotation in meters.
end_distance float End optical distance of this annotation in meters.
group str Name of the annotated variable; becomes the enriched coordinate name.
value str | bool | int | float Value of the variable over this interval; a bare flag is simply a boolean value.
description str Free-text description.

Contains

None.

Contained By

References

None.

Referenced By

None.