935 lines
50 KiB
HTML
935 lines
50 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::PNXdata< T > Class Template 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_1PNXdata.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-attribs">Private Attributes</a> |
|
|
<a href="classnxH4_1_1PNXdata-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">nxH4::PNXdata< T > Class Template Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Template class for storing HDF4 dataset content with attributes.
|
|
<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:a4ef801c842a0178e793255e829c26ded" id="r_a4ef801c842a0178e793255e829c26ded"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4ef801c842a0178e793255e829c26ded">PNXdata</a> ()</td></tr>
|
|
<tr class="memdesc:a4ef801c842a0178e793255e829c26ded"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a4ef801c842a0178e793255e829c26ded"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7e4a8c449bd9f601df78688bee8d168" id="r_af7e4a8c449bd9f601df78688bee8d168"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#af7e4a8c449bd9f601df78688bee8d168">PNXdata</a> (const <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> &dataType)</td></tr>
|
|
<tr class="memdesc:af7e4a8c449bd9f601df78688bee8d168"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with datatype. <br /></td></tr>
|
|
<tr class="separator:af7e4a8c449bd9f601df78688bee8d168"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abb71e5c7f5d70ea4d32fd9cf3d2e1c87" id="r_abb71e5c7f5d70ea4d32fd9cf3d2e1c87"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#abb71e5c7f5d70ea4d32fd9cf3d2e1c87">GetDataType</a> () const</td></tr>
|
|
<tr class="memdesc:abb71e5c7f5d70ea4d32fd9cf3d2e1c87"><td class="mdescLeft"> </td><td class="mdescRight">Get the HDF4 DataType. <br /></td></tr>
|
|
<tr class="separator:abb71e5c7f5d70ea4d32fd9cf3d2e1c87"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ab5b8b68142cb8050ad7a2fce858546" id="r_a6ab5b8b68142cb8050ad7a2fce858546"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6ab5b8b68142cb8050ad7a2fce858546">SetDataType</a> (const <a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> &dataType)</td></tr>
|
|
<tr class="memdesc:a6ab5b8b68142cb8050ad7a2fce858546"><td class="mdescLeft"> </td><td class="mdescRight">Set the HDF4 DataType. <br /></td></tr>
|
|
<tr class="separator:a6ab5b8b68142cb8050ad7a2fce858546"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a307fab7ea2f3f3fc561159b91711a74a" id="r_a307fab7ea2f3f3fc561159b91711a74a"><td class="memItemLeft" align="right" valign="top">const std::vector< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a307fab7ea2f3f3fc561159b91711a74a">GetData</a> () const</td></tr>
|
|
<tr class="memdesc:a307fab7ea2f3f3fc561159b91711a74a"><td class="mdescLeft"> </td><td class="mdescRight">Get the data as a vector. <br /></td></tr>
|
|
<tr class="separator:a307fab7ea2f3f3fc561159b91711a74a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a363fe9f347dddfc2ce042b488a09df48" id="r_a363fe9f347dddfc2ce042b488a09df48"><td class="memItemLeft" align="right" valign="top">std::vector< T > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a363fe9f347dddfc2ce042b488a09df48">GetData</a> ()</td></tr>
|
|
<tr class="memdesc:a363fe9f347dddfc2ce042b488a09df48"><td class="mdescLeft"> </td><td class="mdescRight">Get mutable reference to the data vector. <br /></td></tr>
|
|
<tr class="separator:a363fe9f347dddfc2ce042b488a09df48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88304644405ca79ae57ef018d61212bf" id="r_a88304644405ca79ae57ef018d61212bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a88304644405ca79ae57ef018d61212bf">SetData</a> (const std::vector< T > &data)</td></tr>
|
|
<tr class="memdesc:a88304644405ca79ae57ef018d61212bf"><td class="mdescLeft"> </td><td class="mdescRight">Set the data vector. <br /></td></tr>
|
|
<tr class="separator:a88304644405ca79ae57ef018d61212bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6d250a60ecd226bd00fafc0a1bb0069" id="r_ac6d250a60ecd226bd00fafc0a1bb0069"><td class="memItemLeft" align="right" valign="top">const std::vector< uint32_t > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac6d250a60ecd226bd00fafc0a1bb0069">GetDimensions</a> () const</td></tr>
|
|
<tr class="memdesc:ac6d250a60ecd226bd00fafc0a1bb0069"><td class="mdescLeft"> </td><td class="mdescRight">Get the dimensions of the dataset. <br /></td></tr>
|
|
<tr class="separator:ac6d250a60ecd226bd00fafc0a1bb0069"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c25d666c8c487fb88f2a033d32a03c0" id="r_a8c25d666c8c487fb88f2a033d32a03c0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c25d666c8c487fb88f2a033d32a03c0">SetDimensions</a> (const std::vector< uint32_t > &dims)</td></tr>
|
|
<tr class="memdesc:a8c25d666c8c487fb88f2a033d32a03c0"><td class="mdescLeft"> </td><td class="mdescRight">Set the dimensions of the dataset. <br /></td></tr>
|
|
<tr class="separator:a8c25d666c8c487fb88f2a033d32a03c0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae005ae93a602e30661fa2de7443e10d8" id="r_ae005ae93a602e30661fa2de7443e10d8"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae005ae93a602e30661fa2de7443e10d8">GetRank</a> () const</td></tr>
|
|
<tr class="memdesc:ae005ae93a602e30661fa2de7443e10d8"><td class="mdescLeft"> </td><td class="mdescRight">Get the number of dimensions. <br /></td></tr>
|
|
<tr class="separator:ae005ae93a602e30661fa2de7443e10d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad72286f53559e1e4e9c3b407078fba18" id="r_ad72286f53559e1e4e9c3b407078fba18"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad72286f53559e1e4e9c3b407078fba18">GetNumElements</a> () const</td></tr>
|
|
<tr class="memdesc:ad72286f53559e1e4e9c3b407078fba18"><td class="mdescLeft"> </td><td class="mdescRight">Get total number of elements. <br /></td></tr>
|
|
<tr class="separator:ad72286f53559e1e4e9c3b407078fba18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aacb7c03d160f9eb11d784e09dfee1e7b" id="r_aacb7c03d160f9eb11d784e09dfee1e7b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aacb7c03d160f9eb11d784e09dfee1e7b">AddAttribute</a> (const std::string &name, const std::any &value)</td></tr>
|
|
<tr class="memdesc:aacb7c03d160f9eb11d784e09dfee1e7b"><td class="mdescLeft"> </td><td class="mdescRight">Add an attribute to this dataset. <br /></td></tr>
|
|
<tr class="separator:aacb7c03d160f9eb11d784e09dfee1e7b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aefa3fac92af11dd462e747792b6eda50" id="r_aefa3fac92af11dd462e747792b6eda50"><td class="memItemLeft" align="right" valign="top">std::any </td><td class="memItemRight" valign="bottom"><a class="el" href="#aefa3fac92af11dd462e747792b6eda50">GetAttribute</a> (const std::string &name) const</td></tr>
|
|
<tr class="memdesc:aefa3fac92af11dd462e747792b6eda50"><td class="mdescLeft"> </td><td class="mdescRight">Get an attribute by name. <br /></td></tr>
|
|
<tr class="separator:aefa3fac92af11dd462e747792b6eda50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b831d03c9ebc4d9bba9f5ecbefba6d9" id="r_a9b831d03c9ebc4d9bba9f5ecbefba6d9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b831d03c9ebc4d9bba9f5ecbefba6d9">HasAttribute</a> (const std::string &name) const</td></tr>
|
|
<tr class="memdesc:a9b831d03c9ebc4d9bba9f5ecbefba6d9"><td class="mdescLeft"> </td><td class="mdescRight">Check if an attribute exists. <br /></td></tr>
|
|
<tr class="separator:a9b831d03c9ebc4d9bba9f5ecbefba6d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8fe6f6c1f4961b72e9e6be68fce2586d" id="r_a8fe6f6c1f4961b72e9e6be68fce2586d"><td class="memItemLeft" align="right" valign="top">const std::map< std::string, std::any > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8fe6f6c1f4961b72e9e6be68fce2586d">GetAttributes</a> () const</td></tr>
|
|
<tr class="memdesc:a8fe6f6c1f4961b72e9e6be68fce2586d"><td class="mdescLeft"> </td><td class="mdescRight">Get all attributes. <br /></td></tr>
|
|
<tr class="separator:a8fe6f6c1f4961b72e9e6be68fce2586d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a845cf6ccce8d388348b9ca262a412151" id="r_a845cf6ccce8d388348b9ca262a412151"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::any > & </td><td class="memItemRight" valign="bottom"><a class="el" href="#a845cf6ccce8d388348b9ca262a412151">GetAttributes</a> ()</td></tr>
|
|
<tr class="memdesc:a845cf6ccce8d388348b9ca262a412151"><td class="mdescLeft"> </td><td class="mdescRight">Get mutable reference to all attributes. <br /></td></tr>
|
|
<tr class="separator:a845cf6ccce8d388348b9ca262a412151"><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:aa91919769062f85b1835f0b9f3103186" id="r_aa91919769062f85b1835f0b9f3103186"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa91919769062f85b1835f0b9f3103186">fDataType</a></td></tr>
|
|
<tr class="memdesc:aa91919769062f85b1835f0b9f3103186"><td class="mdescLeft"> </td><td class="mdescRight">HDF4 datatype of the dataset. <br /></td></tr>
|
|
<tr class="separator:aa91919769062f85b1835f0b9f3103186"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a551b1ef990a114498393d9417b5c7782" id="r_a551b1ef990a114498393d9417b5c7782"><td class="memItemLeft" align="right" valign="top">std::vector< T > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a551b1ef990a114498393d9417b5c7782">fData</a></td></tr>
|
|
<tr class="memdesc:a551b1ef990a114498393d9417b5c7782"><td class="mdescLeft"> </td><td class="mdescRight">Data storage (flattened multi-dimensional array) <br /></td></tr>
|
|
<tr class="separator:a551b1ef990a114498393d9417b5c7782"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a362bf82b9e90a7589210f1ca9c92479f" id="r_a362bf82b9e90a7589210f1ca9c92479f"><td class="memItemLeft" align="right" valign="top">std::vector< uint32_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a362bf82b9e90a7589210f1ca9c92479f">fDimensions</a></td></tr>
|
|
<tr class="memdesc:a362bf82b9e90a7589210f1ca9c92479f"><td class="mdescLeft"> </td><td class="mdescRight">Dimensions of the dataset. <br /></td></tr>
|
|
<tr class="separator:a362bf82b9e90a7589210f1ca9c92479f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8d529e47c5a0822bd1f1e64758f1ee54" id="r_a8d529e47c5a0822bd1f1e64758f1ee54"><td class="memItemLeft" align="right" valign="top">std::map< std::string, std::any > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8d529e47c5a0822bd1f1e64758f1ee54">fAttributes</a></td></tr>
|
|
<tr class="memdesc:a8d529e47c5a0822bd1f1e64758f1ee54"><td class="mdescLeft"> </td><td class="mdescRight">Attributes associated with this dataset. <br /></td></tr>
|
|
<tr class="separator:a8d529e47c5a0822bd1f1e64758f1ee54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><div class="compoundTemplParams">template<typename T><br />
|
|
class nxH4::PNXdata< T ></div><p>Template class for storing HDF4 dataset content with attributes. </p>
|
|
<p>The <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> class stores data read from an HDF4 dataset along with metadata such as dimensions, datatype, and attributes. It is designed to be stored in std::map<std::string, std::any> where the key is the HDF4 path.</p>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>The element type of the dataset (int, float, std::string, etc.)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>Key features:</p><ul>
|
|
<li>Stores multi-dimensional data as flattened std::vector<T></li>
|
|
<li>Preserves dimension information (shape)</li>
|
|
<li>Stores HDF4 DataType for type safety</li>
|
|
<li>Supports attributes as nested <a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a> objects</li>
|
|
<li>Compatible with std::any for type-erased storage </li>
|
|
</ul>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#_a12">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#_a13">/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#l00370">370</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="a4ef801c842a0178e793255e829c26ded" name="a4ef801c842a0178e793255e829c26ded"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ef801c842a0178e793255e829c26ded">◆ </a></span>PNXdata() <span class="overload">[1/2]</span></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">nxH4::PNXdata</a>< T >::PNXdata </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>Default constructor. </p>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a14">/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#l00375">375</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#l00489">fDataType</a>, and <a class="el" href="PNeXus_8h_source.html#l00330">nxH4::kINT32</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7e4a8c449bd9f601df78688bee8d168" name="af7e4a8c449bd9f601df78688bee8d168"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7e4a8c449bd9f601df78688bee8d168">◆ </a></span>PNXdata() <span class="overload">[2/2]</span></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">nxH4::PNXdata</a>< T >::PNXdata </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></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>Constructor with datatype. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataType</td><td>HDF4 datatype for this dataset </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00381">381</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#l00489">fDataType</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="aacb7c03d160f9eb11d784e09dfee1e7b" name="aacb7c03d160f9eb11d784e09dfee1e7b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacb7c03d160f9eb11d784e09dfee1e7b">◆ </a></span>AddAttribute()</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 <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::AddAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</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>value</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 an attribute to this dataset. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Attribute name </td></tr>
|
|
<tr><td class="paramname">value</td><td>Attribute value (stored as std::any to support different types) </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#a25">/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#l00449">449</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#l00492">fAttributes</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l00920">nxH4::PNeXus::ReadDatasetAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aefa3fac92af11dd462e747792b6eda50" name="aefa3fac92af11dd462e747792b6eda50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aefa3fac92af11dd462e747792b6eda50">◆ </a></span>GetAttribute()</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">std::any <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</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 an attribute by name. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</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 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_8h-example.html#a26">/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#l00459">459</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#l00492">fAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a845cf6ccce8d388348b9ca262a412151" name="a845cf6ccce8d388348b9ca262a412151"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a845cf6ccce8d388348b9ca262a412151">◆ </a></span>GetAttributes() <span class="overload">[1/2]</span></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">std::map< std::string, std::any > & <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetAttributes </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 all attributes. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Mutable map of attribute names to values </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00484">484</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#l00492">fAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8fe6f6c1f4961b72e9e6be68fce2586d" name="a8fe6f6c1f4961b72e9e6be68fce2586d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8fe6f6c1f4961b72e9e6be68fce2586d">◆ </a></span>GetAttributes() <span class="overload">[2/2]</span></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">const std::map< std::string, std::any > & <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetAttributes </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 all attributes. </p>
|
|
<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_8h-example.html#a28">/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#l00476">476</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#l00492">fAttributes</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02267">nxH4::PNeXus::WriteDatasetAttributes()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a363fe9f347dddfc2ce042b488a09df48" name="a363fe9f347dddfc2ce042b488a09df48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a363fe9f347dddfc2ce042b488a09df48">◆ </a></span>GetData() <span class="overload">[1/2]</span></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">std::vector< T > & <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetData </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 vector. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the data vector </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00405">405</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#l00490">fData</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a307fab7ea2f3f3fc561159b91711a74a" name="a307fab7ea2f3f3fc561159b91711a74a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a307fab7ea2f3f3fc561159b91711a74a">◆ </a></span>GetData() <span class="overload">[2/2]</span></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">const std::vector< T > & <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetData </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 as a vector. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Reference to the data vector </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a19">/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#l00399">399</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#l00490">fData</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02172">nxH4::PNeXus::WriteFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l02124">nxH4::PNeXus::WriteIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02220">nxH4::PNeXus::WriteStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abb71e5c7f5d70ea4d32fd9cf3d2e1c87" name="abb71e5c7f5d70ea4d32fd9cf3d2e1c87"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abb71e5c7f5d70ea4d32fd9cf3d2e1c87">◆ </a></span>GetDataType()</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="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetDataType </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 DataType. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The HDF4 DataType for this dataset </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a17">/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#l00387">387</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#l00489">fDataType</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac6d250a60ecd226bd00fafc0a1bb0069" name="ac6d250a60ecd226bd00fafc0a1bb0069"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac6d250a60ecd226bd00fafc0a1bb0069">◆ </a></span>GetDimensions()</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">const std::vector< uint32_t > & <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetDimensions </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 dimensions of the dataset. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Vector of dimension sizes </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a21">/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#l00417">417</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#l00491">fDimensions</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8cpp_source.html#l02172">nxH4::PNeXus::WriteFloatDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l02124">nxH4::PNeXus::WriteIntDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad72286f53559e1e4e9c3b407078fba18" name="ad72286f53559e1e4e9c3b407078fba18"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad72286f53559e1e4e9c3b407078fba18">◆ </a></span>GetNumElements()</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">size_t <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetNumElements </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 total number of elements. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Product of all dimensions </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a24">/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#l00435">435</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#l00491">fDimensions</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae005ae93a602e30661fa2de7443e10d8" name="ae005ae93a602e30661fa2de7443e10d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae005ae93a602e30661fa2de7443e10d8">◆ </a></span>GetRank()</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">size_t <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::GetRank </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 dimensions. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of dimensions (rank) </dd></dl>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a23">/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#l00429">429</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#l00491">fDimensions</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b831d03c9ebc4d9bba9f5ecbefba6d9" name="a9b831d03c9ebc4d9bba9f5ecbefba6d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b831d03c9ebc4d9bba9f5ecbefba6d9">◆ </a></span>HasAttribute()</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 <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::HasAttribute </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string &</td> <td class="paramname"><span class="paramname"><em>name</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 an attribute exists. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Attribute name </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_8h-example.html#a27">/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#l00468">468</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#l00492">fAttributes</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88304644405ca79ae57ef018d61212bf" name="a88304644405ca79ae57ef018d61212bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88304644405ca79ae57ef018d61212bf">◆ </a></span>SetData()</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 <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::SetData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< T > &</td> <td class="paramname"><span class="paramname"><em>data</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>Set the data vector. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">data</td><td>Vector of data 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#a20">/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#l00411">411</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#l00490">fData</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8h_source.html#l00759">nxH4::PNeXus::AddDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00766">nxH4::PNeXus::ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">nxH4::PNeXus::ReadIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">nxH4::PNeXus::ReadStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ab5b8b68142cb8050ad7a2fce858546" name="a6ab5b8b68142cb8050ad7a2fce858546"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ab5b8b68142cb8050ad7a2fce858546">◆ </a></span>SetDataType()</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 <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::SetDataType </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></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>Set the HDF4 DataType. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dataType</td><td>The HDF4 DataType to set </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#a18">/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#l00393">393</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#l00489">fDataType</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c25d666c8c487fb88f2a033d32a03c0" name="a8c25d666c8c487fb88f2a033d32a03c0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c25d666c8c487fb88f2a033d32a03c0">◆ </a></span>SetDimensions()</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 <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::SetDimensions </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::vector< uint32_t > &</td> <td class="paramname"><span class="paramname"><em>dims</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>Set the dimensions of the dataset. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dims</td><td>Vector of dimension sizes </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#a22">/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#l00423">423</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#l00491">fDimensions</a>.</p>
|
|
|
|
<p class="reference">Referenced by <a class="el" href="PNeXus_8h_source.html#l00759">nxH4::PNeXus::AddDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00766">nxH4::PNeXus::ReadFloatDataset()</a>, <a class="el" href="PNeXus_8cpp_source.html#l00690">nxH4::PNeXus::ReadIntDataset()</a>, and <a class="el" href="PNeXus_8cpp_source.html#l00842">nxH4::PNeXus::ReadStringDataset()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a8d529e47c5a0822bd1f1e64758f1ee54" name="a8d529e47c5a0822bd1f1e64758f1ee54"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8d529e47c5a0822bd1f1e64758f1ee54">◆ </a></span>fAttributes</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">std::map<std::string, std::any> <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::fAttributes</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>Attributes associated with this dataset. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00492">492</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#l00449">AddAttribute()</a>, <a class="el" href="PNeXus_8h_source.html#l00459">GetAttribute()</a>, <a class="el" href="PNeXus_8h_source.html#l00484">GetAttributes()</a>, <a class="el" href="PNeXus_8h_source.html#l00476">GetAttributes()</a>, and <a class="el" href="PNeXus_8h_source.html#l00468">HasAttribute()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a551b1ef990a114498393d9417b5c7782" name="a551b1ef990a114498393d9417b5c7782"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a551b1ef990a114498393d9417b5c7782">◆ </a></span>fData</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">std::vector<T> <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::fData</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>Data storage (flattened multi-dimensional array) </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00490">490</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#l00405">GetData()</a>, <a class="el" href="PNeXus_8h_source.html#l00399">GetData()</a>, and <a class="el" href="PNeXus_8h_source.html#l00411">SetData()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa91919769062f85b1835f0b9f3103186" name="aa91919769062f85b1835f0b9f3103186"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa91919769062f85b1835f0b9f3103186">◆ </a></span>fDataType</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="namespacenxH4.html#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::fDataType</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 datatype of the dataset. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00489">489</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#l00387">GetDataType()</a>, <a class="el" href="PNeXus_8h_source.html#l00375">PNXdata()</a>, <a class="el" href="PNeXus_8h_source.html#l00381">PNXdata()</a>, and <a class="el" href="PNeXus_8h_source.html#l00393">SetDataType()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a362bf82b9e90a7589210f1ca9c92479f" name="a362bf82b9e90a7589210f1ca9c92479f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a362bf82b9e90a7589210f1ca9c92479f">◆ </a></span>fDimensions</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">std::vector<uint32_t> <a class="el" href="classnxH4_1_1PNXdata.html">nxH4::PNXdata</a>< T >::fDimensions</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>Dimensions of the dataset. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PNeXus_8h_source.html#l00491">491</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#l00417">GetDimensions()</a>, <a class="el" href="PNeXus_8h_source.html#l00435">GetNumElements()</a>, <a class="el" href="PNeXus_8h_source.html#l00429">GetRank()</a>, and <a class="el" href="PNeXus_8h_source.html#l00423">SetDimensions()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>/workspace/LMU/musrfit/src/external/nexus/<a class="el" href="PNeXus_8h_source.html">PNeXus.h</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_1PNXdata.html">PNXdata</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>
|