Skip to content

API reference / Archive, sampling contract and types

tsdive.Window dataclass 

Window(
    identity: TagIdentity,
    meta: TagMeta,
    contract: SamplingContract,
    start: Timestamp,
    end: Timestamp,
    frame: DataFrame,
    physics: DataPhysics,
)

One tag's samples from start to end and the data physics of the read.

TagStore.read_window returns it. frame holds the columns timestamp, value, quality (verbatim from the archive), severity and valid. physics covers the whole requested span, the stretches before the first sample and after the last included.

Attributes:

Name Type Description
identity TagIdentity
meta TagMeta
contract SamplingContract
start Timestamp
end Timestamp
frame DataFrame
physics DataPhysics

identity instance-attribute 

identity: TagIdentity

meta instance-attribute 

meta: TagMeta

contract instance-attribute 

contract: SamplingContract

start instance-attribute 

start: Timestamp

end instance-attribute 

end: Timestamp

frame instance-attribute 

frame: DataFrame

physics instance-attribute 

physics: DataPhysics