brushline.monitoring.observation

Observation settings, requests, results, and the deterministic simulator.

Explicit observation model for monitoring.

class brushline.monitoring.observation.Observation(*, schema_version: Literal['brushline.observation.v1'] = 'brushline.observation.v1', segment_id: str, detected: bool, observed_class: str | None, measured_value: float | None, error: float | None, confidence: Annotated[float, Ge(ge=0), Le(le=1)], latency_days: Annotated[int, Ge(ge=0)], covered: bool)[source]

Bases: BaseModel

One observation result.

Parameters:
  • schema_version ({"brushline.observation.v1"}) – Schema version.

  • segment_id (str) – Segment.

  • detected (bool) – Detection.

  • observed_class (str or None) – Observed class.

  • measured_value (float or None) – Noisy measurement.

  • error (float or None) – Measurement error.

  • confidence (float) – Confidence.

  • latency_days (int) – Latency.

  • covered (bool) – Coverage.

model_config = {'extra': 'forbid', 'frozen': True}

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

class brushline.monitoring.observation.ObservationConfig(*, coverage: Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)] = 0.8, detection_probability: Annotated[float, ~annotated_types.Ge(ge=0), ~annotated_types.Le(le=1)] = 0.9, measurement_sd: Annotated[float, ~annotated_types.Ge(ge=0)] = 0.1, confusion: dict[str, dict[str, float]]=<factory>, latency_days: Annotated[int, ~annotated_types.Ge(ge=0)] = 0)[source]

Bases: BaseModel

Observation quality settings.

Parameters:
  • coverage (float) – Spatial coverage.

  • detection_probability (float) – Detection probability.

  • measurement_sd (float) – Measurement error standard deviation.

  • confusion (dict of str to dict of str to float) – Class confusion probabilities.

  • latency_days (int) – Observation latency.

model_config = {'extra': 'forbid', 'frozen': True}

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

class brushline.monitoring.observation.ObservationRequest(*, segment_id: Annotated[str, MinLen(min_length=1)], true_class: str, true_value: Annotated[float, Ge(ge=0)], seed: int = 0)[source]

Bases: BaseModel

One observation request.

Parameters:
  • segment_id (str) – Segment id.

  • true_class (str) – True class.

  • true_value (float) – True continuous value.

  • seed (int) – Seed.

model_config = {'extra': 'forbid', 'frozen': True}

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

brushline.monitoring.observation.simulate_observation(request: ObservationRequest, config: ObservationConfig | None = None) → Observation[source]

Simulate coverage, detection, confusion, measurement error, and latency.

Parameters:
Returns:

Observation – Observation evidence.