ObservationDefinition

Module: iqm.station_control.interface.models.observation

class ObservationDefinition(*, dut_field, value, unit, uncertainty=None, invalid=False, dut_label, source, tags=[])

Bases: ObservationBase

The content of the observation definition.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Attributes

model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
dut_label	DUT label of the device the observation is about.
source	How the observation was made, e.g. experiment analysis or manual specification.
tags	Human-readable tags of the observation.
dut_field	Name of the property the observation is about.
value	Value of the observation.
unit	SI unit of the value.
uncertainty	Uncertainty of the observation value.
invalid	Flag indicating if the observation is invalid.

Methods

Parameters:

• dut_field (str)

• value (Annotated[bool | str | int | float | complex | ndarray, PlainValidator(func=~exa.common.data.value.validate_value, json_schema_input_type=~typing.Any), PlainSerializer(func=~exa.common.data.value.serialize_value, return_type=PydanticUndefined, when_used=always), WithJsonSchema(json_schema={'type': 'any'}, mode=None)])

• unit (str)

• uncertainty (Annotated[int | float | complex | ndarray, PlainValidator(func=~exa.common.data.value.validate_value, json_schema_input_type=~typing.Any), PlainSerializer(func=~exa.common.data.value.serialize_value, return_type=PydanticUndefined, when_used=always), WithJsonSchema(json_schema={'type': 'any'}, mode=None)] | None)

• invalid (bool)

• dut_label (str)

• source (dict[str, Any])

• tags (list[str])

dut_label: str

DUT label of the device the observation is about.

source: dict[str, Any]

How the observation was made, e.g. experiment analysis or manual specification. source always has the key "type" whose str value determines the other contents of the dict. The currently supported source types are: - analysis_source - configuration_source - measurement_source - sequence_analysis_source - specification_source

tags: list[str]

Human-readable tags of the observation.

model_config = {'extra': 'ignore', 'ser_json_inf_nan': 'constants', 'validate_assignment': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Inheritance