187 lines
12 KiB
HTML
187 lines
12 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 Namespace 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('namespacenxH4.html',''); initResizable(true); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#enum-members">Enumerations</a> </div>
|
|
<div class="headertitle"><div class="title">nxH4 Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>HDF4 implementation of the NeXus file reader/writer.
|
|
<a href="#details">More...</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classnxH4_1_1PNeXus.html">PNeXus</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">NeXus HDF4 file reader with case-insensitive path lookup. <a href="classnxH4_1_1PNeXus.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classnxH4_1_1PNeXusDeadTime.html">PNeXusDeadTime</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Dead time correction calculator for muon detector data. <a href="classnxH4_1_1PNeXusDeadTime.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classnxH4_1_1PNXdata.html">PNXdata</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Template class for storing HDF4 dataset content with attributes. <a href="classnxH4_1_1PNXdata.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
|
|
Enumerations</h2></td></tr>
|
|
<tr class="memitem:a61bdb83ae066acbabf15ac914adee440" id="r_a61bdb83ae066acbabf15ac914adee440"><td class="memItemLeft" align="right" valign="top">enum class  </td><td class="memItemRight" valign="bottom"><a class="el" href="#a61bdb83ae066acbabf15ac914adee440">H4DataType</a> { <br />
|
|
  <a class="el" href="#a61bdb83ae066acbabf15ac914adee440abd073fcbb15020b25a70e2cd95f9f4a9">kINT32</a>
|
|
, <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a301f3a167870b9b96bb0cef222e840ca">kFLOAT32</a>
|
|
, <a class="el" href="#a61bdb83ae066acbabf15ac914adee440aaf8ee424b90f9be92f84682951a40030">kFLOAT64</a>
|
|
, <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a7189f5544734341eb25e4f123da788e5">kCHAR8</a>
|
|
, <br />
|
|
  <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a4ff321e2f4f9df8e42f5ab2409b1a4d2">kUINT32</a>
|
|
, <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a4995a8359faf06dc440d65fa64b3410b">kINT16</a>
|
|
, <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a3500227c188f1328650855b481471a8c">kUINT16</a>
|
|
, <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a69c1a4a69db0e50820cf63122f90ad09">kINT8</a>
|
|
, <br />
|
|
  <a class="el" href="#a61bdb83ae066acbabf15ac914adee440a159244e0ab6cea87daa7eaa8f6e19937">kUINT8</a>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a61bdb83ae066acbabf15ac914adee440"><td class="mdescLeft"> </td><td class="mdescRight">HDF4 data type enumeration. <a href="#a61bdb83ae066acbabf15ac914adee440">More...</a><br /></td></tr>
|
|
<tr class="separator:a61bdb83ae066acbabf15ac914adee440"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>HDF4 implementation of the NeXus file reader/writer. </p>
|
|
<p>The <a class="el" href="namespacenxH4.html" title="HDF4 implementation of the NeXus file reader/writer.">nxH4</a> namespace provides classes and functions for reading and writing NeXus files in HDF4 format. This implementation uses the HDF4 C API (mfhdf.h, hdf.h) and provides case-insensitive path lookup.</p>
|
|
<p><b>Key Classes:</b></p><ul>
|
|
<li><a class="el" href="classnxH4_1_1PNeXus.html" title="NeXus HDF4 file reader with case-insensitive path lookup.">PNeXus</a>: Main file reader/writer class</li>
|
|
<li><a class="el" href="classnxH4_1_1PNXdata.html" title="Template class for storing HDF4 dataset content with attributes.">PNXdata</a>: Template class for storing dataset content</li>
|
|
<li><a class="el" href="classnxH4_1_1PNeXusDeadTime.html" title="Dead time correction calculator for muon detector data.">PNeXusDeadTime</a>: Dead time correction calculator</li>
|
|
</ul>
|
|
<p><b>Requirements:</b></p><ul>
|
|
<li>HDF4 library (libmfhdf, libhdf)</li>
|
|
<li>HAVE_HDF4 must be defined at compile time</li>
|
|
</ul>
|
|
<dl class="section note"><dt>Note</dt><dd>This namespace is only available if compiled with HAVE_HDF4 defined</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespacenxH5.html" title="HDF5 implementation of the NeXus file reader/writer.">nxH5</a> for the HDF5 implementation </dd>
|
|
<dd>
|
|
<a class="el" href="namespacenxs.html#aec53b94446678ee1597e48358b74a82b" title="Determine the HDF format type of a file by reading its header.">nxs::checkHDFType()</a> to determine file format before reading </dd></dl>
|
|
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
|
|
<a id="a61bdb83ae066acbabf15ac914adee440" name="a61bdb83ae066acbabf15ac914adee440"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a61bdb83ae066acbabf15ac914adee440">◆ </a></span>H4DataType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum class <a class="el" href="#a61bdb83ae066acbabf15ac914adee440">nxH4::H4DataType</a></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel strong">strong</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>HDF4 data type enumeration. </p>
|
|
<p>This enum maps to HDF4 numeric types (DFNT_*) for type-safe dataset handling </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440abd073fcbb15020b25a70e2cd95f9f4a9" name="a61bdb83ae066acbabf15ac914adee440abd073fcbb15020b25a70e2cd95f9f4a9"></a>kINT32 </td><td class="fielddoc"><p>32-bit signed integer (DFNT_INT32) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a301f3a167870b9b96bb0cef222e840ca" name="a61bdb83ae066acbabf15ac914adee440a301f3a167870b9b96bb0cef222e840ca"></a>kFLOAT32 </td><td class="fielddoc"><p>32-bit floating point (DFNT_FLOAT32) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440aaf8ee424b90f9be92f84682951a40030" name="a61bdb83ae066acbabf15ac914adee440aaf8ee424b90f9be92f84682951a40030"></a>kFLOAT64 </td><td class="fielddoc"><p>64-bit floating point (DFNT_FLOAT64) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a7189f5544734341eb25e4f123da788e5" name="a61bdb83ae066acbabf15ac914adee440a7189f5544734341eb25e4f123da788e5"></a>kCHAR8 </td><td class="fielddoc"><p>8-bit character (DFNT_CHAR8) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a4ff321e2f4f9df8e42f5ab2409b1a4d2" name="a61bdb83ae066acbabf15ac914adee440a4ff321e2f4f9df8e42f5ab2409b1a4d2"></a>kUINT32 </td><td class="fielddoc"><p>32-bit unsigned integer (DFNT_UINT32) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a4995a8359faf06dc440d65fa64b3410b" name="a61bdb83ae066acbabf15ac914adee440a4995a8359faf06dc440d65fa64b3410b"></a>kINT16 </td><td class="fielddoc"><p>16-bit signed integer (DFNT_INT16) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a3500227c188f1328650855b481471a8c" name="a61bdb83ae066acbabf15ac914adee440a3500227c188f1328650855b481471a8c"></a>kUINT16 </td><td class="fielddoc"><p>16-bit unsigned integer (DFNT_UINT16) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a69c1a4a69db0e50820cf63122f90ad09" name="a61bdb83ae066acbabf15ac914adee440a69c1a4a69db0e50820cf63122f90ad09"></a>kINT8 </td><td class="fielddoc"><p>8-bit signed integer (DFNT_INT8) </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a61bdb83ae066acbabf15ac914adee440a159244e0ab6cea87daa7eaa8f6e19937" name="a61bdb83ae066acbabf15ac914adee440a159244e0ab6cea87daa7eaa8f6e19937"></a>kUINT8 </td><td class="fielddoc"><p>8-bit unsigned integer (DFNT_UINT8) </p>
|
|
</td></tr>
|
|
</table>
|
|
<dl class="section examples"><dt>Examples</dt><dd><a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8cpp-example.html#a37">/workspace/LMU/musrfit/src/external/nexus/PNeXus.cpp</a>, and <a class="el" href="_2workspace_2LMU_2musrfit_2src_2external_2nexus_2PNeXus_8h-example.html#a15">/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#l00329">329</a> of file <a class="el" href="PNeXus_8h_source.html">PNeXus.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</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="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>
|