1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
#ifndef RITSUKO_HDF5_OPEN_HPP
#define RITSUKO_HDF5_OPEN_HPP
#include "H5Cpp.h"
#include <filesystem>
#include <stdexcept>
#include <string>
/**
* @file open.hpp
* @brief Convenience functions to safely open HDF5 handles.
*/
namespace ritsuko {
namespace hdf5 {
/**
* @param path Path to a HDF5 file.
* @tparam Path_ Type of the path, either as a C-style array, a `std::string`, or a `filesystem::path`.
* @return Handle to the file.
* An error is raised if `path` does not exist.
*/
template<class Path_>
inline H5::H5File open_file(const Path_& path) try {
if (!std::filesystem::exists(path)) {
throw std::runtime_error("no file exists");
}
if constexpr(std::is_same<Path_, std::filesystem::path>::value) {
if constexpr(std::is_same<typename Path_::value_type, char>::value) {
// Avoid copy on POSIX...
return H5::H5File(path.c_str(), H5F_ACC_RDONLY);
} else {
// But still get it to work on Windows...
return H5::H5File(path.string(), H5F_ACC_RDONLY);
}
} else {
return H5::H5File(path, H5F_ACC_RDONLY);
}
} catch (H5::Exception& e) {
std::string message = "failed to open the HDF5 file at '";
if constexpr(std::is_same<Path_, std::filesystem::path>::value) {
message += path.string();
} else {
message += path;
}
message += "'; " + e.getDetailMsg();
throw std::runtime_error(message);
}
/**
* @param handle Parent group (or file).
* @param name Name of the group.
* @return Handle to the group.
* An error is raised if `name` does not refer to a dataset.
*/
inline H5::Group open_group(const H5::Group& handle, const char* name) {
if (!handle.exists(name) || handle.childObjType(name) != H5O_TYPE_GROUP) {
throw std::runtime_error("expected a group at '" + std::string(name) + "'");
}
return handle.openGroup(name);
}
/**
* @param handle Group containing the dataset.
* @param name Name of the dataset inside the group.
* @return Handle to the dataset.
* An error is raised if `name` does not refer to a dataset.
*/
inline H5::DataSet open_dataset(const H5::Group& handle, const char* name) {
if (!handle.exists(name) || handle.childObjType(name) != H5O_TYPE_DATASET) {
throw std::runtime_error("expected a dataset at '" + std::string(name) + "'");
}
return handle.openDataSet(name);
}
/**
* @tparam Object_ Type of the HDF5 handle, usually a `DataSet` or `Group`.
* @param handle HDF5 dataset or group handle.
* @param name Name of the attribute.
*
* @return Attribute handle.
* An error is raised if `name` does not refer to an attribute.
*/
template<class Object_>
H5::Attribute open_attribute(const Object_& handle, const char* name) {
if (!handle.attrExists(name)) {
throw std::runtime_error("expected an attribute at '" + std::string(name) + "'");
}
return handle.openAttribute(name);
}
}
}
#endif
|
