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

636 lines
40 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: PFindRun 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">&#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('classPFindRun.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classPFindRun-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PFindRun Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classPFindRun.html" title="PFindRun - Locates muSR data files using template-based path resolution.">PFindRun</a> - Locates muSR data files using template-based path resolution.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>&gt;</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:af79fc78d3dc2ca2d18a1023007d5c06d" id="r_af79fc78d3dc2ca2d18a1023007d5c06d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af79fc78d3dc2ca2d18a1023007d5c06d">PFindRun</a> (const <a class="el" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> path, const <a class="el" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> runNameTemplateList)</td></tr>
<tr class="memdesc:af79fc78d3dc2ca2d18a1023007d5c06d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor - Creates instance without search parameters. <br /></td></tr>
<tr class="separator:af79fc78d3dc2ca2d18a1023007d5c06d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed48dd72961f6fe979e7e7a328dde515" id="r_aed48dd72961f6fe979e7e7a328dde515"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed48dd72961f6fe979e7e7a328dde515">PFindRun</a> (const <a class="el" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> path, const <a class="el" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> runNameTemplateList, const TString &amp;instrument, const UInt_t year, const UInt_t run, const TString file_format=&quot;&quot;)</td></tr>
<tr class="memdesc:aed48dd72961f6fe979e7e7a328dde515"><td class="mdescLeft">&#160;</td><td class="mdescRight">Full constructor - Creates instance and prepares for file search. <br /></td></tr>
<tr class="separator:aed48dd72961f6fe979e7e7a328dde515"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac80cae699db88f45a24fd087b77d9a39" id="r_ac80cae699db88f45a24fd087b77d9a39"><td class="memItemLeft" align="right" valign="top">Bool_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac80cae699db88f45a24fd087b77d9a39">FoundPathName</a> ()</td></tr>
<tr class="memdesc:ac80cae699db88f45a24fd087b77d9a39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Searches for the run file using configured templates and paths. <br /></td></tr>
<tr class="separator:ac80cae699db88f45a24fd087b77d9a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef0d2bbab3475c7599ba624d9005d73b" id="r_aef0d2bbab3475c7599ba624d9005d73b"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aef0d2bbab3475c7599ba624d9005d73b">GetPathName</a> ()</td></tr>
<tr class="memdesc:aef0d2bbab3475c7599ba624d9005d73b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the full path to the found run file. <br /></td></tr>
<tr class="separator:aef0d2bbab3475c7599ba624d9005d73b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6522eccd3a89008f05b80e9b7a343999" id="r_a6522eccd3a89008f05b80e9b7a343999"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6522eccd3a89008f05b80e9b7a343999">DumpTemplateList</a> ()</td></tr>
<tr class="memdesc:a6522eccd3a89008f05b80e9b7a343999"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug utility - Prints current search configuration to stdout. <br /></td></tr>
<tr class="separator:a6522eccd3a89008f05b80e9b7a343999"><td class="memSeparator" colspan="2">&#160;</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:af191829d46f7ecf9076855aa8dd78bb0" id="r_af191829d46f7ecf9076855aa8dd78bb0"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af191829d46f7ecf9076855aa8dd78bb0">CreatePathName</a> (const TString path, const TString runNameTemplate)</td></tr>
<tr class="memdesc:af191829d46f7ecf9076855aa8dd78bb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates full file path by substituting template placeholders. <br /></td></tr>
<tr class="separator:af191829d46f7ecf9076855aa8dd78bb0"><td class="memSeparator" colspan="2">&#160;</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:a7c834ebdce8739bd2f7437bf1ce167d4" id="r_a7c834ebdce8739bd2f7437bf1ce167d4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7c834ebdce8739bd2f7437bf1ce167d4">fPath</a></td></tr>
<tr class="memdesc:a7c834ebdce8739bd2f7437bf1ce167d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Search paths for data files. <br /></td></tr>
<tr class="separator:a7c834ebdce8739bd2f7437bf1ce167d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2d288d577eaf97a4d5cce10cfc0afb8" id="r_ae2d288d577eaf97a4d5cce10cfc0afb8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2d288d577eaf97a4d5cce10cfc0afb8">fRunNameTemplateList</a></td></tr>
<tr class="memdesc:ae2d288d577eaf97a4d5cce10cfc0afb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template patterns per instrument. <br /></td></tr>
<tr class="separator:ae2d288d577eaf97a4d5cce10cfc0afb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3e9ae32d28d4df255e770f01e98fb4" id="r_a1d3e9ae32d28d4df255e770f01e98fb4"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1d3e9ae32d28d4df255e770f01e98fb4">fInstrument</a> {&quot;&quot;}</td></tr>
<tr class="memdesc:a1d3e9ae32d28d4df255e770f01e98fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Target instrument name (e.g., "GPS", "LEM") <br /></td></tr>
<tr class="separator:a1d3e9ae32d28d4df255e770f01e98fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bf08210c9dcc095c936e231e44c0a9b" id="r_a0bf08210c9dcc095c936e231e44c0a9b"><td class="memItemLeft" align="right" valign="top">Int_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0bf08210c9dcc095c936e231e44c0a9b">fYear</a> {-1}</td></tr>
<tr class="memdesc:a0bf08210c9dcc095c936e231e44c0a9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run year (-1 if not specified) <br /></td></tr>
<tr class="separator:a0bf08210c9dcc095c936e231e44c0a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3c0970f0b6d9d3ffd5034c507d72061" id="r_aa3c0970f0b6d9d3ffd5034c507d72061"><td class="memItemLeft" align="right" valign="top">Int_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3c0970f0b6d9d3ffd5034c507d72061">fRun</a> {-1}</td></tr>
<tr class="memdesc:aa3c0970f0b6d9d3ffd5034c507d72061"><td class="mdescLeft">&#160;</td><td class="mdescRight">Run number (-1 if not specified) <br /></td></tr>
<tr class="separator:aa3c0970f0b6d9d3ffd5034c507d72061"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3cc44abd696e2be144bbd4bfe309fd0" id="r_ab3cc44abd696e2be144bbd4bfe309fd0"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab3cc44abd696e2be144bbd4bfe309fd0">fFileFormat</a> {&quot;&quot;}</td></tr>
<tr class="memdesc:ab3cc44abd696e2be144bbd4bfe309fd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Optional file format filter (empty = any) <br /></td></tr>
<tr class="separator:ab3cc44abd696e2be144bbd4bfe309fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1217b7ae5766231c388a2a522882ffd5" id="r_a1217b7ae5766231c388a2a522882ffd5"><td class="memItemLeft" align="right" valign="top">TString&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1217b7ae5766231c388a2a522882ffd5">fPathName</a> {&quot;&quot;}</td></tr>
<tr class="memdesc:a1217b7ae5766231c388a2a522882ffd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resolved full path (empty until found) <br /></td></tr>
<tr class="separator:a1217b7ae5766231c388a2a522882ffd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classPFindRun.html" title="PFindRun - Locates muSR data files using template-based path resolution.">PFindRun</a> - Locates muSR data files using template-based path resolution. </p>
<p>This class searches for muSR run data files across multiple paths using configurable templates that encode instrument naming conventions. It supports various file formats (ROOT, NeXus, PSI-BIN, PSI-MDU, MUD, WKM) and handles year/run number substitution in file paths.</p>
<p>The template system uses placeholders:</p><ul>
<li>yyyy% : 4-digit year (e.g., 2023)</li>
<li>yy% : 2-digit year (e.g., 23)</li>
<li>rr...r% : Run number with varying digits (rr%, rrr%, up to rrrrrrrrr%)</li>
</ul>
<dl class="section user"><dt>Example Usage:</dt><dd><div class="fragment"><div class="line"><a class="code hl_typedef" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> paths = {<span class="stringliteral">&quot;/data/gps&quot;</span>, <span class="stringliteral">&quot;/data/lem&quot;</span>};</div>
<div class="line"><a class="code hl_typedef" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> templates;</div>
<div class="line"><a class="code hl_struct" href="structPRunNameTemplate.html">PRunNameTemplate</a> gpsTemplate;</div>
<div class="line">gpsTemplate.<a class="code hl_variable" href="structPRunNameTemplate.html#a3ca25f868774fa960c829fb2bb36fb61">instrument</a> = <span class="stringliteral">&quot;GPS&quot;</span>;</div>
<div class="line">gpsTemplate.<a class="code hl_variable" href="structPRunNameTemplate.html#a25e24cd0e02a299ccec25992e33e60b2">runNameTemplate</a> = <span class="stringliteral">&quot;%yyyy%/%rrrrr%.root&quot;</span>;</div>
<div class="line">templates.push_back(gpsTemplate);</div>
<div class="line"> </div>
<div class="line"><a class="code hl_class" href="classPFindRun.html">PFindRun</a> finder(paths, templates, <span class="stringliteral">&quot;GPS&quot;</span>, 2023, 2425, <span class="stringliteral">&quot;MusrRoot&quot;</span>);</div>
<div class="line"><span class="keywordflow">if</span> (finder.FoundPathName()) {</div>
<div class="line"> TString fullPath = finder.GetPathName();</div>
<div class="line"> <span class="comment">// fullPath = &quot;/data/gps/2023/02425.root&quot;</span></div>
<div class="line">}</div>
<div class="ttc" id="aPMusr_8h_html_a01ff11ebda5d1a9096e8c9a65d085778"><div class="ttname"><a href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a></div><div class="ttdeci">std::vector&lt; PRunNameTemplate &gt; PRunNameTemplateList</div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l01441">PMusr.h:1441</a></div></div>
<div class="ttc" id="aPMusr_8h_html_ae50e503cc0f1bbc1fda5b86735ea9983"><div class="ttname"><a href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a></div><div class="ttdeci">std::vector&lt; TString &gt; PStringVector</div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l00403">PMusr.h:403</a></div></div>
<div class="ttc" id="aclassPFindRun_html"><div class="ttname"><a href="classPFindRun.html">PFindRun</a></div><div class="ttdoc">PFindRun - Locates muSR data files using template-based path resolution.</div><div class="ttdef"><b>Definition</b> <a href="PFindRun_8h_source.html#l00068">PFindRun.h:68</a></div></div>
<div class="ttc" id="astructPRunNameTemplate_html"><div class="ttname"><a href="structPRunNameTemplate.html">PRunNameTemplate</a></div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l01432">PMusr.h:1432</a></div></div>
<div class="ttc" id="astructPRunNameTemplate_html_a25e24cd0e02a299ccec25992e33e60b2"><div class="ttname"><a href="structPRunNameTemplate.html#a25e24cd0e02a299ccec25992e33e60b2">PRunNameTemplate::runNameTemplate</a></div><div class="ttdeci">TString runNameTemplate</div><div class="ttdoc">File path template with placeholders (r=run, y=year)</div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l01434">PMusr.h:1434</a></div></div>
<div class="ttc" id="astructPRunNameTemplate_html_a3ca25f868774fa960c829fb2bb36fb61"><div class="ttname"><a href="structPRunNameTemplate.html#a3ca25f868774fa960c829fb2bb36fb61">PRunNameTemplate::instrument</a></div><div class="ttdeci">TString instrument</div><div class="ttdoc">Instrument identifier (e.g., &quot;GPS&quot;, &quot;LEM&quot;, &quot;DOLLY&quot;)</div><div class="ttdef"><b>Definition</b> <a href="PMusr_8h_source.html#l01433">PMusr.h:1433</a></div></div>
</div><!-- fragment --></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPRunNameTemplate.html">PRunNameTemplate</a> </dd>
<dd>
<a class="el" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00068">68</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af79fc78d3dc2ca2d18a1023007d5c06d" name="af79fc78d3dc2ca2d18a1023007d5c06d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af79fc78d3dc2ca2d18a1023007d5c06d">&#9670;&#160;</a></span>PFindRun() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PFindRun::PFindRun </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a></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="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a></td> <td class="paramname"><span class="paramname"><em>runNameTemplateList</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Default constructor - Creates instance without search parameters. </p>
<p><a class="el" href="#af79fc78d3dc2ca2d18a1023007d5c06d" title="Default constructor - Creates instance without search parameters.">PFindRun::PFindRun</a>.</p>
<p>Initializes the finder with paths and templates but no specific run to search. Use the full constructor to perform automatic searches.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Vector of directory paths to search </td></tr>
<tr><td class="paramname">runNameTemplateList</td><td>List of template patterns for different instruments</td></tr>
<tr><td class="paramname">runNameTemplateList</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PFindRun_8cpp_source.html#l00040">40</a> of file <a class="el" href="PFindRun_8cpp_source.html">PFindRun.cpp</a>.</p>
<p class="reference">References <a class="el" href="PFindRun_8h_source.html#l00140">fPath</a>, and <a class="el" href="PFindRun_8h_source.html#l00141">fRunNameTemplateList</a>.</p>
</div>
</div>
<a id="aed48dd72961f6fe979e7e7a328dde515" name="aed48dd72961f6fe979e7e7a328dde515"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed48dd72961f6fe979e7e7a328dde515">&#9670;&#160;</a></span>PFindRun() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PFindRun::PFindRun </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a></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="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a></td> <td class="paramname"><span class="paramname"><em>runNameTemplateList</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TString &amp;</td> <td class="paramname"><span class="paramname"><em>instrument</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UInt_t</td> <td class="paramname"><span class="paramname"><em>year</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const UInt_t</td> <td class="paramname"><span class="paramname"><em>run</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TString</td> <td class="paramname"><span class="paramname"><em>file_format</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&quot;&quot;</span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Full constructor - Creates instance and prepares for file search. </p>
<p><a class="el" href="#af79fc78d3dc2ca2d18a1023007d5c06d" title="Default constructor - Creates instance without search parameters.">PFindRun::PFindRun</a>.</p>
<p>Initializes the finder with all parameters needed to locate a specific run file. Call <a class="el" href="#ac80cae699db88f45a24fd087b77d9a39" title="Searches for the run file using configured templates and paths.">FoundPathName()</a> after construction to perform the actual search.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Vector of directory paths to search </td></tr>
<tr><td class="paramname">runNameTemplateList</td><td>List of template patterns for different instruments </td></tr>
<tr><td class="paramname">instrument</td><td>Instrument name (must match a template entry, e.g., "GPS", "LEM") </td></tr>
<tr><td class="paramname">year</td><td>Run year (e.g., 2023) </td></tr>
<tr><td class="paramname">run</td><td>Run number (e.g., 2425) </td></tr>
<tr><td class="paramname">file_format</td><td>Optional file format filter: "MusrRoot"/"ROOT", "NeXus", "PSI-BIN", "PSI-MDU", "MUD", "WKM". Empty string matches any format.</td></tr>
<tr><td class="paramname">path</td><td></td></tr>
<tr><td class="paramname">runNameTemplateList</td><td></td></tr>
<tr><td class="paramname">instrument</td><td></td></tr>
<tr><td class="paramname">year</td><td></td></tr>
<tr><td class="paramname">run</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PFindRun_8cpp_source.html#l00056">56</a> of file <a class="el" href="PFindRun_8cpp_source.html">PFindRun.cpp</a>.</p>
<p class="reference">References <a class="el" href="PFindRun_8h_source.html#l00145">fFileFormat</a>, <a class="el" href="PFindRun_8h_source.html#l00142">fInstrument</a>, <a class="el" href="PFindRun_8h_source.html#l00140">fPath</a>, <a class="el" href="PFindRun_8h_source.html#l00144">fRun</a>, <a class="el" href="PFindRun_8h_source.html#l00141">fRunNameTemplateList</a>, and <a class="el" href="PFindRun_8h_source.html#l00143">fYear</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af191829d46f7ecf9076855aa8dd78bb0" name="af191829d46f7ecf9076855aa8dd78bb0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af191829d46f7ecf9076855aa8dd78bb0">&#9670;&#160;</a></span>CreatePathName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TString PFindRun::CreatePathName </td>
<td>(</td>
<td class="paramtype">const TString</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const TString</td> <td class="paramname"><span class="paramname"><em>runNameTemplate</em></span>&#160;)</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>Generates full file path by substituting template placeholders. </p>
<p><a class="el" href="#af191829d46f7ecf9076855aa8dd78bb0" title="Generates full file path by substituting template placeholders.">PFindRun::CreatePathName</a>.</p>
<p>Internal helper that replaces year and run number placeholders in a template with actual values. Supports variable-length run number formatting (2-9 digits).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Base directory path </td></tr>
<tr><td class="paramname">runNameTemplate</td><td>Template string with placeholders (yyyy%, yy%, rr...r%) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Full path with placeholders substituted (e.g., "/data/gps/2023/02425.root")</dd></dl>
<dl class="section user"><dt>Template Examples:</dt><dd><ul>
<li>"%yyyy%/%rrrrr%.root" with year=2023, run=42 → "2023/00042.root"</li>
<li>"run_%yy%_%rrr%.nxs" with year=2023, run=425 → "run_23_425.nxs"</li>
</ul>
</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td></td></tr>
<tr><td class="paramname">runNameTemplate</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p class="definition">Definition at line <a class="el" href="PFindRun_8cpp_source.html#l00089">89</a> of file <a class="el" href="PFindRun_8cpp_source.html">PFindRun.cpp</a>.</p>
<p class="reference">References <a class="el" href="PFindRun_8h_source.html#l00144">fRun</a>, and <a class="el" href="PFindRun_8h_source.html#l00143">fYear</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00133">FoundPathName()</a>.</p>
</div>
</div>
<a id="a6522eccd3a89008f05b80e9b7a343999" name="a6522eccd3a89008f05b80e9b7a343999"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6522eccd3a89008f05b80e9b7a343999">&#9670;&#160;</a></span>DumpTemplateList()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void PFindRun::DumpTemplateList </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Debug utility - Prints current search configuration to stdout. </p>
<p><a class="el" href="#a6522eccd3a89008f05b80e9b7a343999" title="Debug utility - Prints current search configuration to stdout.">PFindRun::DumpTemplateList</a>.</p>
<p>Outputs instrument name, year, run number, and all available templates with their patterns. Useful for troubleshooting path resolution issues. </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8cpp_source.html#l00069">69</a> of file <a class="el" href="PFindRun_8cpp_source.html">PFindRun.cpp</a>.</p>
<p class="reference">References <a class="el" href="PFindRun_8h_source.html#l00142">fInstrument</a>, <a class="el" href="PFindRun_8h_source.html#l00144">fRun</a>, <a class="el" href="PFindRun_8h_source.html#l00141">fRunNameTemplateList</a>, and <a class="el" href="PFindRun_8h_source.html#l00143">fYear</a>.</p>
</div>
</div>
<a id="ac80cae699db88f45a24fd087b77d9a39" name="ac80cae699db88f45a24fd087b77d9a39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac80cae699db88f45a24fd087b77d9a39">&#9670;&#160;</a></span>FoundPathName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool_t PFindRun::FoundPathName </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Searches for the run file using configured templates and paths. </p>
<p><a class="el" href="#ac80cae699db88f45a24fd087b77d9a39" title="Searches for the run file using configured templates and paths.">PFindRun::FoundPathName</a>.</p>
<p>Iterates through all paths containing the instrument name, applies matching templates, and checks filesystem for file existence. If a file format is specified, only files with matching extensions are considered.</p>
<dl class="section return"><dt>Returns</dt><dd>true if file was found, false otherwise</dd></dl>
<dl class="section user"><dt>Search Algorithm:</dt><dd><ol type="1">
<li>Filter paths containing instrument name</li>
<li>For each matching path, try all templates for that instrument</li>
<li>Substitute year/run placeholders to create full path</li>
<li>Check if file exists on filesystem</li>
<li>If file_format specified, verify extension matches</li>
</ol>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>After successful search, use <a class="el" href="#aef0d2bbab3475c7599ba624d9005d73b" title="Returns the full path to the found run file.">GetPathName()</a> to retrieve the full path.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p class="definition">Definition at line <a class="el" href="PFindRun_8cpp_source.html#l00133">133</a> of file <a class="el" href="PFindRun_8cpp_source.html">PFindRun.cpp</a>.</p>
<p class="reference">References <a class="el" href="PFindRun_8cpp_source.html#l00089">CreatePathName()</a>, <a class="el" href="PFindRun_8h_source.html#l00145">fFileFormat</a>, <a class="el" href="PFindRun_8h_source.html#l00142">fInstrument</a>, <a class="el" href="PFindRun_8h_source.html#l00140">fPath</a>, <a class="el" href="PFindRun_8h_source.html#l00146">fPathName</a>, and <a class="el" href="PFindRun_8h_source.html#l00141">fRunNameTemplateList</a>.</p>
<p class="reference">Referenced by <a class="el" href="addRun_8cpp_source.html#l00364">main()</a>.</p>
</div>
</div>
<a id="aef0d2bbab3475c7599ba624d9005d73b" name="aef0d2bbab3475c7599ba624d9005d73b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef0d2bbab3475c7599ba624d9005d73b">&#9670;&#160;</a></span>GetPathName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TString PFindRun::GetPathName </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>Returns the full path to the found run file. </p>
<dl class="section return"><dt>Returns</dt><dd>Full filesystem path including filename and extension, or empty string if no file was found (call <a class="el" href="#ac80cae699db88f45a24fd087b77d9a39" title="Searches for the run file using configured templates and paths.">FoundPathName()</a> first). </dd></dl>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00128">128</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">References <a class="el" href="PFindRun_8h_source.html#l00146">fPathName</a>.</p>
<p class="reference">Referenced by <a class="el" href="addRun_8cpp_source.html#l00364">main()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ab3cc44abd696e2be144bbd4bfe309fd0" name="ab3cc44abd696e2be144bbd4bfe309fd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab3cc44abd696e2be144bbd4bfe309fd0">&#9670;&#160;</a></span>fFileFormat</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TString PFindRun::fFileFormat {&quot;&quot;}</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>Optional file format filter (empty = any) </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00145">145</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00133">FoundPathName()</a>, and <a class="el" href="PFindRun_8cpp_source.html#l00056">PFindRun()</a>.</p>
</div>
</div>
<a id="a1d3e9ae32d28d4df255e770f01e98fb4" name="a1d3e9ae32d28d4df255e770f01e98fb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3e9ae32d28d4df255e770f01e98fb4">&#9670;&#160;</a></span>fInstrument</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TString PFindRun::fInstrument {&quot;&quot;}</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>Target instrument name (e.g., "GPS", "LEM") </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00142">142</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00069">DumpTemplateList()</a>, <a class="el" href="PFindRun_8cpp_source.html#l00133">FoundPathName()</a>, and <a class="el" href="PFindRun_8cpp_source.html#l00056">PFindRun()</a>.</p>
</div>
</div>
<a id="a7c834ebdce8739bd2f7437bf1ce167d4" name="a7c834ebdce8739bd2f7437bf1ce167d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c834ebdce8739bd2f7437bf1ce167d4">&#9670;&#160;</a></span>fPath</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="PMusr_8h.html#ae50e503cc0f1bbc1fda5b86735ea9983">PStringVector</a> PFindRun::fPath</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>Search paths for data files. </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00140">140</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00133">FoundPathName()</a>, <a class="el" href="PFindRun_8cpp_source.html#l00040">PFindRun()</a>, and <a class="el" href="PFindRun_8cpp_source.html#l00056">PFindRun()</a>.</p>
</div>
</div>
<a id="a1217b7ae5766231c388a2a522882ffd5" name="a1217b7ae5766231c388a2a522882ffd5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1217b7ae5766231c388a2a522882ffd5">&#9670;&#160;</a></span>fPathName</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">TString PFindRun::fPathName {&quot;&quot;}</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>Resolved full path (empty until found) </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00146">146</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00133">FoundPathName()</a>, and <a class="el" href="PFindRun_8h_source.html#l00128">GetPathName()</a>.</p>
</div>
</div>
<a id="aa3c0970f0b6d9d3ffd5034c507d72061" name="aa3c0970f0b6d9d3ffd5034c507d72061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3c0970f0b6d9d3ffd5034c507d72061">&#9670;&#160;</a></span>fRun</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Int_t PFindRun::fRun {-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>Run number (-1 if not specified) </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00144">144</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00089">CreatePathName()</a>, <a class="el" href="PFindRun_8cpp_source.html#l00069">DumpTemplateList()</a>, and <a class="el" href="PFindRun_8cpp_source.html#l00056">PFindRun()</a>.</p>
</div>
</div>
<a id="ae2d288d577eaf97a4d5cce10cfc0afb8" name="ae2d288d577eaf97a4d5cce10cfc0afb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2d288d577eaf97a4d5cce10cfc0afb8">&#9670;&#160;</a></span>fRunNameTemplateList</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="PMusr_8h.html#a01ff11ebda5d1a9096e8c9a65d085778">PRunNameTemplateList</a> PFindRun::fRunNameTemplateList</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>Template patterns per instrument. </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00141">141</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00069">DumpTemplateList()</a>, <a class="el" href="PFindRun_8cpp_source.html#l00133">FoundPathName()</a>, <a class="el" href="PFindRun_8cpp_source.html#l00040">PFindRun()</a>, and <a class="el" href="PFindRun_8cpp_source.html#l00056">PFindRun()</a>.</p>
</div>
</div>
<a id="a0bf08210c9dcc095c936e231e44c0a9b" name="a0bf08210c9dcc095c936e231e44c0a9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bf08210c9dcc095c936e231e44c0a9b">&#9670;&#160;</a></span>fYear</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Int_t PFindRun::fYear {-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>Run year (-1 if not specified) </p>
<p class="definition">Definition at line <a class="el" href="PFindRun_8h_source.html#l00143">143</a> of file <a class="el" href="PFindRun_8h_source.html">PFindRun.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PFindRun_8cpp_source.html#l00089">CreatePathName()</a>, <a class="el" href="PFindRun_8cpp_source.html#l00069">DumpTemplateList()</a>, and <a class="el" href="PFindRun_8cpp_source.html#l00056">PFindRun()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/workspace/LMU/musrfit/src/include/<a class="el" href="PFindRun_8h_source.html">PFindRun.h</a></li>
<li>/workspace/LMU/musrfit/src/classes/<a class="el" href="PFindRun_8cpp_source.html">PFindRun.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="classPFindRun.html">PFindRun</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>
Reference in New Issue View Git Blame Copy Permalink