SampledMonitor

observations.SampledMonitor()

Per-sample recurrence sampled at completed period endpoints.

Subclasses declare a period and implement init and step. Each input sample produces one candidate output shaped like the input sample; the candidate at the last input of every completed period is emitted and labelled with that input’s timestamp.

Non-static fields are live parameters and appear under their field names in config.monitor. Fields declared with eqx.field(static=True), such as period, are structural and require preparing again when changed. Methods run on an instance rebuilt from the current live values, so self.<field> always reads the invocation’s value. The rebuilt instance is created without calling the constructor.

Candidate outputs keep the input channels, so channel names are inherited. Preserving channel order and meaning is the author’s responsibility. Use StreamingMonitor for outputs that transform channels.

Methods

Name	Description
init	Return the initial state for inputs described by `sample_spec`.
step	Advance `state` by one input sample; return `(state, value)`.

init

observations.SampledMonitor.init(sample_spec)

Return the initial state for inputs described by sample_spec.

step

observations.SampledMonitor.step(state, sample, dt)

Advance state by one input sample; return (state, value).

# SampledMonitor { #tvboptim.observations.SampledMonitor }

```python
observations.SampledMonitor()
```

Per-sample recurrence sampled at completed period endpoints.

Subclasses declare a ``period`` and implement ``init`` and ``step``. Each
input sample produces one candidate output shaped like the input sample;
the candidate at the last input of every completed period is emitted and
labelled with that input's timestamp.

Non-static fields are live parameters and appear under their field names in
``config.monitor``. Fields declared with ``eqx.field(static=True)``, such
as ``period``, are structural and require preparing again when changed.
Methods run on an instance rebuilt from the current live values, so
``self.<field>`` always reads the invocation's value. The rebuilt instance
is created without calling the constructor.

Candidate outputs keep the input channels, so channel names are inherited.
Preserving channel order and meaning is the author's responsibility. Use
``StreamingMonitor`` for outputs that transform channels.

## Methods

| Name | Description |
| --- | --- |
| [init](#tvboptim.observations.SampledMonitor.init) | Return the initial state for inputs described by ``sample_spec``. |
| [step](#tvboptim.observations.SampledMonitor.step) | Advance ``state`` by one input sample; return ``(state, value)``. |

### init { #tvboptim.observations.SampledMonitor.init }

```python
observations.SampledMonitor.init(sample_spec)
```

Return the initial state for inputs described by ``sample_spec``.

### step { #tvboptim.observations.SampledMonitor.step }

```python
observations.SampledMonitor.step(state, sample, dt)
```

Advance ``state`` by one input sample; return ``(state, value)``.