stanza.logger.writers.hdf5_writer

Module Contents

Classes

NameDescription
HDF5WriterWriter for HDF5 files.

Data

logger

API

1stanza.logger.writers.hdf5_writer.logger

Value: getLogger(...)

1class stanza.logger.writers.hdf5_writer.HDF5Writer(base_directory: str | pathlib.Path, compression: str | None = None, compression_level: int | None = None)

Bases: stanza.logger.writers.base.AbstractDataWriter

Writer for HDF5 files.

1initialize_session(session: stanza.logger.datatypes.SessionMetadata) -> None

Initialize the writer for a new session.

Parameters:

session
stanza.logger.datatypes.SessionMetadata

Session metadata to write

Raises:

WriterError: If session is already initialized or file creation fails

1finalize_session(session: stanza.logger.datatypes.SessionMetadata | None = None) -> None

Finalize the writer for a session.

Parameters:

session
stanza.logger.datatypes.SessionMetadata | None

Optional updated session metadata to write

Raises:

WriterError: If no active session or finalization fails

1write_measurement(measurement: stanza.logger.datatypes.MeasurementData) -> None

Write a single measurement data point.

Parameters:

measurement
stanza.logger.datatypes.MeasurementData

Measurement data to write

Raises:

WriterError: If no active session or write operation fails

1write_sweep(sweep: stanza.logger.datatypes.SweepData) -> None

Write sweep data to HDF5 file.

Parameters:

sweep
stanza.logger.datatypes.SweepData

Sweep data to write

Raises:

WriterError: If no active session or write operation fails

1flush() -> None

Flush data to disk.

Raises:

WriterError: If flush operation fails