282 lines
13 KiB
HTML
282 lines
13 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>musrStep: PParam 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>
|
|
<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>
|
|
<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">musrStep<span id="projectnumber"> 1.0.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.17.0 -->
|
|
<script type="text/javascript">
|
|
let searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
</script>
|
|
<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);
|
|
init_search();
|
|
});
|
|
</script>
|
|
<div id="main-nav-mobile">
|
|
<div class="sm sm-dox"><input id="main-menu-state" type="checkbox"/>
|
|
<label class="main-menu-btn" for="main-menu-state">
|
|
<span class="main-menu-btn-icon"></span> Toggle main menu visibility</label>
|
|
<span id="searchBoxPos1" style="position:absolute;right:8px;top:8px;height:36px;"></span>
|
|
</div>
|
|
</div><!-- main-nav-mobile -->
|
|
<div id="main-nav">
|
|
<ul class="sm sm-dox" id="main-menu">
|
|
<li id="searchBoxPos2" style="float:right">
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
|
|
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
|
|
</span>
|
|
</div>
|
|
</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('structPParam.html','','structPParam-members'); });
|
|
</script>
|
|
<div id="container">
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle"><div class="title">PParam Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Structure representing a single fit parameter from an msr-file.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PMusrStep_8h_source.html">PMusrStep.h</a>></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:a63ed971208f7a0bf41c7f8a0e6747620" id="r_a63ed971208f7a0bf41c7f8a0e6747620"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#a63ed971208f7a0bf41c7f8a0e6747620">number</a></td></tr>
|
|
<tr class="memdesc:a63ed971208f7a0bf41c7f8a0e6747620"><td class="mdescLeft"> </td><td class="mdescRight">Parameter number (index) in the msr-file. <br /></td></tr>
|
|
<tr class="memitem:a3e2fef2e15397970730d8555cd022728" id="r_a3e2fef2e15397970730d8555cd022728"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#a3e2fef2e15397970730d8555cd022728">name</a></td></tr>
|
|
<tr class="memdesc:a3e2fef2e15397970730d8555cd022728"><td class="mdescLeft"> </td><td class="mdescRight">Parameter name identifier. <br /></td></tr>
|
|
<tr class="memitem:a6d1c8bfb52e8d32a1ab634ea09378c61" id="r_a6d1c8bfb52e8d32a1ab634ea09378c61"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#a6d1c8bfb52e8d32a1ab634ea09378c61">value</a></td></tr>
|
|
<tr class="memdesc:a6d1c8bfb52e8d32a1ab634ea09378c61"><td class="mdescLeft"> </td><td class="mdescRight">Current parameter value. <br /></td></tr>
|
|
<tr class="memitem:a7dd5d74e583dcdde398288b19b52a5f8" id="r_a7dd5d74e583dcdde398288b19b52a5f8"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#a7dd5d74e583dcdde398288b19b52a5f8">step</a></td></tr>
|
|
<tr class="memdesc:a7dd5d74e583dcdde398288b19b52a5f8"><td class="mdescLeft"> </td><td class="mdescRight">Step size for the fit (0 means fixed parameter). <br /></td></tr>
|
|
<tr class="memitem:a132a19067af8eb0753ce1e57345e306b" id="r_a132a19067af8eb0753ce1e57345e306b"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#a132a19067af8eb0753ce1e57345e306b">posErr</a></td></tr>
|
|
<tr class="memdesc:a132a19067af8eb0753ce1e57345e306b"><td class="mdescLeft"> </td><td class="mdescRight">Positive error estimate. <br /></td></tr>
|
|
<tr class="memitem:af24c288dd5ceb31c75ffc38fe6d27350" id="r_af24c288dd5ceb31c75ffc38fe6d27350"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#af24c288dd5ceb31c75ffc38fe6d27350">boundLow</a></td></tr>
|
|
<tr class="memdesc:af24c288dd5ceb31c75ffc38fe6d27350"><td class="mdescLeft"> </td><td class="mdescRight">Lower boundary constraint (optional). <br /></td></tr>
|
|
<tr class="memitem:a248c74d1940e7becd25a06f429a7923a" id="r_a248c74d1940e7becd25a06f429a7923a"><td class="memItemLeft">QString </td><td class="memItemRight"><a class="el" href="#a248c74d1940e7becd25a06f429a7923a">boundHigh</a></td></tr>
|
|
<tr class="memdesc:a248c74d1940e7becd25a06f429a7923a"><td class="mdescLeft"> </td><td class="mdescRight">Upper boundary constraint (optional). <br /></td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Structure representing a single fit parameter from an msr-file. </p>
|
|
<p>This structure holds all components of a FITPARAMETER line from a musrfit msr-file, including the parameter number, name, value, step size, positive error, and optional boundary constraints. </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="a248c74d1940e7becd25a06f429a7923a" name="a248c74d1940e7becd25a06f429a7923a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a248c74d1940e7becd25a06f429a7923a">◆ </a></span>boundHigh</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::boundHigh</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Upper boundary constraint (optional). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af24c288dd5ceb31c75ffc38fe6d27350" name="af24c288dd5ceb31c75ffc38fe6d27350"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af24c288dd5ceb31c75ffc38fe6d27350">◆ </a></span>boundLow</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::boundLow</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Lower boundary constraint (optional). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3e2fef2e15397970730d8555cd022728" name="a3e2fef2e15397970730d8555cd022728"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3e2fef2e15397970730d8555cd022728">◆ </a></span>name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parameter name identifier. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a63ed971208f7a0bf41c7f8a0e6747620" name="a63ed971208f7a0bf41c7f8a0e6747620"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a63ed971208f7a0bf41c7f8a0e6747620">◆ </a></span>number</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::number</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Parameter number (index) in the msr-file. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a132a19067af8eb0753ce1e57345e306b" name="a132a19067af8eb0753ce1e57345e306b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a132a19067af8eb0753ce1e57345e306b">◆ </a></span>posErr</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::posErr</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Positive error estimate. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7dd5d74e583dcdde398288b19b52a5f8" name="a7dd5d74e583dcdde398288b19b52a5f8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7dd5d74e583dcdde398288b19b52a5f8">◆ </a></span>step</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::step</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Step size for the fit (0 means fixed parameter). </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6d1c8bfb52e8d32a1ab634ea09378c61" name="a6d1c8bfb52e8d32a1ab634ea09378c61"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d1c8bfb52e8d32a1ab634ea09378c61">◆ </a></span>value</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PParam::value</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Current parameter value. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musrStep/<a class="el" href="PMusrStep_8h_source.html">PMusrStep.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="structPParam.html">PParam</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>
|