robowflex::IO::HDF5Data Class Reference

A container class for HDF5 DataSets loaded by an HDF5File. More...

#include <hdf5.h>

Public Member Functions
template<typename T >
	HDF5Data (const T &location, const std::string &name)
	Constructor. Loads reads DataSet from file. More...
	~HDF5Data ()
	Destructor. Cleans up all read data. More...
const std::vector< hsize_t >	getDims () const
	Gets the dimensions of the data. Can be used to create the array necessary to store results. More...
const void *	getData () const
	Get a pointer to the underlying data array. It is of size type[dim0][dim1]... More...
const std::string	getStatus () const
	Get a string describing the data. More...
template<typename T >
const T &	get (const std::vector< hsize_t > &index) const
	Get the value at an index. More...

Private Member Functions
std::tuple< H5::PredType, unsigned int, std::string >	getDataProperties () const
	Return information about the data type of the data. More...

Private Attributes
const H5::DataSet	dataset_
	Dataset being read from. More...
const H5::DataSpace	space_
	Size of the dataset. More...
const H5T_class_t	type_
	Type of the dataset. More...
const int	rank_
	Rank of the dataset. More...
const hsize_t *	dims_
	Dimensions of the dataset (rank_ dimensions) More...
const void *	data_
	Data itself. More...

Detailed Description

A container class for HDF5 DataSets loaded by an HDF5File.

Definition at line 32 of file hdf5.h.

Constructor & Destructor Documentation

HDF5Data()

template<typename T >

template IO::HDF5Data::HDF5Data	(	const T &	location,
		const std::string &	name
	)

Constructor. Loads reads DataSet from file.

Parameters

[in]	location	Location to read data from.
[in]	name	Name of object to read.

Template Parameters

H5	type to read.

IO::HDF5Data

Definition at line 18 of file hdf5.cpp.

  : dataset_(location.openDataSet(name))
  , space_(dataset_.getSpace())
  , type_(dataset_.getTypeClass())
  , rank_(space_.getSimpleExtentNdims())
  , dims_([&] {
      auto *dims = new hsize_t[rank_];
      space_.getSimpleExtentDims(dims);
      return dims;
  }())
  , data_([&] {
      const auto &properties = getDataProperties();
      void *data = std::malloc(std::get<1>(properties) *  //
                               std::accumulate(dims_, dims_ + rank_, 1, std::multiplies<hsize_t>()));
 
      dataset_.read(data, std::get<0>(properties), space_, space_);
      return data;
  }())
{
}

~HDF5Data()

IO::HDF5Data::~HDF5Data

(

)

Destructor. Cleans up all read data.

Definition at line 42 of file hdf5.cpp.

{
    delete dims_;
 
    // clang-format off
    ROBOWFLEX_PUSH_DISABLE_GCC_WARNING(-Wcast-qual)
    // clang-format on
 
    std::free((void *)data_);
    ROBOWFLEX_POP_GCC
}

Member Function Documentation

get()

template<typename T >

template const double & IO::HDF5Data::get

(

const std::vector< hsize_t > &

index

)

const

Get the value at an index.

Parameters

[in]

index

The indices at each dimension.

Template Parameters

The	return type of the data.

Returns

The value at the index in the data.

Definition at line 99 of file hdf5.cpp.

{
    if (index.size() != (unsigned int)rank_)
        throw Exception(1, "Index size must be the same as data rank!");
 
    const T *data = reinterpret_cast<const T *>(data_);
    unsigned int offset = 0;
 
    for (int i = 0; i < rank_; ++i)
        offset += hpow(dims_[i], i) * index[rank_ - (i + 1)];
 
    return data[offset];
}

getData()

const void * IO::HDF5Data::getData

(

)

const

Get a pointer to the underlying data array. It is of size type[dim0][dim1]...

Returns

A pointer to the data array.

Definition at line 59 of file hdf5.cpp.

{
    return data_;
}

getDataProperties()

std::tuple< H5::PredType, unsigned int, std::string > IO::HDF5Data::getDataProperties ( ) const

private

Return information about the data type of the data.

Returns

The H5 type, the size of, and the name of the data type.

Definition at line 116 of file hdf5.cpp.

{
    switch (type_)
    {
        case H5T_INTEGER:
            return std::make_tuple(H5::PredType::NATIVE_INT, sizeof(int), "integer");
        case H5T_FLOAT:
            return std::make_tuple(H5::PredType::NATIVE_DOUBLE, sizeof(double), "double");
        // case H5T_TIME:
        // case H5T_STRING:
        // case H5T_BITFIELD:
        // case H5T_OPAQUE:
        // case H5T_COMPOUND:
        // case H5T_REFERENCE:
        // case H5T_ENUM:
        // case H5T_VLEN:
        // case H5T_ARRAY:
        default:
            return std::make_tuple(H5::PredType::NATIVE_OPAQUE, 0, "unknown");
            break;
    }
}

getDims()

const std::vector< hsize_t > IO::HDF5Data::getDims

(

)

const

Gets the dimensions of the data. Can be used to create the array necessary to store results.

Returns

The dimensions of the data.

Definition at line 54 of file hdf5.cpp.

{
    return std::vector<hsize_t>(dims_, dims_ + rank_);
}

getStatus()

const std::string IO::HDF5Data::getStatus

(

)

const

Get a string describing the data.

Returns

A string describing the data.

Definition at line 64 of file hdf5.cpp.

{
    std::stringstream ss;
    ss << "HDF5DataSet ";
    ss << "Rank: " << rank_ << ", ";
    ss << "Type: " << std::get<2>(getDataProperties()) << ", ";
    ss << "Dimensions: ";
    for (int i = 0; i < rank_; ++i)
    {
        if (i > 0)
            ss << " x ";
        ss << dims_[i];
    }
 
    return ss.str();
}

Member Data Documentation

data_

const void* robowflex::IO::HDF5Data::data_

private

Data itself.

Definition at line 84 of file hdf5.h.

dataset_

const H5::DataSet robowflex::IO::HDF5Data::dataset_

private

Dataset being read from.

Definition at line 77 of file hdf5.h.

dims_

const hsize_t* robowflex::IO::HDF5Data::dims_

private

Dimensions of the dataset (rank_ dimensions)

Definition at line 82 of file hdf5.h.

rank_

const int robowflex::IO::HDF5Data::rank_

private

Rank of the dataset.

Definition at line 81 of file hdf5.h.

space_

const H5::DataSpace robowflex::IO::HDF5Data::space_

private

Size of the dataset.

Definition at line 78 of file hdf5.h.

type_

const H5T_class_t robowflex::IO::HDF5Data::type_

private

Type of the dataset.

Definition at line 80 of file hdf5.h.

---

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

• hdf5.h
• hdf5.cpp