Measure

Bases: Generic[MeasureType]

A measure declaration for a measurement extension.

Declare as a class attribute on an AnalogMeasurer subclass. At runtime, each Measure is replaced with a MeasureInstance whose value and error properties can be set from within

measure_range.

Attributes

NameTypeDescription
label
type
description
units
valueOptional[MeasureType]The value of this measure.
errorOptional[MeasureError]Mark this measure as having an error. This can be useful if the measure can not be calculated for the given data passed to measure_range.

Methods

__init__(label: str, *, type: Type[MeasureType] = float, description: str = '', units: str = '') -> None
label
Short label used to identify this measure.
type
Type of value that this measure will be assigned.
description
Description of the measure.
units
Unit of this measure.
enabled() -> bool

True if this Measure has been enabled

AI/LLM users: see llms-extensions.txt for machine-readable documentation.