heparchy¶

class heparchy.write.Compression(enum.Enum)[source]

Sets the compression algorithm used to store the datasets.

exception heparchy.write.WriteOnlyError(RuntimeError)[source]

Raised when trying to access write-only data.

exception heparchy.write.OverwriteWarning(RuntimeWarning)[source]

A warning to be raised when a user writes a piece of data twice.

class heparchy.write.MapWriter(Generic[heparchy.write.hdf.MapGeneric], collections.abc.MutableMapping[str, heparchy.write.hdf.MapGeneric])[source]

Provides a dictionary-like interface for writing user-named datasets or metadata.

class heparchy.write.HdfEventWriter(heparchy.write.base.EventWriterBase)[source]

Context manager interface to create and write events.

class heparchy.write.HdfProcessWriter(heparchy.write.base.ProcessWriterBase)[source]

Context manager interface to create and write processes.

class heparchy.write.HdfWriter(heparchy.write.base.WriterBase)[source]

Create a new heparchy hdf5 file object with write access.

exception heparchy.read.ReadOnlyError(RuntimeError)[source]

Raised when trying to write to read-only data.

class heparchy.read.MapReader(Generic[heparchy.read.hdf.MapValue], collections.abc.Mapping[str, heparchy.read.hdf.MapValue])[source]

Read-only dictionary-like interface to user-named heparchy datasets.

class heparchy.read.HdfEventReader(heparchy.read.base.EventReaderBase)[source]

A heparchy event reader object.

class heparchy.read.HdfProcessReader(heparchy.read.base.ProcessReaderBase)[source]

A heparchy process object. This is a numerically subscriptable iterator.

class heparchy.read.HdfReader(heparchy.read.base.ReaderBase)[source]

Create a new heparchy hdf5 file object with read access. Processes stored within are accessed via string subscripting.