OpticalPathAnnotation

class of dascore.core.inventory inherits from: dascore.core.inventory._IntervalModel, InventoryModel, DascoreBaseModel, pydantic.main.BaseModel

source

OpticalPathAnnotation(
    description: str = ““,
    extra_fields: collections.abc.Mapping[str, str | int | float | bool[str, int, float, bool]] = ,
    start_distance: float ,
    end_distance: float ,
    group: str =”“,
    value: str | bool | int | float[str, bool, int, float] = True,
)-> None

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

group names the variable and value is its state over the interval, so a bare flag is simply a boolean value. String and numeric groups are single valued and their intervals may not overlap; boolean groups state membership and may overlap freely. Point markers (equal start and end) cover nothing, so they are exempt from that rule.