648 lines
39 KiB
HTML
648 lines
39 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>musredit: PGetSingleHistoRunBlockDialog 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="resize.js"></script>
|
|
<script type="text/javascript" src="cookie.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.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">musredit<span id="projectnumber"> 1.0.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.13.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search',false);
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function(){ initResizable(false); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-slots">Private Slots</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classPGetSingleHistoRunBlockDialog-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PGetSingleHistoRunBlockDialog Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Dialog for creating single histogram type RUN blocks in msr files.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html">PGetSingleHistoRunBlockDialog.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PGetSingleHistoRunBlockDialog:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPGetSingleHistoRunBlockDialog__inherit__graph.png" border="0" usemap="#aPGetSingleHistoRunBlockDialog_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aPGetSingleHistoRunBlockDialog_inherit__map" id="aPGetSingleHistoRunBlockDialog_inherit__map">
|
|
<area shape="rect" title="Dialog for creating single histogram type RUN blocks in msr files." alt="" coords="10,98,226,126"/>
|
|
<area shape="rect" title=" " alt="" coords="5,14,76,42"/>
|
|
<area shape="poly" title=" " alt="" coords="65,51,108,96,104,100,61,55"/>
|
|
<area shape="rect" title=" " alt="" coords="99,5,294,50"/>
|
|
<area shape="poly" title=" " alt="" coords="167,63,132,99,129,96,164,59"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for PGetSingleHistoRunBlockDialog:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPGetSingleHistoRunBlockDialog__coll__graph.png" border="0" usemap="#aPGetSingleHistoRunBlockDialog_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aPGetSingleHistoRunBlockDialog_coll__map" id="aPGetSingleHistoRunBlockDialog_coll__map">
|
|
<area shape="rect" title="Dialog for creating single histogram type RUN blocks in msr files." alt="" coords="10,98,226,126"/>
|
|
<area shape="rect" title=" " alt="" coords="5,14,76,42"/>
|
|
<area shape="poly" title=" " alt="" coords="65,51,108,96,104,100,61,55"/>
|
|
<area shape="rect" title=" " alt="" coords="99,5,294,50"/>
|
|
<area shape="poly" title=" " alt="" coords="167,63,132,99,129,96,164,59"/>
|
|
</map>
|
|
<center><span class="legend">[<a 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:ab2dd62958715c27d365268c0f325e11c" id="r_ab2dd62958715c27d365268c0f325e11c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2dd62958715c27d365268c0f325e11c">PGetSingleHistoRunBlockDialog</a> (const QString helpUrl="", const bool lifetimeCorrection=true)</td></tr>
|
|
<tr class="memdesc:ab2dd62958715c27d365268c0f325e11c"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the single histogram RUN block dialog. <br /></td></tr>
|
|
<tr class="separator:ab2dd62958715c27d365268c0f325e11c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">RUN Block Generators</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>Methods to generate formatted msr-file text for each parameter. </p>
|
|
</div></td></tr>
|
|
<tr class="memitem:acc43c5fcbcc5de5b03a50aaee77af4f1" id="r_acc43c5fcbcc5de5b03a50aaee77af4f1"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#acc43c5fcbcc5de5b03a50aaee77af4f1">getRunHeaderInfo</a> ()</td></tr>
|
|
<tr class="memdesc:acc43c5fcbcc5de5b03a50aaee77af4f1"><td class="mdescLeft"> </td><td class="mdescRight">Generates the RUN header line for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:acc43c5fcbcc5de5b03a50aaee77af4f1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a934f23be0f7ff894456ae0e6219038ed" id="r_a934f23be0f7ff894456ae0e6219038ed"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a934f23be0f7ff894456ae0e6219038ed">getMap</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:a934f23be0f7ff894456ae0e6219038ed"><td class="mdescLeft"> </td><td class="mdescRight">Generates the parameter map line for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:a934f23be0f7ff894456ae0e6219038ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36ea49abead4b099688a556be4ad24fe" id="r_a36ea49abead4b099688a556be4ad24fe"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a36ea49abead4b099688a556be4ad24fe">getForward</a> ()</td></tr>
|
|
<tr class="memdesc:a36ea49abead4b099688a556be4ad24fe"><td class="mdescLeft"> </td><td class="mdescRight">Gets the forward histogram specification line. <br /></td></tr>
|
|
<tr class="separator:a36ea49abead4b099688a556be4ad24fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a145fe7153745b3d30d1b5604c80ac8d2" id="r_a145fe7153745b3d30d1b5604c80ac8d2"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a145fe7153745b3d30d1b5604c80ac8d2">getNorm</a> ()</td></tr>
|
|
<tr class="memdesc:a145fe7153745b3d30d1b5604c80ac8d2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the normalization parameter line. <br /></td></tr>
|
|
<tr class="separator:a145fe7153745b3d30d1b5604c80ac8d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa0a74e26592271b08297622a6e36eeb5" id="r_aa0a74e26592271b08297622a6e36eeb5"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa0a74e26592271b08297622a6e36eeb5">getData</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:aa0a74e26592271b08297622a6e36eeb5"><td class="mdescLeft"> </td><td class="mdescRight">Generates the data range specification for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:aa0a74e26592271b08297622a6e36eeb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac611ce704cf44f641b6fabe98af2e859" id="r_ac611ce704cf44f641b6fabe98af2e859"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac611ce704cf44f641b6fabe98af2e859">getBackground</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:ac611ce704cf44f641b6fabe98af2e859"><td class="mdescLeft"> </td><td class="mdescRight">Generates the background specification for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:ac611ce704cf44f641b6fabe98af2e859"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27d8b4d78984d64d0b286a9d05ec80f5" id="r_a27d8b4d78984d64d0b286a9d05ec80f5"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a27d8b4d78984d64d0b286a9d05ec80f5">getFitRange</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:a27d8b4d78984d64d0b286a9d05ec80f5"><td class="mdescLeft"> </td><td class="mdescRight">Generates the fit range specification for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:a27d8b4d78984d64d0b286a9d05ec80f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a89a3bfce05d9eb19a6ca62b465aa6543" id="r_a89a3bfce05d9eb19a6ca62b465aa6543"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a89a3bfce05d9eb19a6ca62b465aa6543">getPacking</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:a89a3bfce05d9eb19a6ca62b465aa6543"><td class="mdescLeft"> </td><td class="mdescRight">Generates the packing (rebinning) specification for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:a89a3bfce05d9eb19a6ca62b465aa6543"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aae5c4e629c666fe73ed000218345b61e" id="r_aae5c4e629c666fe73ed000218345b61e"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#aae5c4e629c666fe73ed000218345b61e">getT0</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:aae5c4e629c666fe73ed000218345b61e"><td class="mdescLeft"> </td><td class="mdescRight">Generates the T0 (time zero) specification for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:aae5c4e629c666fe73ed000218345b61e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3073ca5137d99bdaf3e6428708a27ed" id="r_ad3073ca5137d99bdaf3e6428708a27ed"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3073ca5137d99bdaf3e6428708a27ed">getMuonLifetimeParam</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:ad3073ca5137d99bdaf3e6428708a27ed"><td class="mdescLeft"> </td><td class="mdescRight">Generates the muon lifetime parameter line for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:ad3073ca5137d99bdaf3e6428708a27ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3bba2d24e0dd4e5e0664e033d8cd27c" id="r_ad3bba2d24e0dd4e5e0664e033d8cd27c"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#ad3bba2d24e0dd4e5e0664e033d8cd27c">getLifetimeCorrection</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:ad3bba2d24e0dd4e5e0664e033d8cd27c"><td class="mdescLeft"> </td><td class="mdescRight">Generates the lifetime correction flag for the single histogram block. <br /></td></tr>
|
|
<tr class="separator:ad3bba2d24e0dd4e5e0664e033d8cd27c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-slots" name="pri-slots"></a>
|
|
Private Slots</h2></td></tr>
|
|
<tr class="memitem:ac97c8663ddc3cebc6a71a3ddac3971a1" id="r_ac97c8663ddc3cebc6a71a3ddac3971a1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#ac97c8663ddc3cebc6a71a3ddac3971a1">helpContent</a> ()</td></tr>
|
|
<tr class="memdesc:ac97c8663ddc3cebc6a71a3ddac3971a1"><td class="mdescLeft"> </td><td class="mdescRight">Opens the online help for single histogram RUN blocks. <br /></td></tr>
|
|
<tr class="separator:ac97c8663ddc3cebc6a71a3ddac3971a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a76451d279752ae4eca5b6022c295922e" id="r_a76451d279752ae4eca5b6022c295922e"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a76451d279752ae4eca5b6022c295922e">fHelpUrl</a></td></tr>
|
|
<tr class="memdesc:a76451d279752ae4eca5b6022c295922e"><td class="mdescLeft"> </td><td class="mdescRight">URL to the online documentation for single histogram RUN blocks. <br /></td></tr>
|
|
<tr class="separator:a76451d279752ae4eca5b6022c295922e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Dialog for creating single histogram type RUN blocks in msr files. </p>
|
|
<p>This dialog collects all parameters needed to generate a single histogram RUN block for muon spin rotation data analysis. Single histogram fitting is used when analyzing individual detector counts rather than computing asymmetry from forward/backward detector pairs.</p>
|
|
<dl class="section user"><dt>RUN Block Parameters:</dt><dd><ul>
|
|
<li>Run file name, beamline, institute, and file format</li>
|
|
<li>Forward histogram number</li>
|
|
<li>Normalization parameter</li>
|
|
<li>Parameter map</li>
|
|
<li>Data range (in bins)</li>
|
|
<li>Background specification (fixed, fitted, or estimated from bins)</li>
|
|
<li>T0 (time zero) value</li>
|
|
<li>Fit range (in microseconds)</li>
|
|
<li>Packing/binning factor</li>
|
|
<li>Muon lifetime parameter</li>
|
|
<li>Lifetime correction flag</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section user"><dt>Generated Output Format:</dt><dd>The dialog generates msr-file formatted text blocks such as: <div class="fragment"><div class="line">RUN data001 GPS PSI ROOT (name beamline institute data-file-format)</div>
|
|
<div class="line">map 1 2 3</div>
|
|
<div class="line">forward 1</div>
|
|
<div class="line">norm 1</div>
|
|
<div class="line">data 100 8000</div>
|
|
<div class="line">background 50 100</div>
|
|
<div class="line">t0 250</div>
|
|
<div class="line">fit 0.0 10.0</div>
|
|
<div class="line">packing 1</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section user"><dt>Background Options:</dt><dd>Three mutually exclusive background specification methods:<ul>
|
|
<li><b>background</b>: Bin range for background estimation [start, end]</li>
|
|
<li><b>backgr.fix</b>: Fixed background value (counts per bin)</li>
|
|
<li><b>backgr.fit</b>: Fit parameter number for background</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPGetAsymmetryRunBlockDialog.html" title="Dialog for creating asymmetry-type RUN blocks in msr files.">PGetAsymmetryRunBlockDialog</a> For asymmetry fitting with detector pairs </dd>
|
|
<dd>
|
|
<a class="el" href="classPGetNonMusrRunBlockDialog.html" title="Dialog for creating non-muSR type RUN blocks in msr files.">PGetNonMusrRunBlockDialog</a> For non-muSR generic data </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html#l00101">101</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html">PGetSingleHistoRunBlockDialog.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="ab2dd62958715c27d365268c0f325e11c" name="ab2dd62958715c27d365268c0f325e11c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2dd62958715c27d365268c0f325e11c">◆ </a></span>PGetSingleHistoRunBlockDialog()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PGetSingleHistoRunBlockDialog::PGetSingleHistoRunBlockDialog </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString</td> <td class="paramname"><span class="paramname"><em>helpUrl</em></span><span class="paramdefsep"> = </span><span class="paramdefval">""</span>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool</td> <td class="paramname"><span class="paramname"><em>lifetimeCorrection</em></span><span class="paramdefsep"> = </span><span class="paramdefval">true</span> )</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs the single histogram RUN block dialog. </p>
|
|
<p>Initializes the dialog UI and sets up input validators for all numeric fields. The dialog is created as modal. The lifetime correction checkbox is initialized based on the provided parameter.</p>
|
|
<dl class="section user"><dt>Input Validators:</dt><dd><ul>
|
|
<li>Integer validators: histogram number, norm, data range, background range, background fit parameter, packing, t0, lifetime parameter</li>
|
|
<li>Double validators: fixed background value, fit range</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">helpUrl</td><td>URL to the online documentation for single histogram RUN blocks. Defaults to empty string if not provided. </td></tr>
|
|
<tr><td class="paramname">lifetimeCorrection</td><td>Initial state of the lifetime correction checkbox. Defaults to true (enabled). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00071">71</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac611ce704cf44f641b6fabe98af2e859" name="ac611ce704cf44f641b6fabe98af2e859"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac611ce704cf44f641b6fabe98af2e859">◆ </a></span>getBackground()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getBackground </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>valid</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the background specification for the single histogram block. </p>
|
|
<p>Creates either a "background" line (bin ranges for background estimation), "backgr.fix" line (fixed background value), or "backgr.fit" line (fit parameter for background). Only one type should be specified; if multiple are provided, the last one takes precedence.</p>
|
|
<dl class="section user"><dt>Background Types:</dt><dd><ul>
|
|
<li><b>background</b>: Two integers specifying bin range [start, end] for background estimation</li>
|
|
<li><b>backgr.fix</b>: One double specifying fixed background counts per bin</li>
|
|
<li><b>backgr.fit</b>: One integer specifying the fit parameter number for background</li>
|
|
</ul>
|
|
</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">valid</td><td>Set to true if valid background info is provided, false if no background info given (a default "background 0 10" is returned).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted background string, e.g.: "background 50 100\\n" or "backgr.fix 15.3\\n" or "backgr.fit 5\\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00196">196</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa0a74e26592271b08297622a6e36eeb5" name="aa0a74e26592271b08297622a6e36eeb5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa0a74e26592271b08297622a6e36eeb5">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>valid</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the data range specification for the single histogram block. </p>
|
|
<p>Creates the "data" line specifying the histogram bin range to be used for fitting. Both start and end bins are required.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">valid</td><td>Set to true if both data range values are provided, false if either is missing.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted data range string, e.g.: "data 100 8000\\n" Returns empty string if values are missing. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00160">160</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a27d8b4d78984d64d0b286a9d05ec80f5" name="a27d8b4d78984d64d0b286a9d05ec80f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a27d8b4d78984d64d0b286a9d05ec80f5">◆ </a></span>getFitRange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getFitRange </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>valid</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the fit range specification for the single histogram block. </p>
|
|
<p>Creates the "fit" line specifying the time range (in microseconds) over which the fit will be performed. If no fit range is provided by the user, a default range of [0.0, 10.0] is returned.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">valid</td><td>Set to true if both fit range values are provided by the user, false if using the default range.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted fit range string, e.g.: "fit 0.5 9.5\\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00240">240</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a36ea49abead4b099688a556be4ad24fe" name="a36ea49abead4b099688a556be4ad24fe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a36ea49abead4b099688a556be4ad24fe">◆ </a></span>getForward()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getForward </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>Gets the forward histogram specification line. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted "forward" line for the msr file. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html#l00119">119</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html">PGetSingleHistoRunBlockDialog.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3bba2d24e0dd4e5e0664e033d8cd27c" name="ad3bba2d24e0dd4e5e0664e033d8cd27c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3bba2d24e0dd4e5e0664e033d8cd27c">◆ </a></span>getLifetimeCorrection()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getLifetimeCorrection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>present</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the lifetime correction flag for the single histogram block. </p>
|
|
<p>Creates the "lifetimecorrection" line if the checkbox is enabled. When present, musrfit will apply muon lifetime correction to the data, effectively removing the exponential decay component from the signal.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">present</td><td>Set to true if lifetime correction is enabled, false otherwise.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>"lifetimecorrection\\n" if enabled, empty string if disabled. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00352">352</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a934f23be0f7ff894456ae0e6219038ed" name="a934f23be0f7ff894456ae0e6219038ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a934f23be0f7ff894456ae0e6219038ed">◆ </a></span>getMap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getMap </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>valid</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the parameter map line for the single histogram block. </p>
|
|
<p>The map line defines the mapping between theory function parameters and the fit parameters defined in the FITPARAMETER block. It should contain only space-separated integers.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">valid</td><td>Set to true if the map contains only digits and spaces, false if invalid characters are found.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted map string, e.g.: "map 1 2 3 4\\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00130">130</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad3073ca5137d99bdaf3e6428708a27ed" name="ad3073ca5137d99bdaf3e6428708a27ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3073ca5137d99bdaf3e6428708a27ed">◆ </a></span>getMuonLifetimeParam()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getMuonLifetimeParam </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>present</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the muon lifetime parameter line for the single histogram block. </p>
|
|
<p>Creates the "lifetime" line specifying which fit parameter contains the muon lifetime value. This is used when the muon lifetime should be fitted rather than using the fixed standard value. This parameter is optional.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">present</td><td>Set to true if a lifetime parameter was provided, false otherwise.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted lifetime string, e.g.: "lifetime 3\\n" Returns empty string if lifetime parameter is not specified. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00325">325</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a145fe7153745b3d30d1b5604c80ac8d2" name="a145fe7153745b3d30d1b5604c80ac8d2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a145fe7153745b3d30d1b5604c80ac8d2">◆ </a></span>getNorm()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getNorm </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>Gets the normalization parameter line. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted "norm" line for the msr file. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html#l00125">125</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html">PGetSingleHistoRunBlockDialog.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a89a3bfce05d9eb19a6ca62b465aa6543" name="a89a3bfce05d9eb19a6ca62b465aa6543"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a89a3bfce05d9eb19a6ca62b465aa6543">◆ </a></span>getPacking()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getPacking </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>present</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the packing (rebinning) specification for the single histogram block. </p>
|
|
<p>Creates the "packing" line specifying how many histogram bins should be combined into one. A packing of 1 means no rebinning, 2 means combine pairs of bins, etc. If no packing is provided, a default value of 1 is used.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">present</td><td>Set to true if a packing value was provided by the user, false if using the default value.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted packing string, e.g.: "packing 10\\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00270">270</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acc43c5fcbcc5de5b03a50aaee77af4f1" name="acc43c5fcbcc5de5b03a50aaee77af4f1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acc43c5fcbcc5de5b03a50aaee77af4f1">◆ </a></span>getRunHeaderInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getRunHeaderInfo </td>
|
|
<td>(</td>
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the RUN header line for the single histogram block. </p>
|
|
<p>Creates the first line of the RUN block containing the run file name, beamline identifier, institute name, and data file format. The beamline is converted to uppercase.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted RUN header string, e.g.: "RUN data001 GPS PSI ROOT (name beamline institute data-file-format)\\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00105">105</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aae5c4e629c666fe73ed000218345b61e" name="aae5c4e629c666fe73ed000218345b61e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aae5c4e629c666fe73ed000218345b61e">◆ </a></span>getT0()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::getT0 </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool &</td> <td class="paramname"><span class="paramname"><em>present</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Generates the T0 (time zero) specification for the single histogram block. </p>
|
|
<p>Creates the "t0" line specifying the time zero bin for the histogram. T0 is the bin corresponding to muon implantation time. This parameter is optional.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">present</td><td>Set to true if a t0 value was provided, false if not specified.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted t0 string, e.g.: "t0 250\\n" Returns empty string if t0 is not specified. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00297">297</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac97c8663ddc3cebc6a71a3ddac3971a1" name="ac97c8663ddc3cebc6a71a3ddac3971a1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac97c8663ddc3cebc6a71a3ddac3971a1">◆ </a></span>helpContent</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void PGetSingleHistoRunBlockDialog::helpContent </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 private">private</span><span class="mlabel slot">slot</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Opens the online help for single histogram RUN blocks. </p>
|
|
<p>Opens the online help documentation for single histogram RUN blocks.</p>
|
|
<p>Attempts to open the help URL in the system's default web browser using QDesktopServices. If the URL is empty, displays an informational message. If the browser fails to open, displays an error message with a clickable link. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html#l00374">374</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a76451d279752ae4eca5b6022c295922e" name="a76451d279752ae4eca5b6022c295922e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a76451d279752ae4eca5b6022c295922e">◆ </a></span>fHelpUrl</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetSingleHistoRunBlockDialog::fHelpUrl</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>URL to the online documentation for single histogram RUN blocks. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html#l00143">143</a> of file <a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html">PGetSingleHistoRunBlockDialog.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musredit/<a class="el" href="PGetSingleHistoRunBlockDialog_8h_source.html">PGetSingleHistoRunBlockDialog.h</a></li>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musredit/<a class="el" href="PGetSingleHistoRunBlockDialog_8cpp_source.html">PGetSingleHistoRunBlockDialog.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
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
|
|
</small></address>
|
|
</div><!-- doc-content -->
|
|
</body>
|
|
</html>
|