Files
musrfit/doc/technical/html/structPMetaData.html
Gitea Actions 8a8eac55b7 Deploy site
2025-12-27 12:57:44 +00:00

165 lines
8.2 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>musrfit: PMetaData 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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">musrfit<span id="projectnumber">&#160;1.9.9</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search',true);
});
/* @license-end */
</script>
<div id="main-nav"></div>
</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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('structPMetaData.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structPMetaData-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">PMetaData 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 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:acc23ffc0ac06657b871da3128f10c0a9" id="r_acc23ffc0ac06657b871da3128f10c0a9"><td class="memItemLeft" align="right" valign="top">Double_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acc23ffc0ac06657b871da3128f10c0a9">fField</a></td></tr>
<tr class="memdesc:acc23ffc0ac06657b871da3128f10c0a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applied magnetic field in Gauss (G) <br /></td></tr>
<tr class="separator:acc23ffc0ac06657b871da3128f10c0a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cb2102c8cfc8fde75f3665c2176cb03" id="r_a7cb2102c8cfc8fde75f3665c2176cb03"><td class="memItemLeft" align="right" valign="top">Double_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7cb2102c8cfc8fde75f3665c2176cb03">fEnergy</a></td></tr>
<tr class="memdesc:a7cb2102c8cfc8fde75f3665c2176cb03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Muon implantation energy in kiloelectronvolts (keV) <br /></td></tr>
<tr class="separator:a7cb2102c8cfc8fde75f3665c2176cb03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f273b18ad6ec88aaf1ea32d15da4aba" id="r_a2f273b18ad6ec88aaf1ea32d15da4aba"><td class="memItemLeft" align="right" valign="top"><a class="el" href="PMusr_8h.html#ae689e7a4bf8a9c0ecf65bcd7d4a0ebde">PDoubleVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2f273b18ad6ec88aaf1ea32d15da4aba">fTemp</a></td></tr>
<tr class="memdesc:a2f273b18ad6ec88aaf1ea32d15da4aba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vector of sample temperature(s) in Kelvin (K) <br /></td></tr>
<tr class="separator:a2f273b18ad6ec88aaf1ea32d15da4aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Metadata structure for user-defined FUNCTIONS block.</p>
<p>This structure stores experimental metadata (field, energy, temperature) that can be accessed within user-defined functions in the FUNCTIONS block of MSR files. This allows functions to depend on experimental conditions without requiring additional fit parameters.</p>
<p><b>Example use case:</b> A temperature-dependent relaxation rate can be calculated using fTemp values rather than fitting temperature as a parameter. </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l00431">431</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a7cb2102c8cfc8fde75f3665c2176cb03" name="a7cb2102c8cfc8fde75f3665c2176cb03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cb2102c8cfc8fde75f3665c2176cb03">&#9670;&#160;</a></span>fEnergy</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMetaData::fEnergy</td>
</tr>
</table>
</div><div class="memdoc">
<p>Muon implantation energy in kiloelectronvolts (keV) </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l00433">433</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
</div>
</div>
<a id="acc23ffc0ac06657b871da3128f10c0a9" name="acc23ffc0ac06657b871da3128f10c0a9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc23ffc0ac06657b871da3128f10c0a9">&#9670;&#160;</a></span>fField</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Double_t PMetaData::fField</td>
</tr>
</table>
</div><div class="memdoc">
<p>Applied magnetic field in Gauss (G) </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l00432">432</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</a>.</p>
</div>
</div>
<a id="a2f273b18ad6ec88aaf1ea32d15da4aba" name="a2f273b18ad6ec88aaf1ea32d15da4aba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f273b18ad6ec88aaf1ea32d15da4aba">&#9670;&#160;</a></span>fTemp</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="PMusr_8h.html#ae689e7a4bf8a9c0ecf65bcd7d4a0ebde">PDoubleVector</a> PMetaData::fTemp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Vector of sample temperature(s) in Kelvin (K) </p>
<p class="definition">Definition at line <a class="el" href="PMusr_8h_source.html#l00434">434</a> of file <a class="el" href="PMusr_8h_source.html">PMusr.h</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 -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="structPMetaData.html">PMetaData</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.13.2 </li>
</ul>
</div>
</body>
</html>