perun.io.hdf5
=============

.. py:module:: perun.io.hdf5

.. autoapi-nested-parse::

   HDF5 IO module.



Functions
---------

.. autoapisummary::

   perun.io.hdf5.exportHDF5
   perun.io.hdf5.importHDF5
   perun.io.hdf5._addNode
   perun.io.hdf5._readNode
   perun.io.hdf5._addMetric
   perun.io.hdf5._readMetric
   perun.io.hdf5._addMetricMetadata
   perun.io.hdf5._readMetricMetadata
   perun.io.hdf5._addRawData
   perun.io.hdf5._readRawData
   perun.io.hdf5._addRegions
   perun.io.hdf5._addRegion
   perun.io.hdf5._readRegions
   perun.io.hdf5._readRegion


Module Contents
---------------

.. py:function:: exportHDF5(filePath: pathlib.Path, dataNode: perun.data_model.data.DataNode)

   Export perun data nodes to an HDF5 file.

   Parameters
   ----------
   filePath : Path
       Output path
   dataNode : DataNode
       Root of data node tree.


.. py:function:: importHDF5(filePath: pathlib.Path) -> perun.data_model.data.DataNode

   Import DataNode from HDF5 format.

   Parameters
   ----------
   filePath : Path
       HDF5 file path.

   Returns
   -------
   DataNode
       Perun data node.

   Raises
   ------
   ValueError
       Incompatible HDF5 file.


.. py:function:: _addNode(h5group: h5py.Group, dataNode: perun.data_model.data.DataNode)

   Write node into hdf5 file.


.. py:function:: _readNode(group: h5py.Group) -> perun.data_model.data.DataNode

   Read node from hdf5 file.


.. py:function:: _addMetric(h5Group: h5py.Group, metric: Union[perun.data_model.data.Metric, perun.data_model.data.Stats])

   Write metric into hdf5 file.


.. py:function:: _readMetric(group: h5py.Group) -> Union[perun.data_model.data.Metric, perun.data_model.data.Stats]

   Read metric from hdf5 file.


.. py:function:: _addMetricMetadata(group: Union[h5py.Group, h5py.Dataset], metadata: perun.data_model.data.MetricMetaData)

   Write metric metadata into hdf5 file.


.. py:function:: _readMetricMetadata(group: Union[h5py.Group, h5py.Dataset]) -> perun.data_model.data.MetricMetaData

   Read metric metadata form into hdf5 file.


.. py:function:: _addRawData(h5Group: h5py.Group, rawData: perun.data_model.data.RawData)

   Write raw data into hdf5 file.


.. py:function:: _readRawData(group: h5py.Group) -> perun.data_model.data.RawData

   Read raw data from into hdf5.


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

.. py:function:: _addRegion(h5Group: h5py.Group, region: perun.data_model.data.Region)

.. py:function:: _readRegions(group: h5py.Group) -> Dict[str, perun.data_model.data.Region]

.. py:function:: _readRegion(group: h5py.Group) -> perun.data_model.data.Region