Skip to main content

ObservationOutput

observations.ObservationOutput(period, first_sample_offset, variable_names)

Describe one uniformly sampled observation output.

Parameters

Name Type Description Default
period float Output interval in milliseconds. It must be a positive integer multiple of the receiving SimulationGrid interval. required
first_sample_offset float Label of the first emitted sample relative to the original simulation origin. It must satisfy 0 < first_sample_offset <= period. required
variable_names tuple[str, …] | None Output channel names, or None when the input has no names. When supplied, the tuple length must equal the emitted channel count. required