LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 4 Activity
Files
gitea-pages
musrfit/doc/technical/html/group__FileFormats.html
Gitea Actions 8a8eac55b7 Deploy site
2025-12-27 12:57:44 +00:00

331 lines
19 KiB
HTML
Raw Permalink Blame History

<!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: Data File Format Identifiers</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">&#160;1.9.9</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&amp;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&amp;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&amp;dn=expat.txt MIT */
$(function(){initNavTree('group__FileFormats.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle"><div class="title">Data File Format Identifiers</div></div>
</div><!--header-->
<div class="contents">
<p>Constants identifying μSR data file formats for the any2many converter.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gab072286c374c8bbb9e7d9604d83bad97" id="r_gab072286c374c8bbb9e7d9604d83bad97"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gab072286c374c8bbb9e7d9604d83bad97">A2M_UNDEFINED</a>&#160;&#160;&#160;0</td></tr>
<tr class="memdesc:gab072286c374c8bbb9e7d9604d83bad97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Undefined or unknown format (used for error indication) <br /></td></tr>
<tr class="separator:gab072286c374c8bbb9e7d9604d83bad97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6148b992bd46c1011656edac79fd3832" id="r_ga6148b992bd46c1011656edac79fd3832"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga6148b992bd46c1011656edac79fd3832">A2M_ROOT</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:ga6148b992bd46c1011656edac79fd3832"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic ROOT file (minimal structure, basic histograms only) <br /></td></tr>
<tr class="separator:ga6148b992bd46c1011656edac79fd3832"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9a270574e46fcdf981582bfd3cfd84e1" id="r_ga9a270574e46fcdf981582bfd3cfd84e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga9a270574e46fcdf981582bfd3cfd84e1">A2M_MUSR_ROOT</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:ga9a270574e46fcdf981582bfd3cfd84e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">MusrRoot format (PSI-specific ROOT with complete metadata and run info) <br /></td></tr>
<tr class="separator:ga9a270574e46fcdf981582bfd3cfd84e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf78f32b6730f44eba257f55b27eb467f" id="r_gaf78f32b6730f44eba257f55b27eb467f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf78f32b6730f44eba257f55b27eb467f">A2M_MUSR_ROOT_DIR</a>&#160;&#160;&#160;3</td></tr>
<tr class="memdesc:gaf78f32b6730f44eba257f55b27eb467f"><td class="mdescLeft">&#160;</td><td class="mdescRight">MusrRoot with directory structure (organized by run number, year, etc.) <br /></td></tr>
<tr class="separator:gaf78f32b6730f44eba257f55b27eb467f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga632e63e49eb2b5fec1a85d9e4ba9421d" id="r_ga632e63e49eb2b5fec1a85d9e4ba9421d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga632e63e49eb2b5fec1a85d9e4ba9421d">A2M_PSIBIN</a>&#160;&#160;&#160;4</td></tr>
<tr class="memdesc:ga632e63e49eb2b5fec1a85d9e4ba9421d"><td class="mdescLeft">&#160;</td><td class="mdescRight">PSI binary format (legacy PSI format, platform-specific byte ordering) <br /></td></tr>
<tr class="separator:ga632e63e49eb2b5fec1a85d9e4ba9421d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae881d0da09333eb716733f7da9fd26e2" id="r_gae881d0da09333eb716733f7da9fd26e2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gae881d0da09333eb716733f7da9fd26e2">A2M_PSIMDU</a>&#160;&#160;&#160;5</td></tr>
<tr class="memdesc:gae881d0da09333eb716733f7da9fd26e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">PSI MDU ASCII format (ASCII variant of PSI format with metadata) <br /></td></tr>
<tr class="separator:gae881d0da09333eb716733f7da9fd26e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5cbde7308bae29c49226f4ce2c245441" id="r_ga5cbde7308bae29c49226f4ce2c245441"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga5cbde7308bae29c49226f4ce2c245441">A2M_MUD</a>&#160;&#160;&#160;6</td></tr>
<tr class="memdesc:ga5cbde7308bae29c49226f4ce2c245441"><td class="mdescLeft">&#160;</td><td class="mdescRight">TRIUMF MUD (Muon Data) format (TRIUMF's standard binary format) <br /></td></tr>
<tr class="separator:ga5cbde7308bae29c49226f4ce2c245441"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3000d97c0f1a044e0c4b7031b25a7937" id="r_ga3000d97c0f1a044e0c4b7031b25a7937"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga3000d97c0f1a044e0c4b7031b25a7937">A2M_NEXUS</a>&#160;&#160;&#160;7</td></tr>
<tr class="memdesc:ga3000d97c0f1a044e0c4b7031b25a7937"><td class="mdescLeft">&#160;</td><td class="mdescRight">NeXus HDF5 format (ISIS, JPARC standard - self-describing, hierarchical) <br /></td></tr>
<tr class="separator:ga3000d97c0f1a044e0c4b7031b25a7937"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa1bf0b8847c46f4bf7d8834c99249280" id="r_gaa1bf0b8847c46f4bf7d8834c99249280"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa1bf0b8847c46f4bf7d8834c99249280">A2M_WKM</a>&#160;&#160;&#160;8</td></tr>
<tr class="memdesc:gaa1bf0b8847c46f4bf7d8834c99249280"><td class="mdescLeft">&#160;</td><td class="mdescRight">WKM format (older PSI format, deprecated but still supported for legacy data) <br /></td></tr>
<tr class="separator:gaa1bf0b8847c46f4bf7d8834c99249280"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga94149c9bd912d0aa7d17f18665ace2d4" id="r_ga94149c9bd912d0aa7d17f18665ace2d4"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga94149c9bd912d0aa7d17f18665ace2d4">A2M_ASCII</a>&#160;&#160;&#160;9</td></tr>
<tr class="memdesc:ga94149c9bd912d0aa7d17f18665ace2d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic ASCII format (two-column time-value data for non-μSR applications) <br /></td></tr>
<tr class="separator:ga94149c9bd912d0aa7d17f18665ace2d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Constants identifying μSR data file formats for the any2many converter. </p>
<p>These constants are used to specify input and output formats when converting between different μSR data file formats. Each format has specific characteristics:</p>
<ul>
<li><b>ROOT-based formats:</b> Binary, fast, support complex data structures</li>
<li><b>NeXus (HDF5):</b> Self-describing, hierarchical, cross-platform standard</li>
<li><b>Binary formats:</b> Compact, fast, but platform/facility specific</li>
<li><b>ASCII formats:</b> Human-readable, portable, but larger file size </li>
</ul>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga94149c9bd912d0aa7d17f18665ace2d4" name="ga94149c9bd912d0aa7d17f18665ace2d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga94149c9bd912d0aa7d17f18665ace2d4">&#9670;&#160;</a></span>A2M_ASCII</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_ASCII&#160;&#160;&#160;9</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic ASCII format (two-column time-value data for non-μSR applications) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00071">71</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>.</p>
</div>
</div>
<a id="ga5cbde7308bae29c49226f4ce2c245441" name="ga5cbde7308bae29c49226f4ce2c245441"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5cbde7308bae29c49226f4ce2c245441">&#9670;&#160;</a></span>A2M_MUD</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_MUD&#160;&#160;&#160;6</td>
</tr>
</table>
</div><div class="memdoc">
<p>TRIUMF MUD (Muon Data) format (TRIUMF's standard binary format) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00065">65</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>.</p>
</div>
</div>
<a id="ga9a270574e46fcdf981582bfd3cfd84e1" name="ga9a270574e46fcdf981582bfd3cfd84e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9a270574e46fcdf981582bfd3cfd84e1">&#9670;&#160;</a></span>A2M_MUSR_ROOT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_MUSR_ROOT&#160;&#160;&#160;2</td>
</tr>
</table>
</div><div class="memdoc">
<p>MusrRoot format (PSI-specific ROOT with complete metadata and run info) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00057">57</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l04544">PRunDataHandler::WriteMusrRootFile()</a>.</p>
</div>
</div>
<a id="gaf78f32b6730f44eba257f55b27eb467f" name="gaf78f32b6730f44eba257f55b27eb467f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf78f32b6730f44eba257f55b27eb467f">&#9670;&#160;</a></span>A2M_MUSR_ROOT_DIR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_MUSR_ROOT_DIR&#160;&#160;&#160;3</td>
</tr>
</table>
</div><div class="memdoc">
<p>MusrRoot with directory structure (organized by run number, year, etc.) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00059">59</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>.</p>
</div>
</div>
<a id="ga3000d97c0f1a044e0c4b7031b25a7937" name="ga3000d97c0f1a044e0c4b7031b25a7937"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3000d97c0f1a044e0c4b7031b25a7937">&#9670;&#160;</a></span>A2M_NEXUS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_NEXUS&#160;&#160;&#160;7</td>
</tr>
</table>
</div><div class="memdoc">
<p>NeXus HDF5 format (ISIS, JPARC standard - self-describing, hierarchical) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00067">67</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>.</p>
</div>
</div>
<a id="ga632e63e49eb2b5fec1a85d9e4ba9421d" name="ga632e63e49eb2b5fec1a85d9e4ba9421d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga632e63e49eb2b5fec1a85d9e4ba9421d">&#9670;&#160;</a></span>A2M_PSIBIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_PSIBIN&#160;&#160;&#160;4</td>
</tr>
</table>
</div><div class="memdoc">
<p>PSI binary format (legacy PSI format, platform-specific byte ordering) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00061">61</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>.</p>
</div>
</div>
<a id="gae881d0da09333eb716733f7da9fd26e2" name="gae881d0da09333eb716733f7da9fd26e2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae881d0da09333eb716733f7da9fd26e2">&#9670;&#160;</a></span>A2M_PSIMDU</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_PSIMDU&#160;&#160;&#160;5</td>
</tr>
</table>
</div><div class="memdoc">
<p>PSI MDU ASCII format (ASCII variant of PSI format with metadata) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00063">63</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>.</p>
</div>
</div>
<a id="ga6148b992bd46c1011656edac79fd3832" name="ga6148b992bd46c1011656edac79fd3832"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6148b992bd46c1011656edac79fd3832">&#9670;&#160;</a></span>A2M_ROOT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_ROOT&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic ROOT file (minimal structure, basic histograms only) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00055">55</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>.</p>
</div>
</div>
<a id="gab072286c374c8bbb9e7d9604d83bad97" name="gab072286c374c8bbb9e7d9604d83bad97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab072286c374c8bbb9e7d9604d83bad97">&#9670;&#160;</a></span>A2M_UNDEFINED</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_UNDEFINED&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Undefined or unknown format (used for error indication) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00053">53</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</a>, and <a class="el" href="PRunDataHandler_8cpp_source.html#l00353">PRunDataHandler::WriteData()</a>.</p>
</div>
</div>
<a id="gaa1bf0b8847c46f4bf7d8834c99249280" name="gaa1bf0b8847c46f4bf7d8834c99249280"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1bf0b8847c46f4bf7d8834c99249280">&#9670;&#160;</a></span>A2M_WKM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define A2M_WKM&#160;&#160;&#160;8</td>
</tr>
</table>
</div><div class="memdoc">
<p>WKM format (older PSI format, deprecated but still supported for legacy data) </p>
<p class="definition">Definition at line <a class="el" href="PRunDataHandler_8h_source.html#l00069">69</a> of file <a class="el" href="PRunDataHandler_8h_source.html">PRunDataHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRunDataHandler_8cpp_source.html#l00561">PRunDataHandler::ReadWriteFilesList()</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="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>
Reference in New Issue View Git Blame Copy Permalink