pytams.snapshot¶

Attributes¶

`T_Noise`
`T_State`

Classes¶

Snapshot

A dataclass defining a snapshot.

Module Contents¶

T_Noise[source]¶

T_State[source]¶

class Snapshot[source]¶

Bases: Generic[T_Noise, T_State]

A dataclass defining a snapshot.

Gathering what defines a snapshot into an object. The time and score are of float type, but the actual type of the noise and state are completely determined by the forward model. A snapshot is allowed to have a state or not to accommodate memory savings.

Variables:

time – snapshot time
score – score function value
noise – noise used to reach this snapshot
state – model state

time: float[source]¶

score: float[source]¶

noise: T_Noise[source]¶

state: T_State | None = None[source]¶

property has_state: bool[source]¶

Check if snapshot has state.

Returns:: True if state is not None
Return type:: bool