Files
musrfit/doc/technical/html/structPMsrParamStructure.html
2026-10-29 15:47:56 +00:00

376 lines
20 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.17.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>musrfit: PMsrParamStructure Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="codefolding.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="cookie.js"></script>
<script type="module">
import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs';
const theme = window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'default';
mermaid.initialize({ startOnLoad: true, theme: theme });
</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.12.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.17.0 -->
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', codefold.init);
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', () => {
initMenu('',true);
});
</script>
<div id="main-nav-mobile">
</div><!-- main-nav-mobile -->
<div id="main-nav">
<ul class="sm sm-dox" id="main-menu">
<li id="searchBoxPos2" style="float:right">
</li>
</ul>
</div><!-- main-nav -->
</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">
document.addEventListener('DOMContentLoaded',() => { initNavTree('structPMsrParamStructure.html','','structPMsrParamStructure-members'); });
</script>
<div id="container">
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">PMsrParamStructure Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="PMusr_8h_source.html">PMusr.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-pub-attribs" class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a6d1a3bb13364ccab8680e3bb013f0357" id="r_a6d1a3bb13364ccab8680e3bb013f0357"><td class="memItemLeft">Int_t&#160;</td><td class="memItemRight"><a class="el" href="#a6d1a3bb13364ccab8680e3bb013f0357">fNoOfParams</a></td></tr>
<tr class="memdesc:a6d1a3bb13364ccab8680e3bb013f0357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total number of parameters in FITPARAMETER block. <br /></td></tr>
<tr class="memitem:a8f3eb879d16d63a317c1566f2de5b72e" id="r_a8f3eb879d16d63a317c1566f2de5b72e"><td class="memItemLeft">Int_t&#160;</td><td class="memItemRight"><a class="el" href="#a8f3eb879d16d63a317c1566f2de5b72e">fNo</a></td></tr>
<tr class="memdesc:a8f3eb879d16d63a317c1566f2de5b72e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameter number (1, 2, 3, ...). <br /></td></tr>
<tr class="memitem:ae6ab47389d3a19901a83587a4e88bb0e" id="r_ae6ab47389d3a19901a83587a4e88bb0e"><td class="memItemLeft">TString&#160;</td><td class="memItemRight"><a class="el" href="#ae6ab47389d3a19901a83587a4e88bb0e">fName</a></td></tr>
<tr class="memdesc:ae6ab47389d3a19901a83587a4e88bb0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameter name (e.g., "alpha", "lambda", "field"). <br /></td></tr>
<tr class="memitem:adefbe4678b7f6ccc731295c93b17bad9" id="r_adefbe4678b7f6ccc731295c93b17bad9"><td class="memItemLeft">Double_t&#160;</td><td class="memItemRight"><a class="el" href="#adefbe4678b7f6ccc731295c93b17bad9">fValue</a></td></tr>
<tr class="memdesc:adefbe4678b7f6ccc731295c93b17bad9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Parameter value (initial or fitted). <br /></td></tr>
<tr class="memitem:a0ae45f118dd47f32cc3a9e4547bd3b74" id="r_a0ae45f118dd47f32cc3a9e4547bd3b74"><td class="memItemLeft">Double_t&#160;</td><td class="memItemRight"><a class="el" href="#a0ae45f118dd47f32cc3a9e4547bd3b74">fStep</a></td></tr>
<tr class="memdesc:a0ae45f118dd47f32cc3a9e4547bd3b74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Step size / error / negative error (context-dependent). <br /></td></tr>
<tr class="memitem:ab0dffa3e19fe19b6dd88f22f1f6328cb" id="r_ab0dffa3e19fe19b6dd88f22f1f6328cb"><td class="memItemLeft">Bool_t&#160;</td><td class="memItemRight"><a class="el" href="#ab0dffa3e19fe19b6dd88f22f1f6328cb">fPosErrorPresent</a></td></tr>
<tr class="memdesc:ab0dffa3e19fe19b6dd88f22f1f6328cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if positive error explicitly defined (asymmetric errors). <br /></td></tr>
<tr class="memitem:a4e429448ee5c4cdef33ac651042bb61a" id="r_a4e429448ee5c4cdef33ac651042bb61a"><td class="memItemLeft">Double_t&#160;</td><td class="memItemRight"><a class="el" href="#a4e429448ee5c4cdef33ac651042bb61a">fPosError</a></td></tr>
<tr class="memdesc:a4e429448ee5c4cdef33ac651042bb61a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Positive error for asymmetric uncertainties. <br /></td></tr>
<tr class="memitem:a51e6a86fc6b976c2da97c279c2376812" id="r_a51e6a86fc6b976c2da97c279c2376812"><td class="memItemLeft">Bool_t&#160;</td><td class="memItemRight"><a class="el" href="#a51e6a86fc6b976c2da97c279c2376812">fLowerBoundaryPresent</a></td></tr>
<tr class="memdesc:a51e6a86fc6b976c2da97c279c2376812"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if lower bound constraint is active. <br /></td></tr>
<tr class="memitem:a8d97435a22a8ea76b631563d898ea14e" id="r_a8d97435a22a8ea76b631563d898ea14e"><td class="memItemLeft">Double_t&#160;</td><td class="memItemRight"><a class="el" href="#a8d97435a22a8ea76b631563d898ea14e">fLowerBoundary</a></td></tr>
<tr class="memdesc:a8d97435a22a8ea76b631563d898ea14e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Lower boundary value for parameter constraints. <br /></td></tr>
<tr class="memitem:ac17f1a37370199ed889c28003b4692cf" id="r_ac17f1a37370199ed889c28003b4692cf"><td class="memItemLeft">Bool_t&#160;</td><td class="memItemRight"><a class="el" href="#ac17f1a37370199ed889c28003b4692cf">fUpperBoundaryPresent</a></td></tr>
<tr class="memdesc:ac17f1a37370199ed889c28003b4692cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if upper bound constraint is active. <br /></td></tr>
<tr class="memitem:a9c62c20a8e99222e27f95fe2e8fe2d85" id="r_a9c62c20a8e99222e27f95fe2e8fe2d85"><td class="memItemLeft">Double_t&#160;</td><td class="memItemRight"><a class="el" href="#a9c62c20a8e99222e27f95fe2e8fe2d85">fUpperBoundary</a></td></tr>
<tr class="memdesc:a9c62c20a8e99222e27f95fe2e8fe2d85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Upper boundary value for parameter constraints. <br /></td></tr>
<tr class="memitem:ac458507a9d6384f9976a209853397138" id="r_ac458507a9d6384f9976a209853397138"><td class="memItemLeft">Bool_t&#160;</td><td class="memItemRight"><a class="el" href="#ac458507a9d6384f9976a209853397138">fIsGlobal</a></td></tr>
<tr class="memdesc:ac458507a9d6384f9976a209853397138"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if parameter is global (for msr2data global mode). <br /></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Structure defining a fit parameter in the FITPARAMETER block.</p>
<p>This structure contains all information about a single fit parameter: its number, name, value, uncertainty, and optional constraints (boundaries). Parameters can be fixed (fStep=0) or free (fStep&gt;0), and may have asymmetric errors after fitting.</p>
<p><b>Example MSR line:</b> "3 alpha 1.0 0.1 0.5 1.5" defines parameter #3 named "alpha" with value 1.0, step 0.1, and bounds [0.5, 1.5]. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01021">1021</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
</div><a name="doc-variable-members" id="doc-variable-members"></a><h2 id="header-doc-variable-members" class="groupheader">Member Data Documentation</h2>
<a id="ac458507a9d6384f9976a209853397138" name="ac458507a9d6384f9976a209853397138"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac458507a9d6384f9976a209853397138">&#9670;&#160;</a></span>fIsGlobal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool_t PMsrParamStructure::fIsGlobal</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if parameter is global (for msr2data global mode). </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01033">1033</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsr2Data_8cpp_source.html#l00746">compare_parameters()</a>.</p>
</div>
</div>
<a id="a8d97435a22a8ea76b631563d898ea14e" name="a8d97435a22a8ea76b631563d898ea14e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d97435a22a8ea76b631563d898ea14e">&#9670;&#160;</a></span>fLowerBoundary</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMsrParamStructure::fLowerBoundary</td>
</tr>
</table>
</div><div class="memdoc">
<p>Lower boundary value for parameter constraints. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01030">1030</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="a51e6a86fc6b976c2da97c279c2376812" name="a51e6a86fc6b976c2da97c279c2376812"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a51e6a86fc6b976c2da97c279c2376812">&#9670;&#160;</a></span>fLowerBoundaryPresent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool_t PMsrParamStructure::fLowerBoundaryPresent</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if lower bound constraint is active. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01029">1029</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="ae6ab47389d3a19901a83587a4e88bb0e" name="ae6ab47389d3a19901a83587a4e88bb0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ab47389d3a19901a83587a4e88bb0e">&#9670;&#160;</a></span>fName</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TString PMsrParamStructure::fName</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter name (e.g., "alpha", "lambda", "field"). </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01024">1024</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="a8f3eb879d16d63a317c1566f2de5b72e" name="a8f3eb879d16d63a317c1566f2de5b72e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f3eb879d16d63a317c1566f2de5b72e">&#9670;&#160;</a></span>fNo</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Int_t PMsrParamStructure::fNo</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter number (1, 2, 3, ...). </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01023">1023</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsr2Data_8cpp_source.html#l00746">compare_parameters()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="a6d1a3bb13364ccab8680e3bb013f0357" name="a6d1a3bb13364ccab8680e3bb013f0357"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d1a3bb13364ccab8680e3bb013f0357">&#9670;&#160;</a></span>fNoOfParams</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Int_t PMsrParamStructure::fNoOfParams</td>
</tr>
</table>
</div><div class="memdoc">
<p>Total number of parameters in FITPARAMETER block. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01022">1022</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="a4e429448ee5c4cdef33ac651042bb61a" name="a4e429448ee5c4cdef33ac651042bb61a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e429448ee5c4cdef33ac651042bb61a">&#9670;&#160;</a></span>fPosError</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMsrParamStructure::fPosError</td>
</tr>
</table>
</div><div class="memdoc">
<p>Positive error for asymmetric uncertainties. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01028">1028</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="ab0dffa3e19fe19b6dd88f22f1f6328cb" name="ab0dffa3e19fe19b6dd88f22f1f6328cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0dffa3e19fe19b6dd88f22f1f6328cb">&#9670;&#160;</a></span>fPosErrorPresent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool_t PMsrParamStructure::fPosErrorPresent</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if positive error explicitly defined (asymmetric errors). </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01027">1027</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMusrCanvas_8cpp_source.html#l06524">PMusrCanvas::GetNeededAccuracy()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="a0ae45f118dd47f32cc3a9e4547bd3b74" name="a0ae45f118dd47f32cc3a9e4547bd3b74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ae45f118dd47f32cc3a9e4547bd3b74">&#9670;&#160;</a></span>fStep</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMsrParamStructure::fStep</td>
</tr>
</table>
</div><div class="memdoc">
<p>Step size / error / negative error (context-dependent). </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01026">1026</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMusrCanvas_8cpp_source.html#l06524">PMusrCanvas::GetNeededAccuracy()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="a9c62c20a8e99222e27f95fe2e8fe2d85" name="a9c62c20a8e99222e27f95fe2e8fe2d85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c62c20a8e99222e27f95fe2e8fe2d85">&#9670;&#160;</a></span>fUpperBoundary</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMsrParamStructure::fUpperBoundary</td>
</tr>
</table>
</div><div class="memdoc">
<p>Upper boundary value for parameter constraints. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01032">1032</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="ac17f1a37370199ed889c28003b4692cf" name="ac17f1a37370199ed889c28003b4692cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac17f1a37370199ed889c28003b4692cf">&#9670;&#160;</a></span>fUpperBoundaryPresent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Bool_t PMsrParamStructure::fUpperBoundaryPresent</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if upper bound constraint is active. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01031">1031</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<a id="adefbe4678b7f6ccc731295c93b17bad9" name="adefbe4678b7f6ccc731295c93b17bad9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adefbe4678b7f6ccc731295c93b17bad9">&#9670;&#160;</a></span>fValue</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMsrParamStructure::fValue</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter value (initial or fitted). </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l01025">1025</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
<p class="reference">Referenced by <a class="el" href="PMusrCanvas_8cpp_source.html#l06524">PMusrCanvas::GetNeededAccuracy()</a>, and <a class="el" href="PMsrHandler_8cpp_source.html#l02874">PMsrHandler::HandleFitParameterEntry()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/workspace/LMU/musrfit/src/include/<a class="el" href="PMusr_8h_source.html">PMusr.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="structPMsrParamStructure.html">PMsrParamStructure</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.17.0 </li>
</ul>
</div>
</body>
</html>