H5Util.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2016 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
#include "MantidNexus/DllConfig.h"
 
#include <limits>
#include <map>
#include <string>
#include <vector>
 
// forward declarations
namespace H5 {
class DataSpace;
class DataSet;
class DSetCreatPropList;
class DataType;
class FileAccPropList;
class Group;
class H5File;
class H5Object;
} // namespace H5
 
namespace Mantid {
namespace Nexus {
namespace H5Util {
enum class Narrowing : bool { Allow = true, Prevent = false };
 
MANTID_NEXUS_DLL H5::FileAccPropList defaultFileAcc();
 
MANTID_NEXUS_DLL bool isHdf5(std::string const &filename);
 
MANTID_NEXUS_DLL H5::DataSpace getDataSpace(const size_t length);
 
template <typename NumT> H5::DataType getType();
 
MANTID_NEXUS_DLL H5::Group createGroupNXS(H5::H5File &file, const std::string &name, const std::string &nxtype);
 
MANTID_NEXUS_DLL H5::Group createGroupNXS(H5::Group &group, const std::string &name, const std::string &nxtype);
 
MANTID_NEXUS_DLL H5::Group createGroupCanSAS(H5::Group &group, const std::string &name, const std::string &nxtype,
                                             const std::string &cstype);
 
MANTID_NEXUS_DLL H5::Group createGroupCanSAS(H5::H5File &file, const std::string &name, const std::string &nxtype,
                                             const std::string &cstype);
 
MANTID_NEXUS_DLL H5::DSetCreatPropList setCompressionAttributes(const std::size_t length, const int deflateLevel = 6);
 
MANTID_NEXUS_DLL void writeStrAttribute(const H5::H5Object &object, const std::string &name, const std::string &value);
 
template <typename NumT> void writeNumAttribute(const H5::H5Object &object, const std::string &name, const NumT &value);
 
template <typename NumT>
void writeNumAttribute(const H5::H5Object &object, const std::string &name, const std::vector<NumT> &value);
 
MANTID_NEXUS_DLL void write(H5::Group &group, const std::string &name, const std::string &value);
 
template <typename T>
void writeScalarDataSetWithStrAttributes(H5::Group &group, const std::string &name, const T &value,
                                         const std::map<std::string, std::string> &attributes);
 
template <typename NumT> void writeArray1D(H5::Group &group, const std::string &name, const std::vector<NumT> &values);
 
MANTID_NEXUS_DLL std::string readString(H5::H5File &file, const std::string &address);
 
MANTID_NEXUS_DLL std::string readString(const H5::Group &group, const std::string &name);
 
MANTID_NEXUS_DLL std::string readString(const H5::DataSet &dataset);
 
MANTID_NEXUS_DLL std::vector<std::string> readStringVector(H5::Group &, const std::string &);
 
MANTID_NEXUS_DLL std::vector<std::string> readStringVector(H5::DataSet &);
 
MANTID_NEXUS_DLL bool hasAttribute(const H5::H5Object &object, const char *attributeName);
 
MANTID_NEXUS_DLL void readStringAttribute(const H5::H5Object &object, const std::string &attributeName,
                                          std::string &output);
 
template <typename NumT, Narrowing narrow = Narrowing::Allow>
NumT readNumAttributeCoerce(const H5::H5Object &object, const std::string &attributeName);
 
template <typename NumT, Narrowing narrow = Narrowing::Allow>
std::vector<NumT> readNumArrayAttributeCoerce(const H5::H5Object &object, const std::string &attributeName);
 
template <typename NumT, Narrowing narrow = Narrowing::Allow>
void readArray1DCoerce(const H5::Group &group, const std::string &name, std::vector<NumT> &output);
 
template <typename NumT, Narrowing narrow = Narrowing::Allow>
std::vector<NumT> readArray1DCoerce(const H5::Group &group, const std::string &name);
 
template <typename NumT, Narrowing narrow = Narrowing::Allow>
void readArray1DCoerce(const H5::DataSet &dataset, std::vector<NumT> &output,
                       const size_t length = std::numeric_limits<size_t>::max(),
                       const size_t offset = static_cast<size_t>(0));
 
MANTID_NEXUS_DLL bool groupExists(H5::H5Object const &h5, const std::string &groupAddress);
 
MANTID_NEXUS_DLL bool keyHasValue(H5::H5Object const &h5, const std::string &key, const std::string &value);
 
MANTID_NEXUS_DLL void copyGroup(H5::H5Object &dest, const std::string &destGroupAddress, H5::H5Object &src,
                                const std::string &srcGroupAddress);
 
MANTID_NEXUS_DLL void deleteObjectLink(H5::H5Object &h5, const std::string &target);
 
} // namespace H5Util
} // namespace Nexus
} // namespace Mantid