musrfit/doc/technical/html/structPMetaData.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: PMetaData 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('structPMetaData.html','','structPMetaData-members'); });
</script>
<div id="container">
<div id="doc-content">
<div class="header">
  <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 id="header-pub-attribs" 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">Double_t&#160;</td><td class="memItemRight"><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="memitem:a7cb2102c8cfc8fde75f3665c2176cb03" id="r_a7cb2102c8cfc8fde75f3665c2176cb03"><td class="memItemLeft">Double_t&#160;</td><td class="memItemRight"><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="memitem:a2f273b18ad6ec88aaf1ea32d15da4aba" id="r_a2f273b18ad6ec88aaf1ea32d15da4aba"><td class="memItemLeft"><a class="el" href="PMusr_8h.html#ae689e7a4bf8a9c0ecf65bcd7d4a0ebde">PDoubleVector</a>&#160;</td><td class="memItemRight"><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>
</table>
<a name="details" id="details"></a><h2 id="header-details" 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#l00445">445</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="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#l00447">447</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#l00446">446</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#l00448">448</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 -->
<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="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.17.0 </li>
  </ul>
</div>
</body>
</html>