253 lines
13 KiB
HTML
253 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.13.2"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>musredit: PTheory Struct 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-attribs">Public Attributes</a> |
|
|
<a href="structPTheory-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">PTheory Struct Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Structure holding information about a musrfit theory function.
|
|
<a href="#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a0789fffc8d1edeb9cf8ad7eebf9fe920" id="r_a0789fffc8d1edeb9cf8ad7eebf9fe920"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a0789fffc8d1edeb9cf8ad7eebf9fe920">name</a></td></tr>
|
|
<tr class="memdesc:a0789fffc8d1edeb9cf8ad7eebf9fe920"><td class="mdescLeft"> </td><td class="mdescRight">Internal function name used in msr files (e.g., "asymmetry", "simplExpo"). <br /></td></tr>
|
|
<tr class="separator:a0789fffc8d1edeb9cf8ad7eebf9fe920"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4f96f6484e98b76c3c5583b973d27198" id="r_a4f96f6484e98b76c3c5583b973d27198"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a4f96f6484e98b76c3c5583b973d27198">comment</a></td></tr>
|
|
<tr class="memdesc:a4f96f6484e98b76c3c5583b973d27198"><td class="mdescLeft"> </td><td class="mdescRight">Human-readable description of the theory function. <br /></td></tr>
|
|
<tr class="separator:a4f96f6484e98b76c3c5583b973d27198"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e28ee4fe48c28bf48342c393daa7772" id="r_a7e28ee4fe48c28bf48342c393daa7772"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#a7e28ee4fe48c28bf48342c393daa7772">label</a></td></tr>
|
|
<tr class="memdesc:a7e28ee4fe48c28bf48342c393daa7772"><td class="mdescLeft"> </td><td class="mdescRight">Short label for GUI menus and buttons. <br /></td></tr>
|
|
<tr class="separator:a7e28ee4fe48c28bf48342c393daa7772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addaa30dca1f4e856cc73b7660c36b0db" id="r_addaa30dca1f4e856cc73b7660c36b0db"><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#addaa30dca1f4e856cc73b7660c36b0db">pixmapName</a></td></tr>
|
|
<tr class="memdesc:addaa30dca1f4e856cc73b7660c36b0db"><td class="mdescLeft"> </td><td class="mdescRight">Filename of the pixmap image showing the mathematical formula. <br /></td></tr>
|
|
<tr class="separator:addaa30dca1f4e856cc73b7660c36b0db"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a247e18ef085213173549150aadae45bb" id="r_a247e18ef085213173549150aadae45bb"><td class="memItemLeft" align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#a247e18ef085213173549150aadae45bb">pixmap</a></td></tr>
|
|
<tr class="memdesc:a247e18ef085213173549150aadae45bb"><td class="mdescLeft"> </td><td class="mdescRight">Loaded pixmap image of the mathematical formula. <br /></td></tr>
|
|
<tr class="separator:a247e18ef085213173549150aadae45bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88a8f08b16a689c5805f12c3d3ad6cdd" id="r_a88a8f08b16a689c5805f12c3d3ad6cdd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#a88a8f08b16a689c5805f12c3d3ad6cdd">params</a></td></tr>
|
|
<tr class="memdesc:a88a8f08b16a689c5805f12c3d3ad6cdd"><td class="mdescLeft"> </td><td class="mdescRight">Number of parameters required by this theory function. <br /></td></tr>
|
|
<tr class="separator:a88a8f08b16a689c5805f12c3d3ad6cdd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Structure holding information about a musrfit theory function. </p>
|
|
<p>This structure contains all necessary information to represent a theory function in the musredit GUI. Theory functions are mathematical models used to fit muon spin rotation/relaxation data (e.g., exponential relaxation, Gaussian Kubo-Toyabe, etc.).</p>
|
|
<p>Each theory function has:</p><ul>
|
|
<li>A unique name identifier used in msr files</li>
|
|
<li>A human-readable comment/description</li>
|
|
<li>A short label for GUI display</li>
|
|
<li>An optional pixmap showing the mathematical formula</li>
|
|
<li>The number of parameters the function accepts</li>
|
|
</ul>
|
|
<dl class="section see"><dt>See also</dt><dd><a href="https://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block">https://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block</a> Theory block documentation </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00090">90</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
</div><h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a4f96f6484e98b76c3c5583b973d27198" name="a4f96f6484e98b76c3c5583b973d27198"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4f96f6484e98b76c3c5583b973d27198">◆ </a></span>comment</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PTheory::comment</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Human-readable description of the theory function. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00092">92</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7e28ee4fe48c28bf48342c393daa7772" name="a7e28ee4fe48c28bf48342c393daa7772"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7e28ee4fe48c28bf48342c393daa7772">◆ </a></span>label</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PTheory::label</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Short label for GUI menus and buttons. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00093">93</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0789fffc8d1edeb9cf8ad7eebf9fe920" name="a0789fffc8d1edeb9cf8ad7eebf9fe920"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0789fffc8d1edeb9cf8ad7eebf9fe920">◆ </a></span>name</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PTheory::name</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Internal function name used in msr files (e.g., "asymmetry", "simplExpo"). </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00091">91</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88a8f08b16a689c5805f12c3d3ad6cdd" name="a88a8f08b16a689c5805f12c3d3ad6cdd"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88a8f08b16a689c5805f12c3d3ad6cdd">◆ </a></span>params</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int PTheory::params</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Number of parameters required by this theory function. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00096">96</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a247e18ef085213173549150aadae45bb" name="a247e18ef085213173549150aadae45bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a247e18ef085213173549150aadae45bb">◆ </a></span>pixmap</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QPixmap PTheory::pixmap</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loaded pixmap image of the mathematical formula. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00095">95</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="addaa30dca1f4e856cc73b7660c36b0db" name="addaa30dca1f4e856cc73b7660c36b0db"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#addaa30dca1f4e856cc73b7660c36b0db">◆ </a></span>pixmapName</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">QString PTheory::pixmapName</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Filename of the pixmap image showing the mathematical formula. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="PAdmin_8h_source.html#l00094">94</a> of file <a class="el" href="PAdmin_8h_source.html">PAdmin.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>/workspace/LMU/musrfit/src/musredit_qt6/musredit/<a class="el" href="PAdmin_8h_source.html">PAdmin.h</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>
|