perun.io.hdf5

HDF5 IO module.

Module Contents

Functions

exportHDF5(filePath, dataNode)	Export perun data nodes to an HDF5 file.
importHDF5(→ perun.data_model.data.DataNode)	Import DataNode from HDF5 format.
_addNode(h5group, dataNode)	Write node into hdf5 file.
_readNode(→ perun.data_model.data.DataNode)	Read node from hdf5 file.
_addMetric(h5Group, metric)	Write metric into hdf5 file.
_readMetric(→ Union[perun.data_model.data.Metric, ...)	Read metric from hdf5 file.
_addMetricMetadata(group, metadata)	Write metric metadata into hdf5 file.
_readMetricMetadata(→ perun.data_model.data.MetricMetaData)	Read metric metadata form into hdf5 file.
_addRawData(h5Group, rawData)	Write raw data into hdf5 file.
_readRawData(→ perun.data_model.data.RawData)	Read raw data from into hdf5.
_addRegions(h5Group, regions)
_addRegion(h5Group, region)
_readRegions(→ Dict[str, perun.data_model.data.Region])
_readRegion(→ perun.data_model.data.Region)

perun.io.hdf5.exportHDF5(filePath: pathlib.Path, dataNode: perun.data_model.data.DataNode)

Export perun data nodes to an HDF5 file.

Parameters

filePathPath

Output path

dataNodeDataNode

Root of data node tree.

perun.io.hdf5.importHDF5(filePath: pathlib.Path) → perun.data_model.data.DataNode

Import DataNode from HDF5 format.

Parameters

filePathPath

HDF5 file path.

Returns

DataNode

Perun data node.

Raises

ValueError

Incompatible HDF5 file.

perun.io.hdf5._addNode(h5group: h5py.Group, dataNode: perun.data_model.data.DataNode)

Write node into hdf5 file.

perun.io.hdf5._readNode(group: h5py.Group) → perun.data_model.data.DataNode

Read node from hdf5 file.

perun.io.hdf5._addMetric(h5Group: h5py.Group, metric: perun.data_model.data.Metric | perun.data_model.data.Stats)

Write metric into hdf5 file.

perun.io.hdf5._readMetric(group: h5py.Group) → perun.data_model.data.Metric | perun.data_model.data.Stats

Read metric from hdf5 file.

perun.io.hdf5._addMetricMetadata(group: h5py.Group | h5py.Dataset, metadata: perun.data_model.data.MetricMetaData)

Write metric metadata into hdf5 file.

perun.io.hdf5._readMetricMetadata(group: h5py.Group | h5py.Dataset) → perun.data_model.data.MetricMetaData

Read metric metadata form into hdf5 file.

perun.io.hdf5._addRawData(h5Group: h5py.Group, rawData: perun.data_model.data.RawData)

Write raw data into hdf5 file.

perun.io.hdf5._readRawData(group: h5py.Group) → perun.data_model.data.RawData

Read raw data from into hdf5.

perun.io.hdf5._addRegions(h5Group: h5py.Group, regions: Dict[str, perun.data_model.data.Region])

perun.io.hdf5._addRegion(h5Group: h5py.Group, region: perun.data_model.data.Region)

perun.io.hdf5._readRegions(group: h5py.Group) → Dict[str, perun.data_model.data.Region]

perun.io.hdf5._readRegion(group: h5py.Group) → perun.data_model.data.Region