Skip to navigation
Stanza APIlogger

stanza.logger.datatypes

Module Contents

Classes

NameDescription
MeasurementDataRepresents a single measurement point.
SweepDataRepresents a sweep of measurement data.
SessionMetadataSession-level metadata.

API

class stanza.logger.datatypes.MeasurementData

Represents a single measurement point.

name: str

Value: None

data: dict[str, typing.Any]

Value: None

metadata: dict[str, typing.Any]

Value: None

timestamp: float

Value: None

session_id: str

Value: None

routine_name: str | None

Value: None

to_dict() -> dict[str, typing.Any]

Convert to dictionary for serialization.

class stanza.logger.datatypes.SweepData

Represents a sweep of measurement data.

Supports both 1D and 2D sweeps:

  • 1D: x_data.shape = (N,), y_data.shape = (N,)
  • 2D: x_data.shape = (N, 2), y_data.shape = (N,)
name: str

Value: None

x_data: numpy.ndarray

Value: None

y_data: numpy.ndarray

Value: None

x_label: str | list[str]

Value: None

y_label: str

Value: None

metadata: dict[str, typing.Any]

Value: None

timestamp: float

Value: None

session_id: str

Value: None

routine_name: str | None

Value: None

__post_init__() -> None

Validate sweep data dimensions.

to_dict() -> dict[str, typing.Any]

Convert to dictionary for serialization.

class stanza.logger.datatypes.SessionMetadata

Session-level metadata.

session_id: str

Value: None

start_time: float

Value: None

user: str

Value: None

routine_name: str | None

Value: None

group_name: str | None

Value: None

device_config: dict[str, typing.Any] | None

Value: None

parameters: dict[str, typing.Any] | None

Value: None

end_time: float | None

Value: None

git_commit: str | None

Value: None

duration: float | None

Session duration in seconds.

to_dict() -> dict[str, typing.Any]

Convert to dictionary for serialization.