3042 lines
184 KiB
HTML
3042 lines
184 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>musrfit: nxH4::PNeXus Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">musrfit<span id="projectnumber"> 1.10.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',false,false,'search.php','Search',true);
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){initNavTree('classnxH4_1_1PNeXus.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-static-methods">Static Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classnxH4_1_1PNeXus-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">nxH4::PNeXus Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>NeXus HDF4 file reader with case-insensitive path lookup.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a2a9409badd40cdce963415dfd5c9d8c1" id="r_a2a9409badd40cdce963415dfd5c9d8c1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a2a9409badd40cdce963415dfd5c9d8c1">PNeXus</a> ()</td></tr>
|
|
<tr class="separator:a2a9409badd40cdce963415dfd5c9d8c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54230158491746101e47db27f7a49bfb" id="r_a54230158491746101e47db27f7a49bfb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a54230158491746101e47db27f7a49bfb">PNeXus</a> (const std::string fln, const bool printDebug=false)</td></tr>
|
|
<tr class="memdesc:a54230158491746101e47db27f7a49bfb"><td class="mdescLeft"> </td><td class="mdescRight">Constructor - creates <a class="el" href="classnxH4_1_1PNeXus.html" title="NeXus HDF4 file reader with case-insensitive path lookup.">PNeXus</a> object and reads the NeXus file. <br /></td></tr>
|
|
<tr class="separator:a54230158491746101e47db27f7a49bfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37a962cb30c0c212885967d904039eed" id="r_a37a962cb30c0c212885967d904039eed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a37a962cb30c0c212885967d904039eed">~PNeXus</a> ()</td></tr>
|
|
<tr class="memdesc:a37a962cb30c0c212885967d904039eed"><td class="mdescLeft"> </td><td class="mdescRight">Destructor - closes HDF4 file if open. <br /></td></tr>
|
|
<tr class="separator:a37a962cb30c0c212885967d904039eed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6419e3845dce51ae07f8c168ddcc92f" id="r_af6419e3845dce51ae07f8c168ddcc92f"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#af6419e3845dce51ae07f8c168ddcc92f">GetFileName</a> () const</td></tr>
|
|
<tr class="memdesc:af6419e3845dce51ae07f8c168ddcc92f"><td class="mdescLeft"> </td><td class="mdescRight">Get the filename of the NeXus file. <br /></td></tr>
|
|
<tr class="separator:af6419e3845dce51ae07f8c168ddcc92f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a96ae432999542d03ad9a0bfeede9a2f2" id="r_a96ae432999542d03ad9a0bfeede9a2f2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a96ae432999542d03ad9a0bfeede9a2f2">GetHdf4LibVersion</a> () const</td></tr>
|
|
<tr class="memdesc:a96ae432999542d03ad9a0bfeede9a2f2"><td class="mdescLeft"> </td><td class="mdescRight">Get the hdf4 library version. <br /></td></tr>
|
|
<tr class="separator:a96ae432999542d03ad9a0bfeede9a2f2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7977631b7cf9b813818d5c10573423a3" id="r_a7977631b7cf9b813818d5c10573423a3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7977631b7cf9b813818d5c10573423a3">GetHdf4Version</a> () const</td></tr>
|
|
<tr class="memdesc:a7977631b7cf9b813818d5c10573423a3"><td class="mdescLeft"> </td><td class="mdescRight">Get the hdf4 version of the NeXus file. <br /></td></tr>
|
|
<tr class="separator:a7977631b7cf9b813818d5c10573423a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9a066b8802ad8694eb6410afe12bec20" id="r_a9a066b8802ad8694eb6410afe12bec20"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a066b8802ad8694eb6410afe12bec20">GetNeXusVersion</a> () const</td></tr>
|
|
<tr class="memdesc:a9a066b8802ad8694eb6410afe12bec20"><td class="mdescLeft"> </td><td class="mdescRight">Get the NeXus version of the file. <br /></td></tr>
|
|
<tr class="separator:a9a066b8802ad8694eb6410afe12bec20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4738d545822b62db7793b632c9dd7df" id="r_ac4738d545822b62db7793b632c9dd7df"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac4738d545822b62db7793b632c9dd7df">GetIdfVersion</a> () const</td></tr>
|
|
<tr class="memdesc:ac4738d545822b62db7793b632c9dd7df"><td class="mdescLeft"> </td><td class="mdescRight">Get the Idf version of the file. <br /></td></tr>
|
|
<tr class="separator:ac4738d545822b62db7793b632c9dd7df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff642391173eeb42354156d5689aa694" id="r_aff642391173eeb42354156d5689aa694"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aff642391173eeb42354156d5689aa694">ReadNexusFile</a> ()</td></tr>
|
|
<tr class="memdesc:aff642391173eeb42354156d5689aa694"><td class="mdescLeft"> </td><td class="mdescRight">Read and parse the NeXus HDF4 file. <br /></td></tr>
|
|
<tr class="separator:aff642391173eeb42354156d5689aa694"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8e5b2001ca5b18963788ba6b0204c94f" id="r_a8e5b2001ca5b18963788ba6b0204c94f"><td class="memItemLeft" align="right" valign="top">const std::map< std::string, std::any > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e5b2001ca5b18963788ba6b0204c94f">GetDataMap</a> () const</td></tr>
|
|
<tr class="memdesc:a8e5b2001ca5b18963788ba6b0204c94f"><td class="mdescLeft"> </td><td class="mdescRight">Get the data map containing all datasets. <br /></td></tr>
|
|
<tr class="separator:a8e5b2001ca5b18963788ba6b0204c94f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa7e014110eb63606ff4c27fe8f62966" id="r_aaa7e014110eb63606ff4c27fe8f62966"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::any > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaa7e014110eb63606ff4c27fe8f62966">GetDataMap</a> ()</td></tr>
|
|
<tr class="memdesc:aaa7e014110eb63606ff4c27fe8f62966"><td class="mdescLeft"> </td><td class="mdescRight">Get mutable reference to the data map. <br /></td></tr>
|
|
<tr class="separator:aaa7e014110eb63606ff4c27fe8f62966"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acc0c9109803a9c75a3e2ecda11145d21" id="r_acc0c9109803a9c75a3e2ecda11145d21"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc0c9109803a9c75a3e2ecda11145d21">HasDataset</a> (const std::string &path) const</td></tr>
|
|
<tr class="memdesc:acc0c9109803a9c75a3e2ecda11145d21"><td class="mdescLeft"> </td><td class="mdescRight">Check if a dataset path exists in the data map. <br /></td></tr>
|
|
<tr class="separator:acc0c9109803a9c75a3e2ecda11145d21"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2313d4948e4c9b89fbbb4089e3dee323" id="r_a2313d4948e4c9b89fbbb4089e3dee323"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a2313d4948e4c9b89fbbb4089e3dee323"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a2313d4948e4c9b89fbbb4089e3dee323">SetDataset</a> (const std::string &path, const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > &data)</td></tr>
|
|
<tr class="memdesc:a2313d4948e4c9b89fbbb4089e3dee323"><td class="mdescLeft"> </td><td class="mdescRight">Add or update a dataset in the data map. <br /></td></tr>
|
|
<tr class="separator:a2313d4948e4c9b89fbbb4089e3dee323"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cdf7128ac1253415c828e5a8fb2cc10" id="r_a9cdf7128ac1253415c828e5a8fb2cc10"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a9cdf7128ac1253415c828e5a8fb2cc10"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a9cdf7128ac1253415c828e5a8fb2cc10">GetDataset</a> (const std::string &path) const</td></tr>
|
|
<tr class="memdesc:a9cdf7128ac1253415c828e5a8fb2cc10"><td class="mdescLeft"> </td><td class="mdescRight">Get a dataset from the data map. <br /></td></tr>
|
|
<tr class="separator:a9cdf7128ac1253415c828e5a8fb2cc10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7ad9ea24cc9362dba2898611aa8ec0d" id="r_ae7ad9ea24cc9362dba2898611aa8ec0d"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:ae7ad9ea24cc9362dba2898611aa8ec0d"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ae7ad9ea24cc9362dba2898611aa8ec0d">GetDatasetRef</a> (const std::string &path)</td></tr>
|
|
<tr class="memdesc:ae7ad9ea24cc9362dba2898611aa8ec0d"><td class="mdescLeft"> </td><td class="mdescRight">Get a mutable reference to a dataset in the data map. <br /></td></tr>
|
|
<tr class="separator:ae7ad9ea24cc9362dba2898611aa8ec0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0d9efc6062b7e2755c71162e1d0fe8d3" id="r_a0d9efc6062b7e2755c71162e1d0fe8d3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0d9efc6062b7e2755c71162e1d0fe8d3">RemoveDataset</a> (const std::string &path)</td></tr>
|
|
<tr class="memdesc:a0d9efc6062b7e2755c71162e1d0fe8d3"><td class="mdescLeft"> </td><td class="mdescRight">Remove a dataset from the data map. <br /></td></tr>
|
|
<tr class="separator:a0d9efc6062b7e2755c71162e1d0fe8d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3731e1b79076ae956236770c8e43c2d" id="r_ae3731e1b79076ae956236770c8e43c2d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae3731e1b79076ae956236770c8e43c2d">ClearDataMap</a> ()</td></tr>
|
|
<tr class="memdesc:ae3731e1b79076ae956236770c8e43c2d"><td class="mdescLeft"> </td><td class="mdescRight">Clear all datasets from the data map. <br /></td></tr>
|
|
<tr class="separator:ae3731e1b79076ae956236770c8e43c2d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae7d8e8017efb8fc724455a0508931119" id="r_ae7d8e8017efb8fc724455a0508931119"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae7d8e8017efb8fc724455a0508931119">GetNumDatasets</a> () const</td></tr>
|
|
<tr class="memdesc:ae7d8e8017efb8fc724455a0508931119"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of datasets in the data map. <br /></td></tr>
|
|
<tr class="separator:ae7d8e8017efb8fc724455a0508931119"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d00a7bc38d8697c8831ac91320bec7a" id="r_a3d00a7bc38d8697c8831ac91320bec7a"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a3d00a7bc38d8697c8831ac91320bec7a"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a3d00a7bc38d8697c8831ac91320bec7a">UpdateDatasetData</a> (const std::string &path, const std::vector< T > &newData)</td></tr>
|
|
<tr class="memdesc:a3d00a7bc38d8697c8831ac91320bec7a"><td class="mdescLeft"> </td><td class="mdescRight">Update the data of an existing dataset. <br /></td></tr>
|
|
<tr class="separator:a3d00a7bc38d8697c8831ac91320bec7a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a499e4cb6a8ef6a00e5556bbdfb1bd89d" id="r_a499e4cb6a8ef6a00e5556bbdfb1bd89d"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a499e4cb6a8ef6a00e5556bbdfb1bd89d"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a499e4cb6a8ef6a00e5556bbdfb1bd89d">UpdateDatasetDimensions</a> (const std::string &path, const std::vector< uint32_t > &newDimensions)</td></tr>
|
|
<tr class="memdesc:a499e4cb6a8ef6a00e5556bbdfb1bd89d"><td class="mdescLeft"> </td><td class="mdescRight">Update the dimensions of an existing dataset. <br /></td></tr>
|
|
<tr class="separator:a499e4cb6a8ef6a00e5556bbdfb1bd89d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2ebdb86d3a8451122bb1e071de70514" id="r_ac2ebdb86d3a8451122bb1e071de70514"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:ac2ebdb86d3a8451122bb1e071de70514"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ac2ebdb86d3a8451122bb1e071de70514">AddDatasetAttribute</a> (const std::string &path, const std::string &attrName, const std::any &attrValue)</td></tr>
|
|
<tr class="memdesc:ac2ebdb86d3a8451122bb1e071de70514"><td class="mdescLeft"> </td><td class="mdescRight">Add or update an attribute for a dataset. <br /></td></tr>
|
|
<tr class="separator:ac2ebdb86d3a8451122bb1e071de70514"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a153b545ab178023ae65f7f36135095b6" id="r_a153b545ab178023ae65f7f36135095b6"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a153b545ab178023ae65f7f36135095b6"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a153b545ab178023ae65f7f36135095b6">RemoveDatasetAttribute</a> (const std::string &path, const std::string &attrName)</td></tr>
|
|
<tr class="memdesc:a153b545ab178023ae65f7f36135095b6"><td class="mdescLeft"> </td><td class="mdescRight">Remove an attribute from a dataset. <br /></td></tr>
|
|
<tr class="separator:a153b545ab178023ae65f7f36135095b6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2443c61efdf6daf9b850433938a88b48" id="r_a2443c61efdf6daf9b850433938a88b48"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a2443c61efdf6daf9b850433938a88b48"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a2443c61efdf6daf9b850433938a88b48">AddDataset</a> (const std::string &path, const std::vector< T > &data, const std::vector< uint32_t > &dimensions, const <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> &dataType=<a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440abd073fcbb15020b25a70e2cd95f9f4a9">H4DataType::kINT32</a>)</td></tr>
|
|
<tr class="memdesc:a2443c61efdf6daf9b850433938a88b48"><td class="mdescLeft"> </td><td class="mdescRight">Create and add a new dataset with data, dimensions, and optional attributes. <br /></td></tr>
|
|
<tr class="separator:a2443c61efdf6daf9b850433938a88b48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad776170ddd73dbcebdac2dfed7e5db77" id="r_ad776170ddd73dbcebdac2dfed7e5db77"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:ad776170ddd73dbcebdac2dfed7e5db77"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad776170ddd73dbcebdac2dfed7e5db77">ModifyDataset</a> (const std::string &path, const std::vector< T > &newData, const std::vector< uint32_t > &newDimensions)</td></tr>
|
|
<tr class="memdesc:ad776170ddd73dbcebdac2dfed7e5db77"><td class="mdescLeft"> </td><td class="mdescRight">Modify an existing dataset's data and dimensions. <br /></td></tr>
|
|
<tr class="separator:ad776170ddd73dbcebdac2dfed7e5db77"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5e5e730a6d4430d4bcd0e82c9fcc5d7" id="r_ae5e5e730a6d4430d4bcd0e82c9fcc5d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5e5e730a6d4430d4bcd0e82c9fcc5d7">Dump</a> ()</td></tr>
|
|
<tr class="memdesc:ae5e5e730a6d4430d4bcd0e82c9fcc5d7"><td class="mdescLeft"> </td><td class="mdescRight">Print a human-readable dump of the NeXus file contents. <br /></td></tr>
|
|
<tr class="separator:ae5e5e730a6d4430d4bcd0e82c9fcc5d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae580a0a5420d70ae3f2d81b6998c299" id="r_aae580a0a5420d70ae3f2d81b6998c299"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#aae580a0a5420d70ae3f2d81b6998c299">WriteNexusFile</a> (const std::string &filename, int idfVersion=2)</td></tr>
|
|
<tr class="memdesc:aae580a0a5420d70ae3f2d81b6998c299"><td class="mdescLeft"> </td><td class="mdescRight">Write the data map contents to a NeXus HDF4 file. <br /></td></tr>
|
|
<tr class="separator:aae580a0a5420d70ae3f2d81b6998c299"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a229c46bb1a441bd8bd33468acbba8913" id="r_a229c46bb1a441bd8bd33468acbba8913"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a229c46bb1a441bd8bd33468acbba8913">AddGroupAttribute</a> (const std::string &groupPath, const std::string &attrName, const std::any &attrValue)</td></tr>
|
|
<tr class="memdesc:a229c46bb1a441bd8bd33468acbba8913"><td class="mdescLeft"> </td><td class="mdescRight">Add or update an attribute for a group. <br /></td></tr>
|
|
<tr class="separator:a229c46bb1a441bd8bd33468acbba8913"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a21b7d2cfa5b719e1cce3850885cf1eb4" id="r_a21b7d2cfa5b719e1cce3850885cf1eb4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a21b7d2cfa5b719e1cce3850885cf1eb4">RemoveGroupAttribute</a> (const std::string &groupPath, const std::string &attrName)</td></tr>
|
|
<tr class="memdesc:a21b7d2cfa5b719e1cce3850885cf1eb4"><td class="mdescLeft"> </td><td class="mdescRight">Remove an attribute from a group. <br /></td></tr>
|
|
<tr class="separator:a21b7d2cfa5b719e1cce3850885cf1eb4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7aae8950896110614031bd1118148934" id="r_a7aae8950896110614031bd1118148934"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7aae8950896110614031bd1118148934">HasGroupAttribute</a> (const std::string &groupPath, const std::string &attrName) const</td></tr>
|
|
<tr class="memdesc:a7aae8950896110614031bd1118148934"><td class="mdescLeft"> </td><td class="mdescRight">Check if a group has a specific attribute. <br /></td></tr>
|
|
<tr class="separator:a7aae8950896110614031bd1118148934"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aceaf9383cb9e430c1ff4facb8e2a7065" id="r_aceaf9383cb9e430c1ff4facb8e2a7065"><td class="memItemLeft" align="right" valign="top">std::any </td><td class="memItemRight" valign="bottom"><a class="el" href="#aceaf9383cb9e430c1ff4facb8e2a7065">GetGroupAttribute</a> (const std::string &groupPath, const std::string &attrName) const</td></tr>
|
|
<tr class="memdesc:aceaf9383cb9e430c1ff4facb8e2a7065"><td class="mdescLeft"> </td><td class="mdescRight">Get an attribute value from a group. <br /></td></tr>
|
|
<tr class="separator:aceaf9383cb9e430c1ff4facb8e2a7065"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a362f9cbaaac676fc148dac1a81baa17b" id="r_a362f9cbaaac676fc148dac1a81baa17b"><td class="memItemLeft" align="right" valign="top">const std::map< std::string, std::any > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a362f9cbaaac676fc148dac1a81baa17b">GetGroupAttributes</a> (const std::string &groupPath) const</td></tr>
|
|
<tr class="memdesc:a362f9cbaaac676fc148dac1a81baa17b"><td class="mdescLeft"> </td><td class="mdescRight">Get all attributes for a group. <br /></td></tr>
|
|
<tr class="separator:a362f9cbaaac676fc148dac1a81baa17b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adae0e7b93e9c3c92eab3cce0ca2b29b8" id="r_adae0e7b93e9c3c92eab3cce0ca2b29b8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#adae0e7b93e9c3c92eab3cce0ca2b29b8">ClearGroupAttributes</a> (const std::string &groupPath)</td></tr>
|
|
<tr class="memdesc:adae0e7b93e9c3c92eab3cce0ca2b29b8"><td class="mdescLeft"> </td><td class="mdescRight">Clear all attributes from a group. <br /></td></tr>
|
|
<tr class="separator:adae0e7b93e9c3c92eab3cce0ca2b29b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a014adfc45f392f1ca6a8893281d082a4" id="r_a014adfc45f392f1ca6a8893281d082a4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a014adfc45f392f1ca6a8893281d082a4">AddRootAttribute</a> (const std::string &attrName, const std::any &attrValue)</td></tr>
|
|
<tr class="separator:a014adfc45f392f1ca6a8893281d082a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a899675ab4ec2abd5502ec4e45edd3cac" id="r_a899675ab4ec2abd5502ec4e45edd3cac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a899675ab4ec2abd5502ec4e45edd3cac">HandleIdfV1</a> (int32 sd_id)</td></tr>
|
|
<tr class="memdesc:a899675ab4ec2abd5502ec4e45edd3cac"><td class="mdescLeft"> </td><td class="mdescRight">Read datasets for IDF version 1 file structure. <br /></td></tr>
|
|
<tr class="separator:a899675ab4ec2abd5502ec4e45edd3cac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad6f398c64c8710c1b397418e57226711" id="r_ad6f398c64c8710c1b397418e57226711"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad6f398c64c8710c1b397418e57226711">HandleIdfV2</a> (int32 sd_id)</td></tr>
|
|
<tr class="memdesc:ad6f398c64c8710c1b397418e57226711"><td class="mdescLeft"> </td><td class="mdescRight">Read datasets for IDF version 2 file structure. <br /></td></tr>
|
|
<tr class="separator:ad6f398c64c8710c1b397418e57226711"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ee58c8675b66002071f44fc069a6a8a" id="r_a5ee58c8675b66002071f44fc069a6a8a"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:a5ee58c8675b66002071f44fc069a6a8a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a5ee58c8675b66002071f44fc069a6a8a">WriteDatasetAttributes</a> (int32 sds_id, const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > &data)</td></tr>
|
|
<tr class="memdesc:a5ee58c8675b66002071f44fc069a6a8a"><td class="mdescLeft"> </td><td class="mdescRight">Write dataset attributes from <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object. <br /></td></tr>
|
|
<tr class="separator:a5ee58c8675b66002071f44fc069a6a8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9cd55f6dd26e0558c59a457d2933e680" id="r_a9cd55f6dd26e0558c59a457d2933e680"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9cd55f6dd26e0558c59a457d2933e680">WriteVGroupAttributes</a> (int32 vgroup_id, const std::map< std::string, std::any > &attributes)</td></tr>
|
|
<tr class="memdesc:a9cd55f6dd26e0558c59a457d2933e680"><td class="mdescLeft"> </td><td class="mdescRight">Write attributes to a Vgroup. <br /></td></tr>
|
|
<tr class="separator:a9cd55f6dd26e0558c59a457d2933e680"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf5d4c09a89189339c3a916dab34f859" id="r_abf5d4c09a89189339c3a916dab34f859"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#abf5d4c09a89189339c3a916dab34f859">CreateVGroupHierarchy</a> (int32 file_id, const std::string &path, std::map< std::string, int32 > &vgroupCache)</td></tr>
|
|
<tr class="memdesc:abf5d4c09a89189339c3a916dab34f859"><td class="mdescLeft"> </td><td class="mdescRight">Create the Vgroup hierarchy for a given path. <br /></td></tr>
|
|
<tr class="separator:abf5d4c09a89189339c3a916dab34f859"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad29398abd3ee5f91f98a6ce76f2c6027" id="r_ad29398abd3ee5f91f98a6ce76f2c6027"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad29398abd3ee5f91f98a6ce76f2c6027">WriteIntDataset</a> (int32 sd_id, const std::string &path, const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< int > &data)</td></tr>
|
|
<tr class="memdesc:ad29398abd3ee5f91f98a6ce76f2c6027"><td class="mdescLeft"> </td><td class="mdescRight">Write an integer dataset with attributes and return its SDS reference. <br /></td></tr>
|
|
<tr class="separator:ad29398abd3ee5f91f98a6ce76f2c6027"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af0e299bfeb882bcb88520c6129ddc742" id="r_af0e299bfeb882bcb88520c6129ddc742"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#af0e299bfeb882bcb88520c6129ddc742">WriteFloatDataset</a> (int32 sd_id, const std::string &path, const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< float > &data)</td></tr>
|
|
<tr class="memdesc:af0e299bfeb882bcb88520c6129ddc742"><td class="mdescLeft"> </td><td class="mdescRight">Write a float dataset with attributes and return its SDS reference. <br /></td></tr>
|
|
<tr class="separator:af0e299bfeb882bcb88520c6129ddc742"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1f0c2989c21bda0d7b110c4408e1680c" id="r_a1f0c2989c21bda0d7b110c4408e1680c"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f0c2989c21bda0d7b110c4408e1680c">WriteStringDataset</a> (int32 sd_id, const std::string &path, const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< std::string > &data)</td></tr>
|
|
<tr class="memdesc:a1f0c2989c21bda0d7b110c4408e1680c"><td class="mdescLeft"> </td><td class="mdescRight">Write a string dataset with attributes and return its SDS reference. <br /></td></tr>
|
|
<tr class="separator:a1f0c2989c21bda0d7b110c4408e1680c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfeb069060dc065959ab106206fb054b" id="r_adfeb069060dc065959ab106206fb054b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#adfeb069060dc065959ab106206fb054b">WriteFileAttributes</a> (int32 sd_id)</td></tr>
|
|
<tr class="memdesc:adfeb069060dc065959ab106206fb054b"><td class="mdescLeft"> </td><td class="mdescRight">Write root-level file attributes. <br /></td></tr>
|
|
<tr class="separator:adfeb069060dc065959ab106206fb054b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acea18a1eaefc9568bd89ca21cbd29c0d" id="r_acea18a1eaefc9568bd89ca21cbd29c0d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#acea18a1eaefc9568bd89ca21cbd29c0d">FindAttributeName</a> (int32 sd_id, const std::string &requestedName)</td></tr>
|
|
<tr class="separator:acea18a1eaefc9568bd89ca21cbd29c0d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22f38c6ca95838ec3354c66171a0e165" id="r_a22f38c6ca95838ec3354c66171a0e165"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a22f38c6ca95838ec3354c66171a0e165">FindDatasetIndex</a> (int32 sd_id, const std::string &requestedName)</td></tr>
|
|
<tr class="memdesc:a22f38c6ca95838ec3354c66171a0e165"><td class="mdescLeft"> </td><td class="mdescRight">Find dataset index with case-insensitive matching. <br /></td></tr>
|
|
<tr class="separator:a22f38c6ca95838ec3354c66171a0e165"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a962c94be3b3130e96b1a453c71cc3528" id="r_a962c94be3b3130e96b1a453c71cc3528"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a962c94be3b3130e96b1a453c71cc3528">FindDatasetRefByPath</a> (const std::string &path)</td></tr>
|
|
<tr class="memdesc:a962c94be3b3130e96b1a453c71cc3528"><td class="mdescLeft"> </td><td class="mdescRight">Find dataset reference by navigating VGroup hierarchy. <br /></td></tr>
|
|
<tr class="separator:a962c94be3b3130e96b1a453c71cc3528"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac92d6bdf4a7ea49cab7f5ce64f04137b" id="r_ac92d6bdf4a7ea49cab7f5ce64f04137b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac92d6bdf4a7ea49cab7f5ce64f04137b">ReadIntDataset</a> (int32 sd_id, const std::string &path)</td></tr>
|
|
<tr class="memdesc:ac92d6bdf4a7ea49cab7f5ce64f04137b"><td class="mdescLeft"> </td><td class="mdescRight">Read an integer dataset and store in data map. <br /></td></tr>
|
|
<tr class="separator:ac92d6bdf4a7ea49cab7f5ce64f04137b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae1eae877b26efbaa4407e8ab57d7f7ec" id="r_ae1eae877b26efbaa4407e8ab57d7f7ec"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae1eae877b26efbaa4407e8ab57d7f7ec">ReadFloatDataset</a> (int32 sd_id, const std::string &path)</td></tr>
|
|
<tr class="memdesc:ae1eae877b26efbaa4407e8ab57d7f7ec"><td class="mdescLeft"> </td><td class="mdescRight">Read a float dataset and store in data map. <br /></td></tr>
|
|
<tr class="separator:ae1eae877b26efbaa4407e8ab57d7f7ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa69c5ed8dfee62492121ab4617e0caaa" id="r_aa69c5ed8dfee62492121ab4617e0caaa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa69c5ed8dfee62492121ab4617e0caaa">ReadStringDataset</a> (int32 sd_id, const std::string &path)</td></tr>
|
|
<tr class="memdesc:aa69c5ed8dfee62492121ab4617e0caaa"><td class="mdescLeft"> </td><td class="mdescRight">Read a string dataset and store in data map. <br /></td></tr>
|
|
<tr class="separator:aa69c5ed8dfee62492121ab4617e0caaa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3ba750f17a59756d181d87ce3125b8a" id="r_af3ba750f17a59756d181d87ce3125b8a"><td class="memTemplParams" colspan="2">template<typename T> </td></tr>
|
|
<tr class="memitem:af3ba750f17a59756d181d87ce3125b8a"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af3ba750f17a59756d181d87ce3125b8a">ReadDatasetAttributes</a> (int32 sds_id, <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > &data)</td></tr>
|
|
<tr class="memdesc:af3ba750f17a59756d181d87ce3125b8a"><td class="mdescLeft"> </td><td class="mdescRight">Read dataset attributes and add to <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object. <br /></td></tr>
|
|
<tr class="separator:af3ba750f17a59756d181d87ce3125b8a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-static-methods" name="pri-static-methods"></a>
|
|
Static Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:a7b6f49a99195e5f9586fc03a393fdab0" id="r_a7b6f49a99195e5f9586fc03a393fdab0"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7b6f49a99195e5f9586fc03a393fdab0">CaseInsensitiveEquals</a> (const std::string &a, const std::string &b)</td></tr>
|
|
<tr class="memdesc:a7b6f49a99195e5f9586fc03a393fdab0"><td class="mdescLeft"> </td><td class="mdescRight">Compare two strings case-insensitively. <br /></td></tr>
|
|
<tr class="separator:a7b6f49a99195e5f9586fc03a393fdab0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adac8a51e080f971ca3c69be9629bc676" id="r_adac8a51e080f971ca3c69be9629bc676"><td class="memItemLeft" align="right" valign="top">static std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="#adac8a51e080f971ca3c69be9629bc676">SplitPath</a> (const std::string &path)</td></tr>
|
|
<tr class="separator:adac8a51e080f971ca3c69be9629bc676"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55e437f5a8b2156c62b22b6aa2bcdc22" id="r_a55e437f5a8b2156c62b22b6aa2bcdc22"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a55e437f5a8b2156c62b22b6aa2bcdc22">convertHdf4Type</a> (int32 hdf4_type)</td></tr>
|
|
<tr class="memdesc:a55e437f5a8b2156c62b22b6aa2bcdc22"><td class="mdescLeft"> </td><td class="mdescRight">Convert HDF4 data type to <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum. <br /></td></tr>
|
|
<tr class="separator:a55e437f5a8b2156c62b22b6aa2bcdc22"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac51cb70819eb4c2ae191f50b51f13de2" id="r_ac51cb70819eb4c2ae191f50b51f13de2"><td class="memItemLeft" align="right" valign="top">static int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac51cb70819eb4c2ae191f50b51f13de2">convertToHdf4Type</a> (<a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> dataType)</td></tr>
|
|
<tr class="memdesc:ac51cb70819eb4c2ae191f50b51f13de2"><td class="mdescLeft"> </td><td class="mdescRight">Convert <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum to HDF4 data type. <br /></td></tr>
|
|
<tr class="separator:ac51cb70819eb4c2ae191f50b51f13de2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:ab75b54fd1c874fda6a801def963ce579" id="r_ab75b54fd1c874fda6a801def963ce579"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab75b54fd1c874fda6a801def963ce579">fPrintDebug</a> {false}</td></tr>
|
|
<tr class="memdesc:ab75b54fd1c874fda6a801def963ce579"><td class="mdescLeft"> </td><td class="mdescRight">if true print additional debug information <br /></td></tr>
|
|
<tr class="separator:ab75b54fd1c874fda6a801def963ce579"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78a20378bac4a197bcfd446e62d665c2" id="r_a78a20378bac4a197bcfd446e62d665c2"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a78a20378bac4a197bcfd446e62d665c2">fFileName</a> {""}</td></tr>
|
|
<tr class="memdesc:a78a20378bac4a197bcfd446e62d665c2"><td class="mdescLeft"> </td><td class="mdescRight">NeXus HDF4 filename. <br /></td></tr>
|
|
<tr class="separator:a78a20378bac4a197bcfd446e62d665c2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af6a0650206c385f71564b3842e46e55f" id="r_af6a0650206c385f71564b3842e46e55f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#af6a0650206c385f71564b3842e46e55f">fIdfVersion</a> {-1}</td></tr>
|
|
<tr class="memdesc:af6a0650206c385f71564b3842e46e55f"><td class="mdescLeft"> </td><td class="mdescRight">IDF version of the NeXus file. <br /></td></tr>
|
|
<tr class="separator:af6a0650206c385f71564b3842e46e55f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e8566b9a15b27b83b8227e58ef91d34" id="r_a1e8566b9a15b27b83b8227e58ef91d34"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a1e8566b9a15b27b83b8227e58ef91d34">fHdf4LibVersion</a> {""}</td></tr>
|
|
<tr class="memdesc:a1e8566b9a15b27b83b8227e58ef91d34"><td class="mdescLeft"> </td><td class="mdescRight">HDF4 library version used when calling <a class="el" href="classnxH4_1_1PNeXus.html" title="NeXus HDF4 file reader with case-insensitive path lookup.">PNeXus</a>. <br /></td></tr>
|
|
<tr class="separator:a1e8566b9a15b27b83b8227e58ef91d34"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f257613c664bff6011bce594d254e1d" id="r_a9f257613c664bff6011bce594d254e1d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9f257613c664bff6011bce594d254e1d">fHdf4Version</a> {""}</td></tr>
|
|
<tr class="memdesc:a9f257613c664bff6011bce594d254e1d"><td class="mdescLeft"> </td><td class="mdescRight">HDF4 version of the file. <br /></td></tr>
|
|
<tr class="separator:a9f257613c664bff6011bce594d254e1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8885d1b1c24a4ed336824dfe67cc602d" id="r_a8885d1b1c24a4ed336824dfe67cc602d"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8885d1b1c24a4ed336824dfe67cc602d">fNeXusVersion</a> {""}</td></tr>
|
|
<tr class="memdesc:a8885d1b1c24a4ed336824dfe67cc602d"><td class="mdescLeft"> </td><td class="mdescRight">NeXus version of the file. <br /></td></tr>
|
|
<tr class="separator:a8885d1b1c24a4ed336824dfe67cc602d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a497e85c6a0687b0c93a4f658b0587573" id="r_a497e85c6a0687b0c93a4f658b0587573"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a497e85c6a0687b0c93a4f658b0587573">fFileNameNxs</a> {""}</td></tr>
|
|
<tr class="separator:a497e85c6a0687b0c93a4f658b0587573"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a288f37e927d61360a85abb847f8a7a60" id="r_a288f37e927d61360a85abb847f8a7a60"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a288f37e927d61360a85abb847f8a7a60">fFileTimeNxs</a> {""}</td></tr>
|
|
<tr class="separator:a288f37e927d61360a85abb847f8a7a60"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a66765c63c1c68222452a2e7cad4817f4" id="r_a66765c63c1c68222452a2e7cad4817f4"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a66765c63c1c68222452a2e7cad4817f4">fCreatorNxs</a> {""}</td></tr>
|
|
<tr class="separator:a66765c63c1c68222452a2e7cad4817f4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a987c8df40a432eb79b57804b15ab28d0" id="r_a987c8df40a432eb79b57804b15ab28d0"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="#a987c8df40a432eb79b57804b15ab28d0">fUserV1</a> {""}</td></tr>
|
|
<tr class="separator:a987c8df40a432eb79b57804b15ab28d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7c087cc1e5d3d14d6c1a2468a7c75dff" id="r_a7c087cc1e5d3d14d6c1a2468a7c75dff"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c087cc1e5d3d14d6c1a2468a7c75dff">fSdId</a> {-1}</td></tr>
|
|
<tr class="memdesc:a7c087cc1e5d3d14d6c1a2468a7c75dff"><td class="mdescLeft"> </td><td class="mdescRight">HDF4 SD interface identifier. <br /></td></tr>
|
|
<tr class="separator:a7c087cc1e5d3d14d6c1a2468a7c75dff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af689199af65372f17713b67fae7edf24" id="r_af689199af65372f17713b67fae7edf24"><td class="memItemLeft" align="right" valign="top">int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="#af689199af65372f17713b67fae7edf24">fFileId</a> {-1}</td></tr>
|
|
<tr class="memdesc:af689199af65372f17713b67fae7edf24"><td class="mdescLeft"> </td><td class="mdescRight">HDF4 file identifier. <br /></td></tr>
|
|
<tr class="separator:af689199af65372f17713b67fae7edf24"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa99fbf33f3d593ae4568ff61b4b5e7a6" id="r_aa99fbf33f3d593ae4568ff61b4b5e7a6"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::any > </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa99fbf33f3d593ae4568ff61b4b5e7a6">fDataMap</a></td></tr>
|
|
<tr class="memdesc:aa99fbf33f3d593ae4568ff61b4b5e7a6"><td class="mdescLeft"> </td><td class="mdescRight">Map of HDF4 paths to <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> objects. <br /></td></tr>
|
|
<tr class="separator:aa99fbf33f3d593ae4568ff61b4b5e7a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d86f1c94a34619a20de7286b9abaeee" id="r_a8d86f1c94a34619a20de7286b9abaeee"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::map< std::string, std::any > > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d86f1c94a34619a20de7286b9abaeee">fGroupAttributes</a></td></tr>
|
|
<tr class="memdesc:a8d86f1c94a34619a20de7286b9abaeee"><td class="mdescLeft"> </td><td class="mdescRight">Map of group paths to their attributes. <br /></td></tr>
|
|
<tr class="separator:a8d86f1c94a34619a20de7286b9abaeee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>NeXus HDF4 file reader with case-insensitive path lookup. </p>
|
|
<p>The <a class="el" href="classnxH4_1_1PNeXus.html" title="NeXus HDF4 file reader with case-insensitive path lookup.">PNeXus</a> class provides functionality for reading ISIS muon NeXus HDF4 files using the HDF4 C API. It implements case-insensitive path lookup for datasets, groups, and attributes to handle files with varying path casings.</p>
|
|
<p>Key features:</p><ul>
|
|
<li>Automatic file reading upon construction</li>
|
|
<li>Case-insensitive path resolution for datasets and groups</li>
|
|
<li>Case-insensitive attribute name matching</li>
|
|
<li>Comprehensive exception handling </li>
|
|
</ul>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#_a3">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#_a29">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00517">517</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2a9409badd40cdce963415dfd5c9d8c1" name="a2a9409badd40cdce963415dfd5c9d8c1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a9409badd40cdce963415dfd5c9d8c1">◆ </a></span>PNeXus() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">nxH4::PNeXus::PNeXus </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a6">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a30">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00329">329</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00899">fFileId</a>, <a class="el" href="PNeXus_8h_source.html#l00891">fHdf4LibVersion</a>, and <a class="el" href="PNeXus_8h_source.html#l00898">fSdId</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a54230158491746101e47db27f7a49bfb" name="a54230158491746101e47db27f7a49bfb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54230158491746101e47db27f7a49bfb">◆ </a></span>PNeXus() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">nxH4::PNeXus::PNeXus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string</td> <td class="paramname"><span class="paramname"><em>fln</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>printDebug</em></span><span class="paramdefsep"> = </span><span class="paramdefval">false</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor - creates <a class="el" href="classnxH4_1_1PNeXus.html" title="NeXus HDF4 file reader with case-insensitive path lookup.">PNeXus</a> object and reads the NeXus file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fln</td><td>Filename of the NeXus HDF4 file to read </td></tr>
|
|
<tr><td class="paramname">printDebug</td><td>Enable debug output </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if file cannot be opened or read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00340">340</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00899">fFileId</a>, <a class="el" href="PNeXus_8h_source.html#l00889">fFileName</a>, <a class="el" href="PNeXus_8h_source.html#l00891">fHdf4LibVersion</a>, <a class="el" href="PNeXus_8h_source.html#l00888">fPrintDebug</a>, <a class="el" href="PNeXus_8h_source.html#l00898">fSdId</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a37a962cb30c0c212885967d904039eed" name="a37a962cb30c0c212885967d904039eed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a37a962cb30c0c212885967d904039eed">◆ </a></span>~PNeXus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">nxH4::PNeXus::~PNeXus </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Destructor - closes HDF4 file if open. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a7">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a31">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00356">356</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00899">fFileId</a>, and <a class="el" href="PNeXus_8h_source.html#l00898">fSdId</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a2443c61efdf6daf9b850433938a88b48" name="a2443c61efdf6daf9b850433938a88b48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2443c61efdf6daf9b850433938a88b48">◆ </a></span>AddDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::AddDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< T > &</td> <td class="paramname"><span class="paramname"><em>data</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint32_t > &</td> <td class="paramname"><span class="paramname"><em>dimensions</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> &</td> <td class="paramname"><span class="paramname"><em>dataType</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440abd073fcbb15020b25a70e2cd95f9f4a9">H4DataType::kINT32</a></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create and add a new dataset with data, dimensions, and optional attributes. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path for the new dataset </td></tr>
|
|
<tr><td class="paramname">data</td><td>Data vector </td></tr>
|
|
<tr><td class="paramname">dimensions</td><td>Dimensions vector </td></tr>
|
|
<tr><td class="paramname">dataType</td><td>HDF4 DataType (optional, uses default if not provided) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if dataset was created, false if path already exists </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a50">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00759">759</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00330">nxH4::kINT32</a>, <a class="el" href="PNeXus_8h_source.html#l00411">nxH4::PNXdata< T >::SetData()</a>, and <a class="el" href="PNeXus_8h_source.html#l00423">nxH4::PNXdata< T >::SetDimensions()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2ebdb86d3a8451122bb1e071de70514" name="ac2ebdb86d3a8451122bb1e071de70514"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2ebdb86d3a8451122bb1e071de70514">◆ </a></span>AddDatasetAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::AddDatasetAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::any &</td> <td class="paramname"><span class="paramname"><em>attrValue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add or update an attribute for a dataset. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
<tr><td class="paramname">attrName</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramname">attrValue</td><td>Attribute value (stored as std::any) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if attribute was added, false if dataset doesn't exist </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a48">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00713">713</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, and <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a229c46bb1a441bd8bd33468acbba8913" name="a229c46bb1a441bd8bd33468acbba8913"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a229c46bb1a441bd8bd33468acbba8913">◆ </a></span>AddGroupAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::AddGroupAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>groupPath</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::any &</td> <td class="paramname"><span class="paramname"><em>attrValue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add or update an attribute for a group. </p>
|
|
<p>Stores an attribute value in the internal group attributes map. These attributes will be written when <a class="el" href="#aae580a0a5420d70ae3f2d81b6998c299" title="Write the data map contents to a NeXus HDF4 file.">WriteNexusFile()</a> is called. The root group "/" can be used for file-level attributes.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">groupPath</td><td>HDF4 path of the group (e.g., "/raw_data_1") </td></tr>
|
|
<tr><td class="paramname">attrName</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramname">attrValue</td><td>Attribute value (stored as std::any) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if attribute was added successfully </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a25">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a54">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02449">2449</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02508">AddRootAttribute()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a014adfc45f392f1ca6a8893281d082a4" name="a014adfc45f392f1ca6a8893281d082a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a014adfc45f392f1ca6a8893281d082a4">◆ </a></span>AddRootAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::AddRootAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::any &</td> <td class="paramname"><span class="paramname"><em>attrValue</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a31">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a60">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02508">2508</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8cpp_source.html#l02449">AddGroupAttribute()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7b6f49a99195e5f9586fc03a393fdab0" name="a7b6f49a99195e5f9586fc03a393fdab0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7b6f49a99195e5f9586fc03a393fdab0">◆ </a></span>CaseInsensitiveEquals()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::CaseInsensitiveEquals </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>a</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>b</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compare two strings case-insensitively. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">a</td><td>First string to compare </td></tr>
|
|
<tr><td class="paramname">b</td><td>Second string to compare </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if strings are equal (ignoring case), false otherwise </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Uses std::tolower for character-by-character comparison </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a32">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a70">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02516">2516</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02551">FindAttributeName()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02572">FindDatasetIndex()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3731e1b79076ae956236770c8e43c2d" name="ae3731e1b79076ae956236770c8e43c2d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3731e1b79076ae956236770c8e43c2d">◆ </a></span>ClearDataMap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::ClearDataMap </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear all datasets from the data map. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a44">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00658">658</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adae0e7b93e9c3c92eab3cce0ca2b29b8" name="adae0e7b93e9c3c92eab3cce0ca2b29b8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adae0e7b93e9c3c92eab3cce0ca2b29b8">◆ </a></span>ClearGroupAttributes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::ClearGroupAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>groupPath</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Clear all attributes from a group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">groupPath</td><td>HDF4 path of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if group was found and attributes cleared, false otherwise </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a30">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a59">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02498">2498</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55e437f5a8b2156c62b22b6aa2bcdc22" name="a55e437f5a8b2156c62b22b6aa2bcdc22"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55e437f5a8b2156c62b22b6aa2bcdc22">◆ </a></span>convertHdf4Type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">nxH4::H4DataType</a> nxH4::PNeXus::convertHdf4Type </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>hdf4_type</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert HDF4 data type to <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum. </p>
|
|
<p>Convert HDF4 numeric type constant to <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hdf4_type</td><td>HDF4 numeric type constant (DFNT_*) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum value</dd></dl>
|
|
<p>Maps HDF4 DFNT_* type constants to the library's <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum for type-safe handling of dataset types.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">hdf4_type</td><td>HDF4 numeric type constant (e.g., DFNT_INT32) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Corresponding <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum value</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Unknown types default to H4DataType::INT32 </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a38">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a79">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02744">2744</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00333">nxH4::kCHAR8</a>, <a class="el" href="PNeXus_8h_source.html#l00331">nxH4::kFLOAT32</a>, <a class="el" href="PNeXus_8h_source.html#l00332">nxH4::kFLOAT64</a>, <a class="el" href="PNeXus_8h_source.html#l00335">nxH4::kINT16</a>, <a class="el" href="PNeXus_8h_source.html#l00330">nxH4::kINT32</a>, <a class="el" href="PNeXus_8h_source.html#l00337">nxH4::kINT8</a>, <a class="el" href="PNeXus_8h_source.html#l00336">nxH4::kUINT16</a>, <a class="el" href="PNeXus_8h_source.html#l00334">nxH4::kUINT32</a>, and <a class="el" href="PNeXus_8h_source.html#l00338">nxH4::kUINT8</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac51cb70819eb4c2ae191f50b51f13de2" name="ac51cb70819eb4c2ae191f50b51f13de2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac51cb70819eb4c2ae191f50b51f13de2">◆ </a></span>convertToHdf4Type()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::convertToHdf4Type </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a></td> <td class="paramname"><span class="paramname"><em>dataType</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum to HDF4 data type. </p>
|
|
<p>Convert <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum to HDF4 numeric type constant.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataType</td><td><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>HDF4 numeric type constant (DFNT_*)</dd></dl>
|
|
<p>Maps the library's <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum to HDF4 DFNT_* type constants for writing datasets to HDF4 files.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataType</td><td><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440" title="HDF4 data type enumeration.">H4DataType</a> enum value </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Corresponding HDF4 numeric type constant (e.g., DFNT_INT32)</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Unknown types default to DFNT_INT32 </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a39">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a80">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02771">2771</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00333">nxH4::kCHAR8</a>, <a class="el" href="PNeXus_8h_source.html#l00331">nxH4::kFLOAT32</a>, <a class="el" href="PNeXus_8h_source.html#l00332">nxH4::kFLOAT64</a>, <a class="el" href="PNeXus_8h_source.html#l00335">nxH4::kINT16</a>, <a class="el" href="PNeXus_8h_source.html#l00330">nxH4::kINT32</a>, <a class="el" href="PNeXus_8h_source.html#l00337">nxH4::kINT8</a>, <a class="el" href="PNeXus_8h_source.html#l00336">nxH4::kUINT16</a>, <a class="el" href="PNeXus_8h_source.html#l00334">nxH4::kUINT32</a>, and <a class="el" href="PNeXus_8h_source.html#l00338">nxH4::kUINT8</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf5d4c09a89189339c3a916dab34f859" name="abf5d4c09a89189339c3a916dab34f859"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf5d4c09a89189339c3a916dab34f859">◆ </a></span>CreateVGroupHierarchy()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::CreateVGroupHierarchy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>file_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::map< std::string, int32 > &</td> <td class="paramname"><span class="paramname"><em>vgroupCache</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Create the Vgroup hierarchy for a given path. </p>
|
|
<p>Given a path like "/run/sample", creates Vgroups "run" and "sample" (nested), writing any associated group attributes from fGroupAttributes. Uses a cache to avoid creating duplicate Vgroups.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">file_id</td><td>HDF4 file ID (from Hopen) </td></tr>
|
|
<tr><td class="paramname">path</td><td>The group path to create (e.g., "/run/sample") </td></tr>
|
|
<tr><td class="paramname">vgroupCache</td><td>Map of already-created group paths to their Vgroup references </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The Vgroup reference of the deepest group in the path </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a24">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a65">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02365">2365</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>, <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02316">WriteVGroupAttributes()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l01972">WriteNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5e5e730a6d4430d4bcd0e82c9fcc5d7" name="ae5e5e730a6d4430d4bcd0e82c9fcc5d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5e5e730a6d4430d4bcd0e82c9fcc5d7">◆ </a></span>Dump()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::Dump </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Print a human-readable dump of the NeXus file contents. </p>
|
|
<p>Outputs the contents of the loaded NeXus file to stdout in a hierarchical format. The output includes:</p><ul>
|
|
<li>File metadata (HDF4 version, NeXus version, file name, file time)</li>
|
|
<li>IDF version</li>
|
|
<li>Run information (run number, title, start/stop time)</li>
|
|
<li>Sample information (name, temperature, magnetic field)</li>
|
|
<li>Instrument information</li>
|
|
<li>Detector counts with dimensions and first few values</li>
|
|
</ul>
|
|
<p>The output format differs based on IDF version (1 or 2).</p>
|
|
<dl class="section note"><dt>Note</dt><dd>This method is primarily useful for debugging and verification </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a16">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a52">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00981">981</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, <a class="el" href="PNeXus_8h_source.html#l00889">fFileName</a>, <a class="el" href="PNeXus_8h_source.html#l00894">fFileNameNxs</a>, <a class="el" href="PNeXus_8h_source.html#l00895">fFileTimeNxs</a>, <a class="el" href="PNeXus_8h_source.html#l00892">fHdf4Version</a>, <a class="el" href="PNeXus_8h_source.html#l00890">fIdfVersion</a>, and <a class="el" href="PNeXus_8h_source.html#l00893">fNeXusVersion</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acea18a1eaefc9568bd89ca21cbd29c0d" name="acea18a1eaefc9568bd89ca21cbd29c0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acea18a1eaefc9568bd89ca21cbd29c0d">◆ </a></span>FindAttributeName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::FindAttributeName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>requestedName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a34">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a72">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02551">2551</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8cpp_source.html#l02516">CaseInsensitiveEquals()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a22f38c6ca95838ec3354c66171a0e165" name="a22f38c6ca95838ec3354c66171a0e165"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a22f38c6ca95838ec3354c66171a0e165">◆ </a></span>FindDatasetIndex()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::FindDatasetIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>requestedName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find dataset index with case-insensitive matching. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">requestedName</td><td>Requested dataset name (any case) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Dataset index </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if dataset not found </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a35">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a73">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02572">2572</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8cpp_source.html#l02516">CaseInsensitiveEquals()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a962c94be3b3130e96b1a453c71cc3528" name="a962c94be3b3130e96b1a453c71cc3528"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a962c94be3b3130e96b1a453c71cc3528">◆ </a></span>FindDatasetRefByPath()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::FindDatasetRefByPath </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Find dataset reference by navigating VGroup hierarchy. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>Full hierarchical path (e.g., "/run/sample/name") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Dataset reference number, or -1 if not found </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Uses VGroup navigation to resolve paths in HDF4 files with duplicate dataset names </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a36">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a74">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02604">2604</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8cpp_source.html#l02516">CaseInsensitiveEquals()</a>, <a class="el" href="PNeXus_8h_source.html#l00899">fFileId</a>, <a class="el" href="PNeXus_8h_source.html#l00898">fSdId</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa7e014110eb63606ff4c27fe8f62966" name="aaa7e014110eb63606ff4c27fe8f62966"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa7e014110eb63606ff4c27fe8f62966">◆ </a></span>GetDataMap() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::map< std::string, std::any > & nxH4::PNeXus::GetDataMap </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get mutable reference to the data map. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the data map </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00595">595</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8e5b2001ca5b18963788ba6b0204c94f" name="a8e5b2001ca5b18963788ba6b0204c94f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8e5b2001ca5b18963788ba6b0204c94f">◆ </a></span>GetDataMap() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::map< std::string, std::any > & nxH4::PNeXus::GetDataMap </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the data map containing all datasets. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the data map (path -> <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> stored in std::any) </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a38">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00589">589</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9cdf7128ac1253415c828e5a8fb2cc10" name="a9cdf7128ac1253415c828e5a8fb2cc10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9cdf7128ac1253415c828e5a8fb2cc10">◆ </a></span>GetDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > nxH4::PNeXus::GetDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a dataset from the data map. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::out_of_range</td><td>if path doesn't exist </td></tr>
|
|
<tr><td class="paramname">std::bad_any_cast</td><td>if type T doesn't match stored type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a41">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00624">624</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7ad9ea24cc9362dba2898611aa8ec0d" name="ae7ad9ea24cc9362dba2898611aa8ec0d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7ad9ea24cc9362dba2898611aa8ec0d">◆ </a></span>GetDatasetRef()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > & nxH4::PNeXus::GetDatasetRef </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a mutable reference to a dataset in the data map. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::out_of_range</td><td>if path doesn't exist </td></tr>
|
|
<tr><td class="paramname">std::bad_any_cast</td><td>if type T doesn't match stored type </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a42">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00637">637</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6419e3845dce51ae07f8c168ddcc92f" name="af6419e3845dce51ae07f8c168ddcc92f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6419e3845dce51ae07f8c168ddcc92f">◆ </a></span>GetFileName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::GetFileName </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the filename of the NeXus file. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The filename as a string </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a32">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00552">552</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00889">fFileName</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aceaf9383cb9e430c1ff4facb8e2a7065" name="aceaf9383cb9e430c1ff4facb8e2a7065"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aceaf9383cb9e430c1ff4facb8e2a7065">◆ </a></span>GetGroupAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::any nxH4::PNeXus::GetGroupAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>groupPath</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get an attribute value from a group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">groupPath</td><td>HDF4 path of the group </td></tr>
|
|
<tr><td class="paramname">attrName</td><td>Attribute name </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The attribute value as std::any </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::out_of_range</td><td>if group or attribute doesn't exist </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a28">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a57">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02481">2481</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a362f9cbaaac676fc148dac1a81baa17b" name="a362f9cbaaac676fc148dac1a81baa17b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a362f9cbaaac676fc148dac1a81baa17b">◆ </a></span>GetGroupAttributes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">const std::map< std::string, std::any > & nxH4::PNeXus::GetGroupAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>groupPath</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get all attributes for a group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">groupPath</td><td>HDF4 path of the group </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Map of attribute names to values </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a29">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a58">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02487">2487</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a96ae432999542d03ad9a0bfeede9a2f2" name="a96ae432999542d03ad9a0bfeede9a2f2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a96ae432999542d03ad9a0bfeede9a2f2">◆ </a></span>GetHdf4LibVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::GetHdf4LibVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the hdf4 library version. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The hdf4 version as a string </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a33">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00558">558</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00891">fHdf4LibVersion</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7977631b7cf9b813818d5c10573423a3" name="a7977631b7cf9b813818d5c10573423a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7977631b7cf9b813818d5c10573423a3">◆ </a></span>GetHdf4Version()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::GetHdf4Version </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the hdf4 version of the NeXus file. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The hdf4 version as a string </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a34">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00564">564</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00892">fHdf4Version</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac4738d545822b62db7793b632c9dd7df" name="ac4738d545822b62db7793b632c9dd7df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4738d545822b62db7793b632c9dd7df">◆ </a></span>GetIdfVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int nxH4::PNeXus::GetIdfVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the Idf version of the file. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The Idf version tag </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a36">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00576">576</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00890">fIdfVersion</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9a066b8802ad8694eb6410afe12bec20" name="a9a066b8802ad8694eb6410afe12bec20"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9a066b8802ad8694eb6410afe12bec20">◆ </a></span>GetNeXusVersion()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::GetNeXusVersion </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the NeXus version of the file. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The NeXus version as a string </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a35">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00570">570</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00893">fNeXusVersion</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae7d8e8017efb8fc724455a0508931119" name="ae7d8e8017efb8fc724455a0508931119"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7d8e8017efb8fc724455a0508931119">◆ </a></span>GetNumDatasets()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t nxH4::PNeXus::GetNumDatasets </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the number of datasets in the data map. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of datasets stored </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a45">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00664">664</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a899675ab4ec2abd5502ec4e45edd3cac" name="a899675ab4ec2abd5502ec4e45edd3cac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a899675ab4ec2abd5502ec4e45edd3cac">◆ </a></span>HandleIdfV1()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::HandleIdfV1 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read datasets for IDF version 1 file structure. </p>
|
|
<p>Reads datasets specific to the IDF version 1 NeXus format, which uses a "/run/" group hierarchy. Datasets are organized under paths like:</p><ul>
|
|
<li>/run/IDF_version, /run/number, /run/title</li>
|
|
<li>/run/sample/temperature, /run/sample/magnetic_field</li>
|
|
<li>/run/histogram_data_1/counts, /run/histogram_data_1/raw_time</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>IDF v1 is an older format primarily used by ISIS facilities </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a9">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a61">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00544">544</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00888">fPrintDebug</a>, <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad6f398c64c8710c1b397418e57226711" name="ad6f398c64c8710c1b397418e57226711"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad6f398c64c8710c1b397418e57226711">◆ </a></span>HandleIdfV2()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::HandleIdfV2 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read datasets for IDF version 2 file structure. </p>
|
|
<p>Reads datasets specific to the IDF version 2 NeXus format, which uses a "/raw_data_1/" group hierarchy. Datasets are organized under paths like:</p><ul>
|
|
<li>/raw_data_1/IDF_version, /raw_data_1/run_number, /raw_data_1/title</li>
|
|
<li>/raw_data_1/instrument/detector_1/counts</li>
|
|
<li>/raw_data_1/instrument/detector_1/resolution</li>
|
|
</ul>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>IDF v2 is the current standard format for ISIS muon NeXus files </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a10">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a62">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00628">628</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00888">fPrintDebug</a>, <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acc0c9109803a9c75a3e2ecda11145d21" name="acc0c9109803a9c75a3e2ecda11145d21"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc0c9109803a9c75a3e2ecda11145d21">◆ </a></span>HasDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::HasDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if a dataset path exists in the data map. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if path exists, false otherwise </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a39">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00602">602</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8h_source.html#l00759">AddDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00713">AddDatasetAttribute()</a>, <a class="el" href="PNeXus_8h_source.html#l00779">ModifyDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00733">RemoveDatasetAttribute()</a>, <a class="el" href="PNeXus_8h_source.html#l00674">UpdateDatasetData()</a>, and <a class="el" href="PNeXus_8h_source.html#l00693">UpdateDatasetDimensions()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7aae8950896110614031bd1118148934" name="a7aae8950896110614031bd1118148934"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7aae8950896110614031bd1118148934">◆ </a></span>HasGroupAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::HasGroupAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>groupPath</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span> ) const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Check if a group has a specific attribute. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">groupPath</td><td>HDF4 path of the group </td></tr>
|
|
<tr><td class="paramname">attrName</td><td>Attribute name to check </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if attribute exists, false otherwise </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a27">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a56">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02471">2471</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad776170ddd73dbcebdac2dfed7e5db77" name="ad776170ddd73dbcebdac2dfed7e5db77"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad776170ddd73dbcebdac2dfed7e5db77">◆ </a></span>ModifyDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::ModifyDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< T > &</td> <td class="paramname"><span class="paramname"><em>newData</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint32_t > &</td> <td class="paramname"><span class="paramname"><em>newDimensions</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Modify an existing dataset's data and dimensions. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
<tr><td class="paramname">newData</td><td>New data vector </td></tr>
|
|
<tr><td class="paramname">newDimensions</td><td>New dimensions vector </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if modification succeeded, false if path doesn't exist </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a51">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00779">779</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, and <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af3ba750f17a59756d181d87ce3125b8a" name="af3ba750f17a59756d181d87ce3125b8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af3ba750f17a59756d181d87ce3125b8a">◆ </a></span>ReadDatasetAttributes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::ReadDatasetAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sds_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > &</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read dataset attributes and add to <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sds_id</td><td>HDF4 dataset ID </td></tr>
|
|
<tr><td class="paramname">data</td><td><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object to add attributes to </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a15">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a78">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00920">920</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00449">nxH4::PNXdata< T >::AddAttribute()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae1eae877b26efbaa4407e8ab57d7f7ec" name="ae1eae877b26efbaa4407e8ab57d7f7ec"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae1eae877b26efbaa4407e8ab57d7f7ec">◆ </a></span>ReadFloatDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::ReadFloatDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a float dataset and store in data map. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">path</td><td>Path to the dataset </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if reading fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a13">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a76">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00766">766</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, <a class="el" href="PNeXus_8cpp_source.html#l02572">FindDatasetIndex()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8h_source.html#l00331">nxH4::kFLOAT32</a>, <a class="el" href="PNeXus_8cpp_source.html#l00920">ReadDatasetAttributes()</a>, <a class="el" href="PNeXus_8h_source.html#l00411">nxH4::PNXdata< T >::SetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00423">nxH4::PNXdata< T >::SetDimensions()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00544">HandleIdfV1()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00628">HandleIdfV2()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac92d6bdf4a7ea49cab7f5ce64f04137b" name="ac92d6bdf4a7ea49cab7f5ce64f04137b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac92d6bdf4a7ea49cab7f5ce64f04137b">◆ </a></span>ReadIntDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::ReadIntDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read an integer dataset and store in data map. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">path</td><td>Path to the dataset </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if reading fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a11">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a75">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00690">690</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, <a class="el" href="PNeXus_8cpp_source.html#l02572">FindDatasetIndex()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8h_source.html#l00330">nxH4::kINT32</a>, <a class="el" href="PNeXus_8cpp_source.html#l00920">ReadDatasetAttributes()</a>, <a class="el" href="PNeXus_8h_source.html#l00411">nxH4::PNXdata< T >::SetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00423">nxH4::PNXdata< T >::SetDimensions()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00544">HandleIdfV1()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00628">HandleIdfV2()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff642391173eeb42354156d5689aa694" name="aff642391173eeb42354156d5689aa694"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff642391173eeb42354156d5689aa694">◆ </a></span>ReadNexusFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int nxH4::PNeXus::ReadNexusFile </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read and parse the NeXus HDF4 file. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on error </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if file cannot be opened or read </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a8">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a37">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00369">369</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8cpp_source.html#l02516">CaseInsensitiveEquals()</a>, <a class="el" href="PNeXus_8h_source.html#l00899">fFileId</a>, <a class="el" href="PNeXus_8h_source.html#l00889">fFileName</a>, <a class="el" href="PNeXus_8h_source.html#l00894">fFileNameNxs</a>, <a class="el" href="PNeXus_8h_source.html#l00895">fFileTimeNxs</a>, <a class="el" href="PNeXus_8h_source.html#l00892">fHdf4Version</a>, <a class="el" href="PNeXus_8h_source.html#l00890">fIdfVersion</a>, <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8h_source.html#l00893">fNeXusVersion</a>, <a class="el" href="PNeXus_8h_source.html#l00888">fPrintDebug</a>, <a class="el" href="PNeXus_8h_source.html#l00898">fSdId</a>, <a class="el" href="PNeXus_8cpp_source.html#l00544">HandleIdfV1()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00628">HandleIdfV2()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00340">PNeXus()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa69c5ed8dfee62492121ab4617e0caaa" name="aa69c5ed8dfee62492121ab4617e0caaa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa69c5ed8dfee62492121ab4617e0caaa">◆ </a></span>ReadStringDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::ReadStringDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Read a string dataset and store in data map. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">path</td><td>Path to the dataset </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if reading fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a14">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a77">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l00842">842</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, <a class="el" href="PNeXus_8cpp_source.html#l02572">FindDatasetIndex()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8h_source.html#l00333">nxH4::kCHAR8</a>, <a class="el" href="PNeXus_8cpp_source.html#l00920">ReadDatasetAttributes()</a>, <a class="el" href="PNeXus_8h_source.html#l00411">nxH4::PNXdata< T >::SetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00423">nxH4::PNXdata< T >::SetDimensions()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00544">HandleIdfV1()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00628">HandleIdfV2()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0d9efc6062b7e2755c71162e1d0fe8d3" name="a0d9efc6062b7e2755c71162e1d0fe8d3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d9efc6062b7e2755c71162e1d0fe8d3">◆ </a></span>RemoveDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::RemoveDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove a dataset from the data map. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset to remove </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if dataset was removed, false if path didn't exist </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a43">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00646">646</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a153b545ab178023ae65f7f36135095b6" name="a153b545ab178023ae65f7f36135095b6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a153b545ab178023ae65f7f36135095b6">◆ </a></span>RemoveDatasetAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::RemoveDatasetAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove an attribute from a dataset. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
<tr><td class="paramname">attrName</td><td>Attribute name to remove </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if attribute was removed, false if dataset doesn't exist or attribute not found </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a49">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00733">733</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, and <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a21b7d2cfa5b719e1cce3850885cf1eb4" name="a21b7d2cfa5b719e1cce3850885cf1eb4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a21b7d2cfa5b719e1cce3850885cf1eb4">◆ </a></span>RemoveGroupAttribute()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::RemoveGroupAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>groupPath</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>attrName</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Remove an attribute from a group. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">groupPath</td><td>HDF4 path of the group </td></tr>
|
|
<tr><td class="paramname">attrName</td><td>Attribute name to remove </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if attribute was removed, false if group or attribute not found </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a26">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a55">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02457">2457</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2313d4948e4c9b89fbbb4089e3dee323" name="a2313d4948e4c9b89fbbb4089e3dee323"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2313d4948e4c9b89fbbb4089e3dee323">◆ </a></span>SetDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::SetDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > &</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add or update a dataset in the data map. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path for the dataset </td></tr>
|
|
<tr><td class="paramname">data</td><td><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object to store </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a40">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00611">611</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adac8a51e080f971ca3c69be9629bc676" name="adac8a51e080f971ca3c69be9629bc676"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adac8a51e080f971ca3c69be9629bc676">◆ </a></span>SplitPath()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::vector< std::string > nxH4::PNeXus::SplitPath </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel static">static</span><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a33">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a71">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02528">2528</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02365">CreateVGroupHierarchy()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02172">WriteFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02124">WriteIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02220">WriteStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3d00a7bc38d8697c8831ac91320bec7a" name="a3d00a7bc38d8697c8831ac91320bec7a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d00a7bc38d8697c8831ac91320bec7a">◆ </a></span>UpdateDatasetData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::UpdateDatasetData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< T > &</td> <td class="paramname"><span class="paramname"><em>newData</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the data of an existing dataset. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
<tr><td class="paramname">newData</td><td>New data vector to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if update succeeded, false if path doesn't exist </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a46">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00674">674</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, and <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a499e4cb6a8ef6a00e5556bbdfb1bd89d" name="a499e4cb6a8ef6a00e5556bbdfb1bd89d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a499e4cb6a8ef6a00e5556bbdfb1bd89d">◆ </a></span>UpdateDatasetDimensions()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::UpdateDatasetDimensions </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::vector< uint32_t > &</td> <td class="paramname"><span class="paramname"><em>newDimensions</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Update the dimensions of an existing dataset. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>Data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">path</td><td>HDF4 path of the dataset </td></tr>
|
|
<tr><td class="paramname">newDimensions</td><td>New dimensions vector to set </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if update succeeded, false if path doesn't exist </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a47">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00693">693</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, and <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5ee58c8675b66002071f44fc069a6a8a" name="a5ee58c8675b66002071f44fc069a6a8a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5ee58c8675b66002071f44fc069a6a8a">◆ </a></span>WriteDatasetAttributes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T> </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::WriteDatasetAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sds_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< T > &</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write dataset attributes from <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object. </p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The data type of the <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sds_id</td><td>HDF4 dataset ID to write attributes to </td></tr>
|
|
<tr><td class="paramname">data</td><td><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object containing attributes </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a22">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a63">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02267">2267</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00476">nxH4::PNXdata< T >::GetAttributes()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02172">WriteFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02124">WriteIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02220">WriteStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adfeb069060dc065959ab106206fb054b" name="adfeb069060dc065959ab106206fb054b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adfeb069060dc065959ab106206fb054b">◆ </a></span>WriteFileAttributes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::WriteFileAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write root-level file attributes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if writing fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a18">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a69">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02079">2079</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00894">fFileNameNxs</a>, <a class="el" href="PNeXus_8h_source.html#l00895">fFileTimeNxs</a>, <a class="el" href="PNeXus_8h_source.html#l00901">fGroupAttributes</a>, <a class="el" href="PNeXus_8h_source.html#l00892">fHdf4Version</a>, and <a class="el" href="PNeXus_8h_source.html#l00893">fNeXusVersion</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l01972">WriteNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af0e299bfeb882bcb88520c6129ddc742" name="af0e299bfeb882bcb88520c6129ddc742"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af0e299bfeb882bcb88520c6129ddc742">◆ </a></span>WriteFloatDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::WriteFloatDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< float > &</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a float dataset with attributes and return its SDS reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">path</td><td>Dataset path (leaf name used for SDS name) </td></tr>
|
|
<tr><td class="paramname">data</td><td><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object containing data, dimensions, and attributes </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDS reference number for linking into Vgroups </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if writing fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a20">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a67">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02172">2172</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00399">nxH4::PNXdata< T >::GetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00417">nxH4::PNXdata< T >::GetDimensions()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02267">WriteDatasetAttributes()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l01972">WriteNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad29398abd3ee5f91f98a6ce76f2c6027" name="ad29398abd3ee5f91f98a6ce76f2c6027"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad29398abd3ee5f91f98a6ce76f2c6027">◆ </a></span>WriteIntDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::WriteIntDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< int > &</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write an integer dataset with attributes and return its SDS reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">path</td><td>Dataset path (leaf name used for SDS name) </td></tr>
|
|
<tr><td class="paramname">data</td><td><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object containing data, dimensions, and attributes </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDS reference number for linking into Vgroups </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if writing fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a19">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a66">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02124">2124</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00399">nxH4::PNXdata< T >::GetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00417">nxH4::PNXdata< T >::GetDimensions()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02267">WriteDatasetAttributes()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l01972">WriteNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae580a0a5420d70ae3f2d81b6998c299" name="aae580a0a5420d70ae3f2d81b6998c299"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae580a0a5420d70ae3f2d81b6998c299">◆ </a></span>WriteNexusFile()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int nxH4::PNeXus::WriteNexusFile </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>filename</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>idfVersion</em></span><span class="paramdefsep"> = </span><span class="paramdefval">2</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write the data map contents to a NeXus HDF4 file. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>Path to the output NeXus HDF4 file </td></tr>
|
|
<tr><td class="paramname">idfVersion</td><td>IDF version to write (default: 2) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on error </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if file cannot be created or written </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a17">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a53">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l01972">1972</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8cpp_source.html#l02365">CreateVGroupHierarchy()</a>, <a class="el" href="PNeXus_8h_source.html#l00900">fDataMap</a>, <a class="el" href="PNeXus_8cpp_source.html#l02079">WriteFileAttributes()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02172">WriteFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02124">WriteIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02220">WriteStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1f0c2989c21bda0d7b110c4408e1680c" name="a1f0c2989c21bda0d7b110c4408e1680c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1f0c2989c21bda0d7b110c4408e1680c">◆ </a></span>WriteStringDataset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::WriteStringDataset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>sd_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a>< std::string > &</td> <td class="paramname"><span class="paramname"><em>data</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write a string dataset with attributes and return its SDS reference. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sd_id</td><td>HDF4 SD interface ID </td></tr>
|
|
<tr><td class="paramname">path</td><td>Dataset path (leaf name used for SDS name) </td></tr>
|
|
<tr><td class="paramname">data</td><td><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> object containing data, dimensions, and attributes </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>SDS reference number for linking into Vgroups, or -1 for empty strings </dd></dl>
|
|
<dl class="exception"><dt>Exceptions</dt><dd>
|
|
<table class="exception">
|
|
<tr><td class="paramname">std::runtime_error</td><td>if writing fails </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a21">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a68">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02220">2220</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">References <a class="el" href="PNeXus_8h_source.html#l00399">nxH4::PNXdata< T >::GetData()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02528">SplitPath()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02267">WriteDatasetAttributes()</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l01972">WriteNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9cd55f6dd26e0558c59a457d2933e680" name="a9cd55f6dd26e0558c59a457d2933e680"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9cd55f6dd26e0558c59a457d2933e680">◆ </a></span>WriteVGroupAttributes()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void nxH4::PNeXus::WriteVGroupAttributes </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int32</td> <td class="paramname"><span class="paramname"><em>vgroup_id</em></span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::map< std::string, std::any > &</td> <td class="paramname"><span class="paramname"><em>attributes</em></span> )</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Write attributes to a Vgroup. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">vgroup_id</td><td>HDF4 Vgroup ID to write attributes to </td></tr>
|
|
<tr><td class="paramname">attributes</td><td>Map of attribute names to values </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a23">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a64">/workspace/LMU/musrfit/src/external/nexus/PNeXus.h</a>.</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8cpp_source.html#l02316">2316</a> of file <a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02365">CreateVGroupHierarchy()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a66765c63c1c68222452a2e7cad4817f4" name="a66765c63c1c68222452a2e7cad4817f4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a66765c63c1c68222452a2e7cad4817f4">◆ </a></span>fCreatorNxs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fCreatorNxs {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00896">896</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa99fbf33f3d593ae4568ff61b4b5e7a6" name="aa99fbf33f3d593ae4568ff61b4b5e7a6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa99fbf33f3d593ae4568ff61b4b5e7a6">◆ </a></span>fDataMap</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::map<std::string, std::any> nxH4::PNeXus::fDataMap</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Map of HDF4 paths to <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> objects. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00900">900</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8h_source.html#l00759">AddDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00713">AddDatasetAttribute()</a>, <a class="el" href="PNeXus_8h_source.html#l00658">ClearDataMap()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8h_source.html#l00595">GetDataMap()</a>, <a class="el" href="PNeXus_8h_source.html#l00589">GetDataMap()</a>, <a class="el" href="PNeXus_8h_source.html#l00624">GetDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00637">GetDatasetRef()</a>, <a class="el" href="PNeXus_8h_source.html#l00664">GetNumDatasets()</a>, <a class="el" href="PNeXus_8h_source.html#l00602">HasDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00779">ModifyDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00766">ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">ReadIntDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00842">ReadStringDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00646">RemoveDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00733">RemoveDatasetAttribute()</a>, <a class="el" href="PNeXus_8h_source.html#l00611">SetDataset()</a>, <a class="el" href="PNeXus_8h_source.html#l00674">UpdateDatasetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00693">UpdateDatasetDimensions()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l01972">WriteNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af689199af65372f17713b67fae7edf24" name="af689199af65372f17713b67fae7edf24"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af689199af65372f17713b67fae7edf24">◆ </a></span>fFileId</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::fFileId {-1}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HDF4 file identifier. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00899">899</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00329">PNeXus()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00340">PNeXus()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00356">~PNeXus()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a78a20378bac4a197bcfd446e62d665c2" name="a78a20378bac4a197bcfd446e62d665c2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78a20378bac4a197bcfd446e62d665c2">◆ </a></span>fFileName</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fFileName {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>NeXus HDF4 filename. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00889">889</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8h_source.html#l00552">GetFileName()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00340">PNeXus()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a497e85c6a0687b0c93a4f658b0587573" name="a497e85c6a0687b0c93a4f658b0587573"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a497e85c6a0687b0c93a4f658b0587573">◆ </a></span>fFileNameNxs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fFileNameNxs {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00894">894</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02079">WriteFileAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a288f37e927d61360a85abb847f8a7a60" name="a288f37e927d61360a85abb847f8a7a60"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a288f37e927d61360a85abb847f8a7a60">◆ </a></span>fFileTimeNxs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fFileTimeNxs {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00895">895</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02079">WriteFileAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8d86f1c94a34619a20de7286b9abaeee" name="a8d86f1c94a34619a20de7286b9abaeee"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d86f1c94a34619a20de7286b9abaeee">◆ </a></span>fGroupAttributes</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::map<std::string, std::map<std::string, std::any> > nxH4::PNeXus::fGroupAttributes</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Map of group paths to their attributes. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00901">901</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02449">AddGroupAttribute()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02498">ClearGroupAttributes()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02365">CreateVGroupHierarchy()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02481">GetGroupAttribute()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02487">GetGroupAttributes()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02471">HasGroupAttribute()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02457">RemoveGroupAttribute()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02079">WriteFileAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1e8566b9a15b27b83b8227e58ef91d34" name="a1e8566b9a15b27b83b8227e58ef91d34"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1e8566b9a15b27b83b8227e58ef91d34">◆ </a></span>fHdf4LibVersion</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fHdf4LibVersion {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HDF4 library version used when calling <a class="el" href="classnxH4_1_1PNeXus.html" title="NeXus HDF4 file reader with case-insensitive path lookup.">PNeXus</a>. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00891">891</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8h_source.html#l00558">GetHdf4LibVersion()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00329">PNeXus()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00340">PNeXus()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9f257613c664bff6011bce594d254e1d" name="a9f257613c664bff6011bce594d254e1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9f257613c664bff6011bce594d254e1d">◆ </a></span>fHdf4Version</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fHdf4Version {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HDF4 version of the file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00892">892</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8h_source.html#l00564">GetHdf4Version()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02079">WriteFileAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6a0650206c385f71564b3842e46e55f" name="af6a0650206c385f71564b3842e46e55f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6a0650206c385f71564b3842e46e55f">◆ </a></span>fIdfVersion</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int nxH4::PNeXus::fIdfVersion {-1}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>IDF version of the NeXus file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00890">890</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8h_source.html#l00576">GetIdfVersion()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8885d1b1c24a4ed336824dfe67cc602d" name="a8885d1b1c24a4ed336824dfe67cc602d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8885d1b1c24a4ed336824dfe67cc602d">◆ </a></span>fNeXusVersion</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fNeXusVersion {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>NeXus version of the file. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00893">893</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00981">Dump()</a>, <a class="el" href="PNeXus_8h_source.html#l00570">GetNeXusVersion()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02079">WriteFileAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab75b54fd1c874fda6a801def963ce579" name="ab75b54fd1c874fda6a801def963ce579"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab75b54fd1c874fda6a801def963ce579">◆ </a></span>fPrintDebug</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool nxH4::PNeXus::fPrintDebug {false}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>if true print additional debug information </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00888">888</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00544">HandleIdfV1()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00628">HandleIdfV2()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00340">PNeXus()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7c087cc1e5d3d14d6c1a2468a7c75dff" name="a7c087cc1e5d3d14d6c1a2468a7c75dff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7c087cc1e5d3d14d6c1a2468a7c75dff">◆ </a></span>fSdId</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int32 nxH4::PNeXus::fSdId {-1}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HDF4 SD interface identifier. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00898">898</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02604">FindDatasetRefByPath()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00329">PNeXus()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00340">PNeXus()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00369">ReadNexusFile()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00356">~PNeXus()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a987c8df40a432eb79b57804b15ab28d0" name="a987c8df40a432eb79b57804b15ab28d0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a987c8df40a432eb79b57804b15ab28d0">◆ </a></span>fUserV1</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string nxH4::PNeXus::fUserV1 {""}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00897">897</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/workspace/LMU/musrfit/src/external/nexus/<a class="el" href="PNeXus_8h_source.html">PNeXus.h</a></li>
|
|
<li>/workspace/LMU/musrfit/src/external/nexus/<a class="el" href="PNeXus_8cpp_source.html">PNeXus.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespacenxH4.html">nxH4</a></li><li class="navelem"><a class="el" href="classnxH4_1_1PNeXus.html">PNeXus</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|