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

709 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: PRgeHandler 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('classPRgeHandler.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="classPRgeHandler-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PRgeHandler Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Manager for TrimSP range distribution data.
<a href="#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for PRgeHandler:</div>
<div class="dyncontent">
<div class="center"><img src="classPRgeHandler__inherit__graph.png" border="0" usemap="#aPRgeHandler_inherit__map" alt="Inheritance graph"/></div>
<map name="aPRgeHandler_inherit__map" id="aPRgeHandler_inherit__map">
<area shape="rect" title="Manager for TrimSP range distribution data." alt="" coords="5,81,107,109"/>
<area shape="rect" title=" " alt="" coords="22,5,90,33"/>
<area shape="poly" title=" " alt="" coords="59,49,59,81,53,81,53,49"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for PRgeHandler:</div>
<div class="dyncontent">
<div class="center"><img src="classPRgeHandler__coll__graph.png" border="0" usemap="#aPRgeHandler_coll__map" alt="Collaboration graph"/></div>
<map name="aPRgeHandler_coll__map" id="aPRgeHandler_coll__map">
<area shape="rect" title="Manager for TrimSP range distribution data." alt="" coords="5,81,107,109"/>
<area shape="rect" title=" " alt="" coords="22,5,90,33"/>
<area shape="poly" title=" " alt="" coords="59,49,59,81,53,81,53,49"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:a37bef4a85373acc6baaa2b76e7b0a7da" id="r_a37bef4a85373acc6baaa2b76e7b0a7da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a37bef4a85373acc6baaa2b76e7b0a7da">PRgeHandler</a> (std::string fln=&quot;&quot;)</td></tr>
<tr class="memdesc:a37bef4a85373acc6baaa2b76e7b0a7da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that loads TrimSP data from XML configuration. <br /></td></tr>
<tr class="separator:a37bef4a85373acc6baaa2b76e7b0a7da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e4970183a4f5970fbdc7d7d044d1ef5" id="r_a8e4970183a4f5970fbdc7d7d044d1ef5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8e4970183a4f5970fbdc7d7d044d1ef5">~PRgeHandler</a> ()</td></tr>
<tr class="memdesc:a8e4970183a4f5970fbdc7d7d044d1ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a8e4970183a4f5970fbdc7d7d044d1ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13845e41ba6d14ebbd41787ad0081767" id="r_a13845e41ba6d14ebbd41787ad0081767"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a13845e41ba6d14ebbd41787ad0081767">IsValid</a> ()</td></tr>
<tr class="memdesc:a13845e41ba6d14ebbd41787ad0081767"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns validity status. <br /></td></tr>
<tr class="separator:a13845e41ba6d14ebbd41787ad0081767"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0f50874b87f37f2609f5a68d5f9f3f9" id="r_ae0f50874b87f37f2609f5a68d5f9f3f9"><td class="memItemLeft" align="right" valign="top">virtual UInt_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0f50874b87f37f2609f5a68d5f9f3f9">GetNoOfRgeDataSets</a> ()</td></tr>
<tr class="memdesc:ae0f50874b87f37f2609f5a68d5f9f3f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns number of loaded RGE data sets. <br /></td></tr>
<tr class="separator:ae0f50874b87f37f2609f5a68d5f9f3f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab42b903cbbfad007cdeee7c7f9780bf7" id="r_ab42b903cbbfad007cdeee7c7f9780bf7"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="PRgeHandler_8h.html#a8c1abb7d1533e3cc4f415901ccc7707d">PRgeDataList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab42b903cbbfad007cdeee7c7f9780bf7">GetRgeData</a> ()</td></tr>
<tr class="memdesc:ab42b903cbbfad007cdeee7c7f9780bf7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns all RGE data sets. <br /></td></tr>
<tr class="separator:ab42b903cbbfad007cdeee7c7f9780bf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73057e513894759bf48031d8b2b7e060" id="r_a73057e513894759bf48031d8b2b7e060"><td class="memItemLeft" align="right" valign="top">virtual Double_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73057e513894759bf48031d8b2b7e060">GetZmax</a> (const Double_t energy)</td></tr>
<tr class="memdesc:a73057e513894759bf48031d8b2b7e060"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns maximum penetration depth for a given energy. <br /></td></tr>
<tr class="separator:a73057e513894759bf48031d8b2b7e060"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a031cd43d71bac0c98511e2183f0770" id="r_a4a031cd43d71bac0c98511e2183f0770"><td class="memItemLeft" align="right" valign="top">virtual Double_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4a031cd43d71bac0c98511e2183f0770">GetZmax</a> (const Int_t idx)</td></tr>
<tr class="memdesc:a4a031cd43d71bac0c98511e2183f0770"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns maximum penetration depth for a data set index. <br /></td></tr>
<tr class="separator:a4a031cd43d71bac0c98511e2183f0770"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c373f0ed98fea07664ab87fb07cfa65" id="r_a1c373f0ed98fea07664ab87fb07cfa65"><td class="memItemLeft" align="right" valign="top">virtual Double_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c373f0ed98fea07664ab87fb07cfa65">Get_n</a> (const Double_t energy, const Double_t z)</td></tr>
<tr class="memdesc:a1c373f0ed98fea07664ab87fb07cfa65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns normalized particle distribution at given energy and depth. <br /></td></tr>
<tr class="separator:a1c373f0ed98fea07664ab87fb07cfa65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d0ba2d53aebaf857218a1e783c58567" id="r_a6d0ba2d53aebaf857218a1e783c58567"><td class="memItemLeft" align="right" valign="top">virtual Double_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6d0ba2d53aebaf857218a1e783c58567">Get_n</a> (const Int_t idx, const Double_t z)</td></tr>
<tr class="memdesc:a6d0ba2d53aebaf857218a1e783c58567"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns normalized particle distribution at given index and depth. <br /></td></tr>
<tr class="separator:a6d0ba2d53aebaf857218a1e783c58567"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8501988b67918560b9f45de772a5ff50" id="r_a8501988b67918560b9f45de772a5ff50"><td class="memItemLeft" align="right" valign="top">virtual Int_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8501988b67918560b9f45de772a5ff50">GetEnergyIndex</a> (const Double_t energy)</td></tr>
<tr class="memdesc:a8501988b67918560b9f45de772a5ff50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the data set index for a given energy. <br /></td></tr>
<tr class="separator:a8501988b67918560b9f45de772a5ff50"><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:a5f6e9281c624ee022988394ab1de7ed5" id="r_a5f6e9281c624ee022988394ab1de7ed5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f6e9281c624ee022988394ab1de7ed5">ReadRgeFile</a> (const std::string fln, <a class="el" href="structPRgeData.html">PRgeData</a> &amp;data)</td></tr>
<tr class="memdesc:a5f6e9281c624ee022988394ab1de7ed5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a single RGE file and populates a <a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> structure. <br /></td></tr>
<tr class="separator:a5f6e9281c624ee022988394ab1de7ed5"><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:a6a5bef5b0a14d7250ccac8b9ad3c8414" id="r_a6a5bef5b0a14d7250ccac8b9ad3c8414"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6a5bef5b0a14d7250ccac8b9ad3c8414">fValid</a> {false}</td></tr>
<tr class="memdesc:a6a5bef5b0a14d7250ccac8b9ad3c8414"><td class="mdescLeft">&#160;</td><td class="mdescRight">Validity flag (true if all RGE files loaded successfully) <br /></td></tr>
<tr class="separator:a6a5bef5b0a14d7250ccac8b9ad3c8414"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad249040cc85b3d4ec0905bebc4eb6726" id="r_ad249040cc85b3d4ec0905bebc4eb6726"><td class="memItemLeft" align="right" valign="top"><a class="el" href="PRgeHandler_8h.html#a8c1abb7d1533e3cc4f415901ccc7707d">PRgeDataList</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad249040cc85b3d4ec0905bebc4eb6726">fData</a></td></tr>
<tr class="memdesc:ad249040cc85b3d4ec0905bebc4eb6726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Collection of RGE data sets (one per energy) <br /></td></tr>
<tr class="separator:ad249040cc85b3d4ec0905bebc4eb6726"><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>Manager for TrimSP range distribution data. </p>
<p><a class="el" href="classPRgeHandler.html" title="Manager for TrimSP range distribution data.">PRgeHandler</a> reads and manages muon/particle implantation depth profiles calculated by TrimSP (Transport of Ions in Matter - Stopping and Range). It provides access to:</p><ul>
<li>Particle implantation depth distributions n(E,z)</li>
<li>Normalized distributions nn(E,z) where ∫nn(z)dz = 1</li>
<li>Maximum penetration depths for different energies</li>
</ul>
<p>The class loads RGE files specified in an XML configuration file, which can contain data for multiple implantation energies. RGE files contain depth (in Ångström) vs. particle count data from TrimSP simulations.</p>
<dl class="section user"><dt>Typical Usage:</dt><dd><div class="fragment"><div class="line"><a class="code hl_function" href="#a37bef4a85373acc6baaa2b76e7b0a7da">PRgeHandler</a> rge(<span class="stringliteral">&quot;config.xml&quot;</span>);</div>
<div class="line"><span class="keywordflow">if</span> (rge.IsValid()) {</div>
<div class="line"> Double_t zmax = rge.GetZmax(5000.0); <span class="comment">// Max depth at 5 keV</span></div>
<div class="line"> Double_t n = rge.Get_n(5000.0, 10.0); <span class="comment">// Distribution at 5 keV, 10 nm depth</span></div>
<div class="line">}</div>
<div class="ttc" id="aclassPRgeHandler_html_a37bef4a85373acc6baaa2b76e7b0a7da"><div class="ttname"><a href="#a37bef4a85373acc6baaa2b76e7b0a7da">PRgeHandler::PRgeHandler</a></div><div class="ttdeci">PRgeHandler(std::string fln=&quot;&quot;)</div><div class="ttdoc">Constructor that loads TrimSP data from XML configuration.</div></div>
</div><!-- fragment --></dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> for the data structure holding individual distributions </dd>
<dd>
<a class="el" href="classPXmlRgeHandler.html" title="XML SAX parser handler for TrimSP configuration files.">PXmlRgeHandler</a> for XML configuration parsing </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00218">218</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a37bef4a85373acc6baaa2b76e7b0a7da" name="a37bef4a85373acc6baaa2b76e7b0a7da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a37bef4a85373acc6baaa2b76e7b0a7da">&#9670;&#160;</a></span>PRgeHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">PRgeHandler::PRgeHandler </td>
<td>(</td>
<td class="paramtype">std::string</td> <td class="paramname"><span class="paramname"><em>fln</em></span><span class="paramdefsep"> = </span><span class="paramdefval">&quot;&quot;</span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor that loads TrimSP data from XML configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fln</td><td>Path to XML configuration file (empty string for manual setup)</td></tr>
</table>
</dd>
</dl>
<p>Parses the XML file to get RGE file locations and energies, then loads all specified RGE files. Sets fValid to false if any errors occur. </p>
</div>
</div>
<a id="a8e4970183a4f5970fbdc7d7d044d1ef5" name="a8e4970183a4f5970fbdc7d7d044d1ef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e4970183a4f5970fbdc7d7d044d1ef5">&#9670;&#160;</a></span>~PRgeHandler()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual PRgeHandler::~PRgeHandler </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 class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00231">231</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1c373f0ed98fea07664ab87fb07cfa65" name="a1c373f0ed98fea07664ab87fb07cfa65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c373f0ed98fea07664ab87fb07cfa65">&#9670;&#160;</a></span>Get_n() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Double_t PRgeHandler::Get_n </td>
<td>(</td>
<td class="paramtype">const Double_t</td> <td class="paramname"><span class="paramname"><em>energy</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Double_t</td> <td class="paramname"><span class="paramname"><em>z</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns normalized particle distribution at given energy and depth. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">energy</td><td>Implantation energy in eV </td></tr>
<tr><td class="paramname">z</td><td>Depth in nm </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Normalized distribution nn(E,z), or 0.0 if out of range</dd></dl>
<p>Uses linear interpolation between data points. The normalization ensures that ∫nn(z)dz = 1 over the entire depth range.</p>
<p>Searches for a data set matching the specified energy (within 0.9 keV tolerance) and returns the normalized distribution value at depth z.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">energy</td><td>Implantation energy in eV </td></tr>
<tr><td class="paramname">z</td><td>Depth in nm </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Normalized distribution nn(E,z), or 0.0 if energy not found or z out of range </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8cpp_source.html#l00671">671</a> of file <a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.cpp</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>, and <a class="el" href="PRgeHandler_8cpp_source.html#l00671">Get_n()</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRgeHandler_8cpp_source.html#l00671">Get_n()</a>.</p>
</div>
</div>
<a id="a6d0ba2d53aebaf857218a1e783c58567" name="a6d0ba2d53aebaf857218a1e783c58567"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d0ba2d53aebaf857218a1e783c58567">&#9670;&#160;</a></span>Get_n() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Double_t PRgeHandler::Get_n </td>
<td>(</td>
<td class="paramtype">const Int_t</td> <td class="paramname"><span class="paramname"><em>idx</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const Double_t</td> <td class="paramname"><span class="paramname"><em>z</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns normalized particle distribution at given index and depth. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>Data set index (0 to <a class="el" href="#ae0f50874b87f37f2609f5a68d5f9f3f9" title="Returns number of loaded RGE data sets.">GetNoOfRgeDataSets()</a>-1) </td></tr>
<tr><td class="paramname">z</td><td>Depth in nm </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Normalized distribution nn(idx,z), or 0.0 if out of range</dd></dl>
<p>Uses linear interpolation between data points. The normalization ensures that ∫nn(z)dz = 1 over the entire depth range.</p>
<p>Uses linear interpolation between adjacent data points to compute the distribution value at the requested depth. The normalization ensures that ∫nn(z)dz = 1 over the entire depth range.</p>
<p>Special handling for z near zero: extrapolates linearly from first data point.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>Data set index (0 to <a class="el" href="#ae0f50874b87f37f2609f5a68d5f9f3f9" title="Returns number of loaded RGE data sets.">GetNoOfRgeDataSets()</a>-1) </td></tr>
<tr><td class="paramname">z</td><td>Depth in nm </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Normalized distribution nn(idx,z), or 0.0 if idx or z out of range </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8cpp_source.html#l00702">702</a> of file <a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.cpp</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>, and <a class="el" href="PRgeHandler_8cpp_source.html#l00622">GetZmax()</a>.</p>
</div>
</div>
<a id="a8501988b67918560b9f45de772a5ff50" name="a8501988b67918560b9f45de772a5ff50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8501988b67918560b9f45de772a5ff50">&#9670;&#160;</a></span>GetEnergyIndex()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Int_t PRgeHandler::GetEnergyIndex </td>
<td>(</td>
<td class="paramtype">const Double_t</td> <td class="paramname"><span class="paramname"><em>energy</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Finds the data set index for a given energy. </p>
<p>Finds the data set index corresponding to a given implantation energy.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">energy</td><td>Implantation energy in eV </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Data set index, or -1 if energy not found</dd></dl>
<p>Uses tolerance of 0.9 keV for matching energies.</p>
<p>Searches through loaded data sets for a matching energy value using a tolerance of 0.9 keV (i.e., |E_data - E_query| &lt; 0.9 keV).</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">energy</td><td>Implantation energy in eV </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Data set index (0 to <a class="el" href="#ae0f50874b87f37f2609f5a68d5f9f3f9" title="Returns number of loaded RGE data sets.">GetNoOfRgeDataSets()</a>-1), or -1 if not found </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8cpp_source.html#l00742">742</a> of file <a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.cpp</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>.</p>
</div>
</div>
<a id="ae0f50874b87f37f2609f5a68d5f9f3f9" name="ae0f50874b87f37f2609f5a68d5f9f3f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0f50874b87f37f2609f5a68d5f9f3f9">&#9670;&#160;</a></span>GetNoOfRgeDataSets()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual UInt_t PRgeHandler::GetNoOfRgeDataSets </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 class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns number of loaded RGE data sets. </p>
<dl class="section return"><dt>Returns</dt><dd>Number of energy data sets (one per energy value) </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00243">243</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>.</p>
</div>
</div>
<a id="ab42b903cbbfad007cdeee7c7f9780bf7" name="ab42b903cbbfad007cdeee7c7f9780bf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab42b903cbbfad007cdeee7c7f9780bf7">&#9670;&#160;</a></span>GetRgeData()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="PRgeHandler_8h.html#a8c1abb7d1533e3cc4f415901ccc7707d">PRgeDataList</a> PRgeHandler::GetRgeData </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 class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns all RGE data sets. </p>
<dl class="section return"><dt>Returns</dt><dd>Vector of all loaded <a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> structures </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00249">249</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>.</p>
</div>
</div>
<a id="a73057e513894759bf48031d8b2b7e060" name="a73057e513894759bf48031d8b2b7e060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73057e513894759bf48031d8b2b7e060">&#9670;&#160;</a></span>GetZmax() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Double_t PRgeHandler::GetZmax </td>
<td>(</td>
<td class="paramtype">const Double_t</td> <td class="paramname"><span class="paramname"><em>energy</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns maximum penetration depth for a given energy. </p>
<p>Returns maximum penetration depth for a given implantation energy.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">energy</td><td>Implantation energy in eV </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Maximum depth in nm, or -1 if energy not found</dd></dl>
<p>Searches for a data set matching the specified energy (within 0.9 keV tolerance) and returns its maximum depth value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">energy</td><td>Implantation energy in eV </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Maximum depth in nm, or -1 if energy not found </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8cpp_source.html#l00622">622</a> of file <a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.cpp</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>, and <a class="el" href="PRgeHandler_8cpp_source.html#l00622">GetZmax()</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRgeHandler_8cpp_source.html#l00702">Get_n()</a>, and <a class="el" href="PRgeHandler_8cpp_source.html#l00622">GetZmax()</a>.</p>
</div>
</div>
<a id="a4a031cd43d71bac0c98511e2183f0770" name="a4a031cd43d71bac0c98511e2183f0770"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a031cd43d71bac0c98511e2183f0770">&#9670;&#160;</a></span>GetZmax() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Double_t PRgeHandler::GetZmax </td>
<td>(</td>
<td class="paramtype">const Int_t</td> <td class="paramname"><span class="paramname"><em>idx</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns maximum penetration depth for a data set index. </p>
<p>Returns maximum penetration depth for a given data set index.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>Data set index (0 to <a class="el" href="#ae0f50874b87f37f2609f5a68d5f9f3f9" title="Returns number of loaded RGE data sets.">GetNoOfRgeDataSets()</a>-1) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Maximum depth in nm, or -1 if idx out of range</dd></dl>
<p>Returns the last depth value from the depth vector, which represents the maximum penetration depth for this energy.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">idx</td><td>Data set index (0 to <a class="el" href="#ae0f50874b87f37f2609f5a68d5f9f3f9" title="Returns number of loaded RGE data sets.">GetNoOfRgeDataSets()</a>-1) </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Maximum depth in nm, or -1 if idx out of range </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8cpp_source.html#l00650">650</a> of file <a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.cpp</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00298">fData</a>.</p>
</div>
</div>
<a id="a13845e41ba6d14ebbd41787ad0081767" name="a13845e41ba6d14ebbd41787ad0081767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13845e41ba6d14ebbd41787ad0081767">&#9670;&#160;</a></span>IsValid()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool PRgeHandler::IsValid </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 class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns validity status. </p>
<dl class="section return"><dt>Returns</dt><dd>True if all RGE files loaded successfully, false if errors occurred </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00237">237</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00297">fValid</a>.</p>
</div>
</div>
<a id="a5f6e9281c624ee022988394ab1de7ed5" name="a5f6e9281c624ee022988394ab1de7ed5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f6e9281c624ee022988394ab1de7ed5">&#9670;&#160;</a></span>ReadRgeFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PRgeHandler::ReadRgeFile </td>
<td>(</td>
<td class="paramtype">const std::string</td> <td class="paramname"><span class="paramname"><em>fln</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structPRgeData.html">PRgeData</a> &amp;</td> <td class="paramname"><span class="paramname"><em>data</em></span>&#160;)</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span><span class="mlabel virtual">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a single RGE file and populates a <a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> structure. </p>
<p>Reads a single TrimSP .rge file and populates a <a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> structure.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fln</td><td>Path to the .rge file </td></tr>
<tr><td class="paramname">data</td><td><a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> structure to populate </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false on error</dd></dl>
<p>Parses the two-column format (depth amplitude) from TrimSP output. Converts depth from Ångström to nanometers.</p>
<p>Parses the two-column format from TrimSP output:</p><ul>
<li>Column 1: Depth in Ångström (converted to nm by dividing by 10)</li>
<li>Column 2: Number of particles (amplitude)</li>
</ul>
<p>Skips empty lines and non-numeric lines. Performs extensive validation on numeric values with detailed error messages.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fln</td><td>Path to the .rge file </td></tr>
<tr><td class="paramname">data</td><td><a class="el" href="structPRgeData.html" title="Data structure for a single TrimSP range distribution at a given energy.">PRgeData</a> structure to populate with depth and amplitude vectors </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if file cannot be opened or contains invalid data </dd></dl>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8cpp_source.html#l00506">506</a> of file <a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.cpp</a>.</p>
<p class="reference">References <a class="el" href="PRgeHandler_8h_source.html#l00057">PRgeData::amplitude</a>, <a class="el" href="PRgeHandler_8h_source.html#l00056">PRgeData::depth</a>, and <a class="el" href="PRgeHandler_8h_source.html#l00297">fValid</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRgeHandler_8cpp_source.html#l00359">ClassImp()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad249040cc85b3d4ec0905bebc4eb6726" name="ad249040cc85b3d4ec0905bebc4eb6726"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad249040cc85b3d4ec0905bebc4eb6726">&#9670;&#160;</a></span>fData</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="PRgeHandler_8h.html#a8c1abb7d1533e3cc4f415901ccc7707d">PRgeDataList</a> PRgeHandler::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>Collection of RGE data sets (one per energy) </p>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00298">298</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRgeHandler_8cpp_source.html#l00359">ClassImp()</a>, <a class="el" href="PRgeHandler_8cpp_source.html#l00671">Get_n()</a>, <a class="el" href="PRgeHandler_8cpp_source.html#l00702">Get_n()</a>, <a class="el" href="PRgeHandler_8cpp_source.html#l00742">GetEnergyIndex()</a>, <a class="el" href="PRgeHandler_8h_source.html#l00243">GetNoOfRgeDataSets()</a>, <a class="el" href="PRgeHandler_8h_source.html#l00249">GetRgeData()</a>, <a class="el" href="PRgeHandler_8cpp_source.html#l00622">GetZmax()</a>, and <a class="el" href="PRgeHandler_8cpp_source.html#l00650">GetZmax()</a>.</p>
</div>
</div>
<a id="a6a5bef5b0a14d7250ccac8b9ad3c8414" name="a6a5bef5b0a14d7250ccac8b9ad3c8414"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a5bef5b0a14d7250ccac8b9ad3c8414">&#9670;&#160;</a></span>fValid</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool PRgeHandler::fValid {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Validity flag (true if all RGE files loaded successfully) </p>
<p class="definition">Definition at line <a class="el" href="PRgeHandler_8h_source.html#l00297">297</a> of file <a class="el" href="PRgeHandler_8h_source.html">PRgeHandler.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PRgeHandler_8cpp_source.html#l00359">ClassImp()</a>, <a class="el" href="PRgeHandler_8h_source.html#l00237">IsValid()</a>, and <a class="el" href="PRgeHandler_8cpp_source.html#l00506">ReadRgeFile()</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="PRgeHandler_8h_source.html">PRgeHandler.h</a></li>
<li>/workspace/LMU/musrfit/src/classes/<a class="el" href="PRgeHandler_8cpp_source.html">PRgeHandler.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="classPRgeHandler.html">PRgeHandler</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