635 lines
37 KiB
HTML
635 lines
37 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: PGetAsymmetryRunBlockDialog 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="classPGetAsymmetryRunBlockDialog-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PGetAsymmetryRunBlockDialog Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Dialog for creating asymmetry-type RUN blocks in msr files.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html">PGetAsymmetryRunBlockDialog.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for PGetAsymmetryRunBlockDialog:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPGetAsymmetryRunBlockDialog__inherit__graph.png" border="0" usemap="#aPGetAsymmetryRunBlockDialog_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aPGetAsymmetryRunBlockDialog_inherit__map" id="aPGetAsymmetryRunBlockDialog_inherit__map">
|
|
<area shape="rect" title="Dialog for creating asymmetry-type RUN blocks in msr files." alt="" coords="11,98,224,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="100,5,293,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 PGetAsymmetryRunBlockDialog:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classPGetAsymmetryRunBlockDialog__coll__graph.png" border="0" usemap="#aPGetAsymmetryRunBlockDialog_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="aPGetAsymmetryRunBlockDialog_coll__map" id="aPGetAsymmetryRunBlockDialog_coll__map">
|
|
<area shape="rect" title="Dialog for creating asymmetry-type RUN blocks in msr files." alt="" coords="11,98,224,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="100,5,293,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:a59b0e89e4b0762faf341b71be995bf35" id="r_a59b0e89e4b0762faf341b71be995bf35"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a59b0e89e4b0762faf341b71be995bf35">PGetAsymmetryRunBlockDialog</a> (const QString helpUrl)</td></tr>
|
|
<tr class="memdesc:a59b0e89e4b0762faf341b71be995bf35"><td class="mdescLeft"> </td><td class="mdescRight">Constructs the asymmetry RUN block dialog. <br /></td></tr>
|
|
<tr class="separator:a59b0e89e4b0762faf341b71be995bf35"><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:a0eb568d1ccf291d43cd8241b44cb755e" id="r_a0eb568d1ccf291d43cd8241b44cb755e"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0eb568d1ccf291d43cd8241b44cb755e">getRunHeaderInfo</a> ()</td></tr>
|
|
<tr class="memdesc:a0eb568d1ccf291d43cd8241b44cb755e"><td class="mdescLeft"> </td><td class="mdescRight">Generates the RUN header line for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a0eb568d1ccf291d43cd8241b44cb755e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8e86420a48ae52f10f7a488a5cc79d4" id="r_ae8e86420a48ae52f10f7a488a5cc79d4"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#ae8e86420a48ae52f10f7a488a5cc79d4">getAlphaParameter</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:ae8e86420a48ae52f10f7a488a5cc79d4"><td class="mdescLeft"> </td><td class="mdescRight">Generates the alpha parameter line for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:ae8e86420a48ae52f10f7a488a5cc79d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0be1a8ac53d720581a340b5f58809f10" id="r_a0be1a8ac53d720581a340b5f58809f10"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0be1a8ac53d720581a340b5f58809f10">getBetaParameter</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:a0be1a8ac53d720581a340b5f58809f10"><td class="mdescLeft"> </td><td class="mdescRight">Generates the beta parameter line for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a0be1a8ac53d720581a340b5f58809f10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28bc9ce7615fef03599df94b7614dade" id="r_a28bc9ce7615fef03599df94b7614dade"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a28bc9ce7615fef03599df94b7614dade">getMap</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:a28bc9ce7615fef03599df94b7614dade"><td class="mdescLeft"> </td><td class="mdescRight">Generates the parameter map line for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a28bc9ce7615fef03599df94b7614dade"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b54eaa45571f7106a08d491dbb933ba" id="r_a5b54eaa45571f7106a08d491dbb933ba"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a5b54eaa45571f7106a08d491dbb933ba">getForward</a> ()</td></tr>
|
|
<tr class="memdesc:a5b54eaa45571f7106a08d491dbb933ba"><td class="mdescLeft"> </td><td class="mdescRight">Get the forward histogram specification line. <br /></td></tr>
|
|
<tr class="separator:a5b54eaa45571f7106a08d491dbb933ba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3b081754d29e85115eb963bfd8d191f" id="r_aa3b081754d29e85115eb963bfd8d191f"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#aa3b081754d29e85115eb963bfd8d191f">getBackward</a> ()</td></tr>
|
|
<tr class="memdesc:aa3b081754d29e85115eb963bfd8d191f"><td class="mdescLeft"> </td><td class="mdescRight">Get the backward histogram specification line. <br /></td></tr>
|
|
<tr class="separator:aa3b081754d29e85115eb963bfd8d191f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cd854fa066762e5ee7dbaf697b1c767" id="r_a7cd854fa066762e5ee7dbaf697b1c767"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cd854fa066762e5ee7dbaf697b1c767">getBackground</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:a7cd854fa066762e5ee7dbaf697b1c767"><td class="mdescLeft"> </td><td class="mdescRight">Generates the background specification for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a7cd854fa066762e5ee7dbaf697b1c767"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a28c343a4c5f8c8893dd1b56972daac17" id="r_a28c343a4c5f8c8893dd1b56972daac17"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a28c343a4c5f8c8893dd1b56972daac17">getData</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:a28c343a4c5f8c8893dd1b56972daac17"><td class="mdescLeft"> </td><td class="mdescRight">Generates the data range specification for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a28c343a4c5f8c8893dd1b56972daac17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ffaa21dde9434e4748c328f3d640b73" id="r_a8ffaa21dde9434e4748c328f3d640b73"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ffaa21dde9434e4748c328f3d640b73">getT0</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:a8ffaa21dde9434e4748c328f3d640b73"><td class="mdescLeft"> </td><td class="mdescRight">Generates the T0 (time zero) specification for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a8ffaa21dde9434e4748c328f3d640b73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a132941f668781c42af0225c3943f3f45" id="r_a132941f668781c42af0225c3943f3f45"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a132941f668781c42af0225c3943f3f45">getFitRange</a> (bool &valid)</td></tr>
|
|
<tr class="memdesc:a132941f668781c42af0225c3943f3f45"><td class="mdescLeft"> </td><td class="mdescRight">Generates the fit range specification for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:a132941f668781c42af0225c3943f3f45"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf8e414b1657a738f9919abeb8fc3884" id="r_abf8e414b1657a738f9919abeb8fc3884"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#abf8e414b1657a738f9919abeb8fc3884">getPacking</a> (bool &present)</td></tr>
|
|
<tr class="memdesc:abf8e414b1657a738f9919abeb8fc3884"><td class="mdescLeft"> </td><td class="mdescRight">Generates the packing (rebinning) specification for the asymmetry block. <br /></td></tr>
|
|
<tr class="separator:abf8e414b1657a738f9919abeb8fc3884"><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:a8bcef9362cd1425344420b02c41b93ce" id="r_a8bcef9362cd1425344420b02c41b93ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a8bcef9362cd1425344420b02c41b93ce">helpContent</a> ()</td></tr>
|
|
<tr class="memdesc:a8bcef9362cd1425344420b02c41b93ce"><td class="mdescLeft"> </td><td class="mdescRight">Opens the online help for asymmetry RUN blocks. <br /></td></tr>
|
|
<tr class="separator:a8bcef9362cd1425344420b02c41b93ce"><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:a97172309b8f54c184c160a4c7cb9a65c" id="r_a97172309b8f54c184c160a4c7cb9a65c"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a97172309b8f54c184c160a4c7cb9a65c">fHelpUrl</a></td></tr>
|
|
<tr class="memdesc:a97172309b8f54c184c160a4c7cb9a65c"><td class="mdescLeft"> </td><td class="mdescRight">URL to the online documentation for asymmetry RUN blocks. <br /></td></tr>
|
|
<tr class="separator:a97172309b8f54c184c160a4c7cb9a65c"><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 asymmetry-type RUN blocks in msr files. </p>
|
|
<p>This dialog collects all parameters needed to generate an asymmetry RUN block for muon spin rotation data analysis. Asymmetry fitting uses the ratio of forward and backward detector counts to extract the muon spin polarization signal.</p>
|
|
<dl class="section user"><dt>RUN Block Parameters:</dt><dd><ul>
|
|
<li>Run file name, beamline, institute, and file format</li>
|
|
<li>Forward and backward histogram numbers</li>
|
|
<li>Alpha parameter (detector efficiency ratio)</li>
|
|
<li>Beta parameter (detector phase correction)</li>
|
|
<li>Parameter map</li>
|
|
<li>Background specification (fixed or fitted)</li>
|
|
<li>Data range (in bins)</li>
|
|
<li>T0 (time zero) values</li>
|
|
<li>Fit range (in microseconds)</li>
|
|
<li>Packing/binning factor</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">alpha 1</div>
|
|
<div class="line">beta 1</div>
|
|
<div class="line">map 1 2 3</div>
|
|
<div class="line">forward 1</div>
|
|
<div class="line">backward 2</div>
|
|
<div class="line">background 50 150 50 150</div>
|
|
<div class="line">fit 0.0 10.0</div>
|
|
<div class="line">packing 1</div>
|
|
</div><!-- fragment --></dd></dl>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classPGetSingleHistoRunBlockDialog.html" title="Dialog for creating single histogram type RUN blocks in msr files.">PGetSingleHistoRunBlockDialog</a> For single histogram fitting </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 data </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html#l00091">91</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html">PGetAsymmetryRunBlockDialog.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a59b0e89e4b0762faf341b71be995bf35" name="a59b0e89e4b0762faf341b71be995bf35"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a59b0e89e4b0762faf341b71be995bf35">◆ </a></span>PGetAsymmetryRunBlockDialog()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">PGetAsymmetryRunBlockDialog::PGetAsymmetryRunBlockDialog </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const QString</td> <td class="paramname"><span class="paramname"><em>helpUrl</em></span></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructs the asymmetry RUN block dialog. </p>
|
|
<p>Initializes the dialog UI and sets up input validators for all numeric fields. The dialog is created as modal.</p>
|
|
<dl class="section user"><dt>Input Validators:</dt><dd><ul>
|
|
<li>Integer validators: histogram numbers, data ranges, background ranges, t0 values, packing, alpha, beta</li>
|
|
<li>Double validators: fixed background values, 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 asymmetry RUN blocks. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00066">66</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ae8e86420a48ae52f10f7a488a5cc79d4" name="ae8e86420a48ae52f10f7a488a5cc79d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae8e86420a48ae52f10f7a488a5cc79d4">◆ </a></span>getAlphaParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::getAlphaParameter </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 alpha parameter line for the asymmetry block. </p>
|
|
<p>Alpha is the detector efficiency ratio correction parameter used in asymmetry calculations: A = (N_F - alpha * N_B) / (N_F + alpha * N_B). The parameter typically references a fit parameter number.</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 an alpha value was entered, false if empty (default alpha=1 will be used).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted alpha parameter string, e.g.: "alpha 1\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00129">129</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7cd854fa066762e5ee7dbaf697b1c767" name="a7cd854fa066762e5ee7dbaf697b1c767"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7cd854fa066762e5ee7dbaf697b1c767">◆ </a></span>getBackground()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry block. </p>
|
|
<p>Creates either a "background" line (bin ranges for background estimation) or a "backgr.fix" line (fixed background values). Only one type should be specified.</p>
|
|
<dl class="section user"><dt>Background Types:</dt><dd><ul>
|
|
<li>background: Four integers specifying bin ranges [forward_start, forward_end, backward_start, backward_end]</li>
|
|
<li>backgr.fix: Two doubles specifying fixed background counts for forward and backward detectors</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 0 10" is returned).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted background string, e.g.: "background 50 150 50 150\n" or "backgr.fix 15.3 14.8\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00213">213</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa3b081754d29e85115eb963bfd8d191f" name="aa3b081754d29e85115eb963bfd8d191f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa3b081754d29e85115eb963bfd8d191f">◆ </a></span>getBackward()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::getBackward </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>Get the backward histogram specification line. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted "backward" line for the msr file. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html#l00117">117</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html">PGetAsymmetryRunBlockDialog.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0be1a8ac53d720581a340b5f58809f10" name="a0be1a8ac53d720581a340b5f58809f10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0be1a8ac53d720581a340b5f58809f10">◆ </a></span>getBetaParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::getBetaParameter </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 beta parameter line for the asymmetry block. </p>
|
|
<p>Beta is the detector phase correction parameter, typically used for correcting phase differences between forward and backward detectors. The parameter typically references a fit parameter number.</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 beta value was entered, false if empty (default beta=1 will be used).</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted beta parameter string, e.g.: "beta 1\n" </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00154">154</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28c343a4c5f8c8893dd1b56972daac17" name="a28c343a4c5f8c8893dd1b56972daac17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28c343a4c5f8c8893dd1b56972daac17">◆ </a></span>getData()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry block. </p>
|
|
<p>Creates the "data" line specifying the histogram bin ranges to be used for fitting. Four values are required: start and end bins for both forward and backward histograms.</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 all four data range values are provided, false if any are missing.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted data range string, e.g.: "data 100 8000 100 8000\n" Returns empty string if values are missing. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00257">257</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a132941f668781c42af0225c3943f3f45" name="a132941f668781c42af0225c3943f3f45"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a132941f668781c42af0225c3943f3f45">◆ </a></span>getFitRange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry block. </p>
|
|
<p>Creates the "fit" line specifying the time range (in microseconds) over which the fit will be performed.</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, false if missing (a default range [0.0, 10.0] is returned).</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="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00316">316</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5b54eaa45571f7106a08d491dbb933ba" name="a5b54eaa45571f7106a08d491dbb933ba"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b54eaa45571f7106a08d491dbb933ba">◆ </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 PGetAsymmetryRunBlockDialog::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>Get 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="PGetAsymmetryRunBlockDialog_8h_source.html#l00111">111</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html">PGetAsymmetryRunBlockDialog.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a28bc9ce7615fef03599df94b7614dade" name="a28bc9ce7615fef03599df94b7614dade"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a28bc9ce7615fef03599df94b7614dade">◆ </a></span>getMap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry 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="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00179">179</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf8e414b1657a738f9919abeb8fc3884" name="abf8e414b1657a738f9919abeb8fc3884"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf8e414b1657a738f9919abeb8fc3884">◆ </a></span>getPacking()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry 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.</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, false if missing (a default packing of 1 is returned).</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="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00346">346</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0eb568d1ccf291d43cd8241b44cb755e" name="a0eb568d1ccf291d43cd8241b44cb755e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0eb568d1ccf291d43cd8241b44cb755e">◆ </a></span>getRunHeaderInfo()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry 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="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00104">104</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ffaa21dde9434e4748c328f3d640b73" name="a8ffaa21dde9434e4748c328f3d640b73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ffaa21dde9434e4748c328f3d640b73">◆ </a></span>getT0()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PGetAsymmetryRunBlockDialog::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 asymmetry block. </p>
|
|
<p>Creates the "t0" line specifying the time zero bin for both forward and backward histograms. T0 is the bin corresponding to muon implantation time.</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 both t0 values are provided, false otherwise.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Formatted t0 string, e.g.: "t0 250 250\n" Returns empty string if values are missing. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00288">288</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8bcef9362cd1425344420b02c41b93ce" name="a8bcef9362cd1425344420b02c41b93ce"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8bcef9362cd1425344420b02c41b93ce">◆ </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 PGetAsymmetryRunBlockDialog::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 asymmetry RUN blocks. </p>
|
|
<p>Opens the online help documentation for asymmetry 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="PGetAsymmetryRunBlockDialog_8cpp_source.html#l00369">369</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a97172309b8f54c184c160a4c7cb9a65c" name="a97172309b8f54c184c160a4c7cb9a65c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97172309b8f54c184c160a4c7cb9a65c">◆ </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 PGetAsymmetryRunBlockDialog::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 asymmetry RUN blocks. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html#l00133">133</a> of file <a class="el" href="PGetAsymmetryRunBlockDialog_8h_source.html">PGetAsymmetryRunBlockDialog.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="PGetAsymmetryRunBlockDialog_8h_source.html">PGetAsymmetryRunBlockDialog.h</a></li>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musredit/<a class="el" href="PGetAsymmetryRunBlockDialog_8cpp_source.html">PGetAsymmetryRunBlockDialog.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>
|