H5Utils::hist::detail Namespace Reference

Classes
struct	regular_axis_t
struct	Axis

Functions
void	chkerr (herr_t code, std::string_view error)
void	write_str_attr (H5::H5Object &obj, const std::string &key, const std::string &val)
void	write_bool_attr (H5::H5Object &obj, const char *key, bool val)
void	write_int_attr (H5::H5Object &obj, const std::string &key, int64_t val)
void	write_double_attr (H5::H5Object &obj, const std::string &key, double val)
void	write_axes (H5::Group &hist_grp, const std::vector< Axis > &axes)
size_t	n_bins (const regular_axis_t &r)
size_t	n_bins (const std::vector< double > &edges)
size_t	n_bins (const std::vector< int64_t > &vals)
size_t	n_bins (const std::vector< std::string > &labels)
size_t	n_bins (const std::pair< int64_t, int64_t > &range)
void	write_str_dataset (H5::Group &parent, const std::string &name, const std::vector< std::string > &values)
void	write_axis_edges (H5::Group &ax_grp, const regular_axis_t &r)
void	write_axis_edges (H5::Group &ax_grp, const std::vector< double > &edges)
void	write_axis_edges (H5::Group &ax_grp, const std::pair< int64_t, int64_t > &range)
void	write_axis_edges (H5::Group &ax_grp, const std::vector< int64_t > &vals)
void	write_axis_edges (H5::Group &ax_grp, const std::vector< std::string > &labels)

Variables
template<typename T>
const H5::DataType	hdf5_t
template<>
const H5::DataType	hdf5_t< double > = H5::PredType::NATIVE_DOUBLE
template<>
const H5::DataType	hdf5_t< float > = H5::PredType::NATIVE_FLOAT
template<>
const H5::DataType	hdf5_t< int > = H5::PredType::NATIVE_INT
template<>
const H5::DataType	hdf5_t< long > = H5::PredType::NATIVE_LONG
template<>
const H5::DataType	hdf5_t< long long > = H5::PredType::NATIVE_LLONG
template<>
const H5::DataType	hdf5_t< unsigned long > = H5::PredType::NATIVE_ULONG
template<>
const H5::DataType	hdf5_t< unsigned long long > = H5::PredType::NATIVE_ULLONG
template<>
const H5::DataType	hdf5_t< unsigned char > = H5::PredType::NATIVE_UCHAR
template<>
const H5::DataType	hdf5_t< unsigned short > = H5::PredType::NATIVE_USHORT

Function Documentation

chkerr()

void H5Utils::hist::detail::chkerr	(	herr_t	code,
		std::string_view	error )

Definition at line 13 of file HistCommon.cxx.

                                               {
  if (code < 0) throw std::runtime_error(std::format("error setting {}",error));
}

n_bins() [1/5]

size_t H5Utils::hist::detail::n_bins

(

const regular_axis_t &

r

)

Definition at line 59 of file HistCommon.cxx.

{ return r.n_bins; }

n_bins() [2/5]

size_t H5Utils::hist::detail::n_bins

(

const std::pair< int64_t, int64_t > &

range

)

Definition at line 63 of file HistCommon.cxx.

{ return static_cast<size_t>(r.second - r.first + 1); }

n_bins() [3/5]

size_t H5Utils::hist::detail::n_bins

(

const std::vector< double > &

edges

)

Definition at line 60 of file HistCommon.cxx.

{ return e.size() - 1; }

n_bins() [4/5]

size_t H5Utils::hist::detail::n_bins

(

const std::vector< int64_t > &

vals

)

Definition at line 61 of file HistCommon.cxx.

{ return e.size(); }

n_bins() [5/5]

size_t H5Utils::hist::detail::n_bins

(

const std::vector< std::string > &

labels

)

Definition at line 62 of file HistCommon.cxx.

{ return e.size(); }

write_axes()

void H5Utils::hist::detail::write_axes	(	H5::Group &	hist_grp,
		const std::vector< Axis > &	axes )

Definition at line 131 of file HistCommon.cxx.

{
  H5::Group ref_axes_grp = hist_grp.createGroup("ref_axes");
  for (size_t ax_n = 0; ax_n < axes.size(); ++ax_n) {
    const auto& ax = axes.at(ax_n);
    H5::Group ax_grp = ref_axes_grp.createGroup("axis_" + std::to_string(ax_n));
 
    std::visit([&ax_grp](const auto& e) {
      write_axis_edges(ax_grp, e);
    }, ax.edges);
 
    write_bool_attr(ax_grp, "underflow", ax.underflow);
    write_bool_attr(ax_grp, "overflow",  ax.overflow);
    write_bool_attr(ax_grp, "circular",  false);
 
    H5::Group ax_meta = ax_grp.createGroup("metadata");
    if (!ax.name.empty()) {
      write_str_attr(ax_meta, "metadata", ax.name);
    }
    ax_grp.createGroup("writer_info");
  }
 
  // Write object-reference dataset "axes"
  std::vector<hobj_ref_t> axis_refs(axes.size());
  for (size_t ax_n = 0; ax_n < axes.size(); ++ax_n) {
    std::string ax_path = "ref_axes/axis_" + std::to_string(ax_n);
    chkerr(H5Rcreate(&axis_refs.at(ax_n), hist_grp.getId(),
                     ax_path.c_str(), H5R_OBJECT, -1),
                     "axis object reference");
  }
  hsize_t ref_dim = axes.size();
  H5::DataSpace ref_space(1, &ref_dim);
  hist_grp.createDataSet("axes", H5::PredType::STD_REF_OBJ, ref_space)
          .write(axis_refs.data(), H5::PredType::STD_REF_OBJ);
}

write_axis_edges() [1/5]

void H5Utils::hist::detail::write_axis_edges	(	H5::Group &	ax_grp,
		const regular_axis_t &	r )

Definition at line 83 of file HistCommon.cxx.

{
  write_str_attr   (ax_grp, "type",  "regular");
  write_double_attr(ax_grp, "lower", r.lower);
  write_double_attr(ax_grp, "upper", r.upper);
  write_int_attr   (ax_grp, "bins",  r.n_bins);
}

write_axis_edges() [2/5]

void H5Utils::hist::detail::write_axis_edges	(	H5::Group &	ax_grp,
		const std::pair< int64_t, int64_t > &	range )

Definition at line 105 of file HistCommon.cxx.

{
  write_str_attr(ax_grp, "type", "integer");
  write_int_attr(ax_grp, "start", range.first);
  write_int_attr(ax_grp, "stop",  range.second);
}

write_axis_edges() [3/5]

void H5Utils::hist::detail::write_axis_edges	(	H5::Group &	ax_grp,
		const std::vector< double > &	edges )

Definition at line 92 of file HistCommon.cxx.

{
  write_str_attr(ax_grp, "type", "variable");
  hsize_t nedges = edges.size();
  H5::DataSpace edge_space(1, &nedges);
  H5::DSetCreatPropList props;
  props.setChunk(1, &nedges);
  props.setDeflate(7);
  ax_grp.createDataSet("edges",
         H5::PredType::NATIVE_DOUBLE, edge_space, props)
        .write(edges.data(), H5::PredType::NATIVE_DOUBLE);
}

write_axis_edges() [4/5]

void H5Utils::hist::detail::write_axis_edges	(	H5::Group &	ax_grp,
		const std::vector< int64_t > &	vals )

Definition at line 112 of file HistCommon.cxx.

{
  write_str_attr(ax_grp, "type", "category");
  hsize_t n = vals.size();
  H5::DataSpace space(1, &n);
  H5::DSetCreatPropList props;
  props.setChunk(1, &n);
  props.setDeflate(7);
  ax_grp.createDataSet("categories",
         H5::PredType::NATIVE_INT64, space, props)
        .write(vals.data(), H5::PredType::NATIVE_INT64);
}

write_axis_edges() [5/5]

void H5Utils::hist::detail::write_axis_edges	(	H5::Group &	ax_grp,
		const std::vector< std::string > &	labels )

Definition at line 125 of file HistCommon.cxx.

{
  write_str_attr(ax_grp, "type", "category");
  write_str_dataset(ax_grp, "categories", labels);
}

write_bool_attr()

void H5Utils::hist::detail::write_bool_attr	(	H5::H5Object &	obj,
		const char *	key,
		bool	val )

Definition at line 28 of file HistCommon.cxx.

{
  H5::DataSpace scalar(H5S_SCALAR);
  uint8_t v = val ? 1 : 0;
  H5::Attribute attr = obj.createAttribute(
    key, H5::PredType::NATIVE_UINT8, scalar);
  attr.write(H5::PredType::NATIVE_UINT8, &v);
}

write_double_attr()

void H5Utils::hist::detail::write_double_attr	(	H5::H5Object &	obj,
		const std::string &	key,
		double	val )

Definition at line 49 of file HistCommon.cxx.

{
  H5::DataSpace scalar(H5S_SCALAR);
  H5::Attribute attr = obj.createAttribute(
    key, H5::PredType::NATIVE_DOUBLE, scalar);
  attr.write(H5::PredType::NATIVE_DOUBLE, &val);
}

write_int_attr()

void H5Utils::hist::detail::write_int_attr	(	H5::H5Object &	obj,
		const std::string &	key,
		int64_t	val )

Definition at line 39 of file HistCommon.cxx.

{
  H5::DataSpace scalar(H5S_SCALAR);
  H5::Attribute attr = obj.createAttribute(
    key, H5::PredType::NATIVE_INT64, scalar);
  attr.write(H5::PredType::NATIVE_INT64, &val);
}

write_str_attr()

void H5Utils::hist::detail::write_str_attr	(	H5::H5Object &	obj,
		const std::string &	key,
		const std::string &	val )

Definition at line 17 of file HistCommon.cxx.

{
  H5::StrType strtype(H5::PredType::C_S1, H5T_VARIABLE);
  H5::DataSpace scalar(H5S_SCALAR);
  H5::Attribute attr = obj.createAttribute(key, strtype, scalar);
  const char* cstr = val.c_str();
  attr.write(strtype, &cstr);
}

write_str_dataset()

void H5Utils::hist::detail::write_str_dataset	(	H5::Group &	parent,
		const std::string &	name,
		const std::vector< std::string > &	values )

Definition at line 65 of file HistCommon.cxx.

{
  H5::StrType strtype(H5::PredType::C_S1, H5T_VARIABLE);
  hsize_t n = values.size();
  H5::DataSpace space(1, &n);
  H5::DSetCreatPropList props;
  props.setChunk(1, &n);
  props.setDeflate(7);
  std::vector<const char*> cstrs;
  cstrs.reserve(n);
  for (const auto& s : values) cstrs.push_back(s.c_str());
  parent.createDataSet(name, strtype, space, props)
        .write(cstrs.data(), strtype);
}

Variable Documentation

hdf5_t

template<typename T>

const H5::DataType H5Utils::hist::detail::hdf5_t

extern

hdf5_t< double >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< double > = H5::PredType::NATIVE_DOUBLE

inline

Definition at line 59 of file HistCommon.h.

hdf5_t< float >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< float > = H5::PredType::NATIVE_FLOAT

inline

Definition at line 61 of file HistCommon.h.

hdf5_t< int >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< int > = H5::PredType::NATIVE_INT

inline

Definition at line 63 of file HistCommon.h.

hdf5_t< long >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< long > = H5::PredType::NATIVE_LONG

inline

Definition at line 65 of file HistCommon.h.

hdf5_t< long long >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< long long > = H5::PredType::NATIVE_LLONG

inline

Definition at line 67 of file HistCommon.h.

hdf5_t< unsigned char >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< unsigned char > = H5::PredType::NATIVE_UCHAR

inline

Definition at line 73 of file HistCommon.h.

hdf5_t< unsigned long >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< unsigned long > = H5::PredType::NATIVE_ULONG

inline

Definition at line 69 of file HistCommon.h.

hdf5_t< unsigned long long >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< unsigned long long > = H5::PredType::NATIVE_ULLONG

inline

Definition at line 71 of file HistCommon.h.

hdf5_t< unsigned short >

template<>

const H5::DataType H5Utils::hist::detail::hdf5_t< unsigned short > = H5::PredType::NATIVE_USHORT

inline

Definition at line 75 of file HistCommon.h.