YODA::H5FileManager Class Reference

Helper class to extract AO information from a H5 file. More...

#include <H5Utils.h>

Public Member Functions
	H5FileManager (const YODA_H5::File &file)
	Constructor.
size_t	version () const
	H5 YODA format version.
size_t	size () const
	Number of AOs in this H5 file.
bool	next ()
	Loads next AO from file.
const string &	path () const
	Path of current AO.
const string &	type () const
	Type of current AO.
vector< string >	loadAnnotations () noexcept
	Serialized annotations of current AO.
vector< double >	loadContent () noexcept
	Serialized content of current AO.
void	skipCommon () noexcept
	Skips next set of annotations and content of current AO.
vector< size_t >	loadMasks () noexcept
	Indices of masked bins in current AO.
void	skipMasks () noexcept
	Skips next set of masked indices of current AO.
vector< string >	loadSources () noexcept
	Labels of error sources of current AO.
void	skipSources () noexcept
	Skips next set of error sources of current AO.
template<typename EdgeT >
vector< EdgeT >	loadEdges () noexcept
	Returns next set of edges of type EdgeT.
template<typename EdgeT >
void	skipEdges () noexcept
	Skips next set of edges of type EdgeT.

Static Public Attributes
static constexpr size_t	AO_META = 2

Detailed Description

Helper class to extract AO information from a H5 file.

Definition at line 272 of file H5Utils.h.

Constructor & Destructor Documentation

H5FileManager()

YODA::H5FileManager::H5FileManager ( const YODA_H5::File &  file )

inline

Constructor.

Definition at line 279 of file H5Utils.h.

        : _index(-1), _cachepos(-1),
          _labelindex(0), _h5file(file),
          _aoinfo(file, "aoinfo"),
          _layout(file, "sizeinfo"),
          _content(file, "content"),
          _annos(file, "annotations"),
          _labels(H5DataSetReader(file, "labels").read<string>()) {
 
      _meta = _aoinfo.readAttribute("meta");
      if (_meta.size() < 2)
        throw ReadError("No file metadata found!");
 
      _annosizes = _layout.read<size_t>(_meta.at(1));
      _datasizes = _layout.read<size_t>(_meta.at(1));
      _labelsizes = _layout.read<size_t>(_layout.next());
    }

Member Function Documentation

loadAnnotations()

vector< string > YODA::H5FileManager::loadAnnotations ( )

inlinenoexcept

Serialized annotations of current AO.

Definition at line 333 of file H5Utils.h.

                                              {
      return _annos.readSlice<string>(_annosizes[_index]);
    }

Referenced by YODA::AOReader< Counter >::mkFromH5(), YODA::AOReader< Estimate0D >::mkFromH5(), YODA::AOReader< ScatterND< N > >::mkFromH5(), YODA::AOReader< BinnedDbn< DbnN, AxisT... > >::mkFromH5(), and YODA::AOReader< BinnedEstimate< AxisT... > >::mkFromH5().

loadContent()

vector< double > YODA::H5FileManager::loadContent ( )

inlinenoexcept

Serialized content of current AO.

Definition at line 338 of file H5Utils.h.

                                          {
      return _content.readSlice<double>(_datasizes[_index]);
    }

Referenced by YODA::AOReader< Counter >::mkFromH5(), YODA::AOReader< Estimate0D >::mkFromH5(), YODA::AOReader< ScatterND< N > >::mkFromH5(), YODA::AOReader< BinnedDbn< DbnN, AxisT... > >::mkFromH5(), and YODA::AOReader< BinnedEstimate< AxisT... > >::mkFromH5().

loadEdges()

template<typename EdgeT >

vector< EdgeT > YODA::H5FileManager::loadEdges ( )

inlinenoexcept

Returns next set of edges of type EdgeT.

Definition at line 385 of file H5Utils.h.

                                       {
 
      const string label = string("edges_") + TypeID<EdgeT>::name();
      auto itr = datasets.find(label);
      if (itr == datasets.end()) {
        // put H5::DataSet into DataSet cache
        datasets[label] = H5DataSetReader(_h5file, label);
        itr = datasets.find(label);
      }
      return itr->second.read<EdgeT>(_layout.next());
    }

References YODA::TypeID< T >::name().

loadMasks()

vector< size_t > YODA::H5FileManager::loadMasks ( )

inlinenoexcept

Indices of masked bins in current AO.

Definition at line 349 of file H5Utils.h.

                                        {
      return _layout.read<size_t>(_layout.next());
    }

Referenced by YODA::AOReader< BinnedDbn< DbnN, AxisT... > >::mkFromH5(), and YODA::AOReader< BinnedEstimate< AxisT... > >::mkFromH5().

loadSources()

vector< string > YODA::H5FileManager::loadSources ( )

inlinenoexcept

Labels of error sources of current AO.

Definition at line 359 of file H5Utils.h.

                                          {
 
      if (_cachepos < 0) { // fill label cache
        _labelcache = _layout.read<size_t>(_labelsizes[_labelindex++]);
        _cachepos = 0;
      }
 
      size_t len = _labelcache[_cachepos++];
      if (len == 0) return {};
 
      vector<size_t> indices(_labelcache.begin()+_cachepos, _labelcache.begin()+_cachepos+len);
      vector<string> sources; sources.reserve(indices.size());
      for (size_t idx : indices) {
        sources.emplace_back(_labels[idx]);
      }
      _cachepos += len;
      return sources;
    }

Referenced by YODA::AOReader< Estimate0D >::mkFromH5(), and YODA::AOReader< BinnedEstimate< AxisT... > >::mkFromH5().

next()

bool YODA::H5FileManager::next ( )

inline

Loads next AO from file.

Definition at line 308 of file H5Utils.h.

                {
      ++_index;
      if ((size_t)_index == size())  return false;
 
      _aodims = _aoinfo.readAt<string>(AO_META*_index, AO_META);
      if (_aodims.empty()) {
        throw ReadError("No AO information found!");
      }
 
      _cachepos = -1;
 
      return true;
    }

References AO_META, and size().

Referenced by YODA::ReaderH5::read().

path()

const string & YODA::H5FileManager::path ( ) const

inline

Path of current AO.

Definition at line 323 of file H5Utils.h.

                               {
      return _aodims.at(0);
    }

Referenced by YODA::AOReader< Counter >::mkFromH5(), YODA::AOReader< Estimate0D >::mkFromH5(), YODA::AOReader< ScatterND< N > >::mkFromH5(), YODA::AOReader< BinnedDbn< DbnN, AxisT... > >::mkFromH5(), YODA::AOReader< BinnedEstimate< AxisT... > >::mkFromH5(), and YODA::ReaderH5::read().

size()

size_t YODA::H5FileManager::size ( ) const

inline

Number of AOs in this H5 file.

Definition at line 303 of file H5Utils.h.

                        {
      return _meta.at(1);
    }

Referenced by next().

skipCommon()

void YODA::H5FileManager::skipCommon ( )

inlinenoexcept

Skips next set of annotations and content of current AO.

Definition at line 343 of file H5Utils.h.

                               {
      _annos.skip(_annosizes[_index]);
      _content.skip(_datasizes[_index]);
    }

Referenced by YODA::AOReaderBase::skip(), YODA::AOReader< Estimate0D >::skip(), YODA::AOReader< BinnedDbn< DbnN, AxisT... > >::skip(), and YODA::AOReader< BinnedEstimate< AxisT... > >::skip().

skipEdges()

template<typename EdgeT >

void YODA::H5FileManager::skipEdges ( )

inlinenoexcept

Skips next set of edges of type EdgeT.

Definition at line 399 of file H5Utils.h.

                              {
      const string label = string("edges_") + TypeID<EdgeT>::name();
      auto itr = datasets.find(label);
      if (itr == datasets.end()) {
        // put H5::DataSet into DataSet cache
        datasets[label] = H5DataSetReader(_h5file, label);
        itr = datasets.find(label);
      }
      itr->second.skip(_layout.next());
    }

References YODA::TypeID< T >::name().

skipMasks()

void YODA::H5FileManager::skipMasks ( )

inlinenoexcept

Skips next set of masked indices of current AO.

Definition at line 354 of file H5Utils.h.

                              {
      _layout.skip(_layout.next());
    }

Referenced by YODA::AOReader< BinnedDbn< DbnN, AxisT... > >::skip(), and YODA::AOReader< BinnedEstimate< AxisT... > >::skip().

skipSources()

void YODA::H5FileManager::skipSources ( )

inlinenoexcept

Skips next set of error sources of current AO.

Definition at line 379 of file H5Utils.h.

                                {
      _layout.skip(_labelsizes[_labelindex++]);
    }

Referenced by YODA::AOReader< Estimate0D >::skip(), and YODA::AOReader< BinnedEstimate< AxisT... > >::skip().

type()

const string & YODA::H5FileManager::type ( ) const

inline

Type of current AO.

Definition at line 328 of file H5Utils.h.

                               {
      return _aodims.at(1);
    }

Referenced by YODA::ReaderH5::read().

version()

size_t YODA::H5FileManager::version ( ) const

inline

H5 YODA format version.

Definition at line 298 of file H5Utils.h.

                           {
      return _meta.at(0);
    }

Member Data Documentation

AO_META

constexpr size_t YODA::H5FileManager::AO_META = 2

staticconstexpr

Definition at line 276 of file H5Utils.h.

Referenced by next(), and YODA::WriterH5::writeAOS().

---

The documentation for this class was generated from the following file:

• include/YODA/Utils/H5Utils.h