179 lines
9.8 KiB
HTML
179 lines
9.8 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Constraints — muSRFlow User Manual</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=d11f710b" />
|
|
|
|
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="_static/documentation_options.js?v=1305e836"></script>
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="t0 / background" href="t0-background.html" />
|
|
<link rel="prev" title="Parameters and parameter plots" href="parameters-plots.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
muSRFlow
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting started</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="runs-fitting.html">Runs and fitting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="parameters-plots.html">Parameters and parameter plots</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Constraints</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="#custom-parameters">Custom parameters</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#id1">Constraints</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#example-couple-the-magnetic-field-to-the-larmor-frequency">Example: couple the magnetic field to the Larmor frequency</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="#preview">Preview</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="t0-background.html">t0 / background</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="msr-editor.html">MSR editor</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="results-diagnostics.html">Results and diagnostics</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="configuration-sharing.html">Configuration sharing</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="preferences.html">Preferences</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="platforms.html">Web and desktop editions</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="keyboard-shortcuts.html">Keyboard shortcuts</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">muSRFlow</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">Constraints</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/constraints.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="constraints">
|
|
<h1>Constraints<a class="headerlink" href="#constraints" title="Link to this heading"></a></h1>
|
|
<p>The <strong>Constraints</strong> tab adds fit functions and parameter relations that are
|
|
not represented by the main theory controls. It is split into three parts:</p>
|
|
<ul class="simple">
|
|
<li><p><strong>Custom parameters</strong> – the named constants you define once and reference
|
|
from constraints.</p></li>
|
|
<li><p><strong>Constraints</strong> – one row per constraint: a parameter, a function
|
|
expression, and an Add button.</p></li>
|
|
<li><p><strong>Preview</strong> – a live read-only rendering of the <code class="docutils literal notranslate"><span class="pre">THEORY</span></code> and
|
|
<code class="docutils literal notranslate"><span class="pre">FUNCTIONS</span></code> blocks that the MSR will contain.</p></li>
|
|
</ul>
|
|
<p>Everything on this tab is included the next time the MSR is generated, so you
|
|
can refine the preview without running musrfit.</p>
|
|
<section id="custom-parameters">
|
|
<h2>Custom parameters<a class="headerlink" href="#custom-parameters" title="Link to this heading"></a></h2>
|
|
<p>Type a name (for example <code class="docutils literal notranslate"><span class="pre">Bfield</span></code>) and press <strong>Add</strong>. Custom parameters
|
|
become available on the parameters list and can be referenced by constraints
|
|
like any ordinary fit parameter. They are removed by the same workflow that
|
|
removes a normal model parameter.</p>
|
|
</section>
|
|
<section id="id1">
|
|
<h2>Constraints<a class="headerlink" href="#id1" title="Link to this heading"></a></h2>
|
|
<p>A constraint binds the value of one parameter to an expression of others.
|
|
To add one:</p>
|
|
<ol class="arabic simple">
|
|
<li><p>Choose the parameter to constrain from the <strong>Parameter</strong> dropdown.</p></li>
|
|
<li><p>Type the expression into the <strong>Function</strong> field.</p></li>
|
|
<li><p>Press <strong>Add</strong>.</p></li>
|
|
</ol>
|
|
<p>The expression uses musrfit <code class="docutils literal notranslate"><span class="pre">FUNCTIONS</span></code> syntax: arithmetic on parameter
|
|
names and literals.</p>
|
|
</section>
|
|
<section id="example-couple-the-magnetic-field-to-the-larmor-frequency">
|
|
<h2>Example: couple the magnetic field to the Larmor frequency<a class="headerlink" href="#example-couple-the-magnetic-field-to-the-larmor-frequency" title="Link to this heading"></a></h2>
|
|
<p>A typical use is to avoid fitting a frequency directly and instead fit an
|
|
applied field:</p>
|
|
<ol class="arabic simple">
|
|
<li><p>Add a custom parameter named <code class="docutils literal notranslate"><span class="pre">Bfield</span></code> under <strong>Custom parameters</strong>.</p></li>
|
|
<li><p>Under <strong>Constraints</strong>, choose <code class="docutils literal notranslate"><span class="pre">Frq</span></code> from the <strong>Parameter</strong> dropdown.</p></li>
|
|
<li><p>Type <code class="docutils literal notranslate"><span class="pre">gamma_mu</span> <span class="pre">*</span> <span class="pre">Bfield</span></code> into the <strong>Function</strong> field and press <strong>Add</strong>.</p></li>
|
|
</ol>
|
|
<p>The constraint reads “the Larmor frequency <code class="docutils literal notranslate"><span class="pre">Frq</span></code> equals the muon gyromagnetic
|
|
ratio multiplied by <code class="docutils literal notranslate"><span class="pre">Bfield</span></code>”. The theory and functions preview updates
|
|
immediately so you can verify the generated <code class="docutils literal notranslate"><span class="pre">FUNCTIONS</span></code> text before fitting.</p>
|
|
</section>
|
|
<section id="preview">
|
|
<h2>Preview<a class="headerlink" href="#preview" title="Link to this heading"></a></h2>
|
|
<p>The <strong>Theory</strong> and <strong>Functions</strong> panes show exactly what the MSR will
|
|
contain. The Theory pane reflects the model components from the Runs tab; the
|
|
Functions pane reflects the constraints. Both are read-only – use the GUI
|
|
controls to change them.</p>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="parameters-plots.html" class="btn btn-neutral float-left" title="Parameters and parameter plots" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="t0-background.html" class="btn btn-neutral float-right" title="t0 / background" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2026 Zaher Salman.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |