LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 4 Activity

update of doku for the dks6 branch.

Browse Source
This commit is contained in:
suter_a
2021-10-06 15:24:00 +02:00
parent 54f6fb62b3
commit dd02b07c56
34 changed files with 1786 additions and 1370 deletions
Download Patch File Download Diff File Expand all files Collapse all files

253
doc/html/user-manual.html
View File

@ -6,15 +6,15 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>User manual &mdash; musrfit 1.7.4 documentation</title>
<title>User manual &mdash; musrfit 1.7.6 documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.7.4',
VERSION: '1.7.6',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,32 +24,29 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="musrfit 1.7.4 documentation" href="index.html" />
<link rel="top" title="musrfit 1.7.6 documentation" href="index.html" />
<link rel="next" title="Documentation of user libs (user functions)" href="user-libs.html" />
<link rel="prev" title="Tutorial for musrfit" href="tutorial.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="user-libs.html" title="Documentation of user libs (user functions)"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorial for musrfit"
accesskey="P">previous</a> |</li>
<li><a href="index.html">musrfit 1.7.4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="header"><h1 class="heading"><a href="index.html">
<span>musrfit 1.7.6 documentation</span></a></h1>
<h2 class="heading"><span>User manual</span></h2>
</div>
<div class="topnav">
<p>
«&#160;&#160;<a href="tutorial.html">Tutorial for <tt class="docutils literal"><span class="pre">musrfit</span></tt></a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="user-libs.html">Documentation of user libs (user functions)</a>&#160;&#160;»
</p>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
</div>
<div class="content">
<div class="section" id="user-manual">
<span id="index-0"></span><span id="id1"></span><h1>User manual<a class="headerlink" href="#user-manual" title="Permalink to this headline"></a></h1>
<div class="section" id="introduction">
@ -65,23 +62,28 @@
<dl class="docutils">
<dt><strong>&lt;msr-file&gt;</strong></dt>
<dd>filename of the msr input file defining all the details needed for performing a fit to a specified set of data. This is the only mandatory parameter.</dd>
<dt><strong>-k, - -keep-mn2-output</strong></dt>
<dt><strong>-k, &#8211;keep-mn2-output</strong></dt>
<dd>selects the option for keeping the output of <tt class="docutils literal"><span class="pre">MINUIT2</span></tt> including the correlation coefficients between different parameters and renaming the files <tt class="docutils literal"><span class="pre">MINUIT2.OUTPUT</span></tt> and <tt class="docutils literal"><span class="pre">MINUIT2.root</span></tt> to <tt class="docutils literal"><span class="pre">&lt;msr_file_without_extension&gt;-mn2.output</span></tt> and <tt class="docutils literal"><span class="pre">&lt;msr_file_without_extension&gt;-mn2.root</span></tt>, respectively, <em>e.g.</em> <tt class="docutils literal"><span class="pre">&lt;msr_file&gt;</span></tt> = <tt class="docutils literal"><span class="pre">8472.msr</span></tt> will result in <tt class="docutils literal"><span class="pre">8472-mn2.output</span></tt>, <tt class="docutils literal"><span class="pre">8472-mn2.root</span></tt>.</dd>
<dt><strong>-c, - -chisq-only</strong></dt>
<dt><strong>-c, &#8211;chisq-only</strong></dt>
<dd>Instead of fitting the model, <tt class="docutils literal"><span class="pre">musrfit</span></tt> calculates <span class="math">\(\chi^2\)</span> or max. log-likelihood, maxLH, only once and sends the result to the standard output if called with this option. This is <em>e.g.</em> useful for the adjustment of the initial values of the fit parameters.</dd>
<dt><strong>-t, - -title-from-data-file</strong></dt>
<dt><strong>-t, &#8211;title-from-data-file</strong></dt>
<dd>If this option is given <tt class="docutils literal"><span class="pre">musrfit</span></tt> will replace the title in the <tt class="docutils literal"><span class="pre">&lt;msr_file&gt;</span></tt> by the run title in the data file of the first run appearing in a RUN block. In case there is no run title in the data file no substitution is done.</dd>
<dt><strong>-e, - -estimateN0</strong></dt>
<dt><strong>-e, &#8211;estimateN0</strong></dt>
<dd>estimate <span class="math">\(N_0\)</span> for single histogram fits.</dd>
<dt><strong>-p, - -per-run-block-chisq</strong></dt>
<dt><strong>-p, &#8211;per-run-block-chisq</strong></dt>
<dd>will write per run block chisq/maxLH into the msr-file.</dd>
<dt><strong>- -dump &lt;type&gt;</strong></dt>
<dt><strong>-n, &#8211;no-of-cores-avail</strong></dt>
<dd>print out how many cores are available (only vaild for OpenMP)</dd>
<dt><strong>-u, &#8211;use-no-of-threads &lt;number&gt;</strong></dt>
<dd>&lt;number&gt;: number of threads to be used (OpenMP). Needs to be &lt;= max. number of cores.
If OpenMP is enable, the maximal number of cores is used, if it is not limited by this option.</dd>
<dt><strong>&#8211;dump &lt;type&gt;</strong></dt>
<dd>is writing a data file with the fit data and the theory; &lt;type&gt; can be ascii (data in columns) or root (data in ROOT histograms).</dd>
<dt><strong>- -timeout &lt;timeout_tag&gt;</strong></dt>
<dt><strong>&#8211;timeout &lt;timeout_tag&gt;</strong></dt>
<dd>overwrites the predefined timeout of 3600 sec. &lt;timeout_tag&gt; <span class="math">\(\leq\)</span> 0 means the timeout facility is not enabled. &lt;timeout_tag&gt; &gt; 0, <em>e.g.</em> <tt class="docutils literal"><span class="pre">nn</span></tt> will set the timeout to <tt class="docutils literal"><span class="pre">nn</span></tt> (sec). If during a fit this timeout is reached, <tt class="docutils literal"><span class="pre">musrfit</span></tt> will terminate. This is used to prevent orphan <tt class="docutils literal"><span class="pre">musrfit</span></tt> processes to jam the system.</dd>
<dt><strong>- -help</strong></dt>
<dt><strong>&#8211;help</strong></dt>
<dd>displays a small help notice in the shell explaining the basic usage of the program.</dd>
<dt><strong>- -version</strong></dt>
<dt><strong>&#8211;version</strong></dt>
<dd>prints the version number of <tt class="docutils literal"><span class="pre">musrfit</span></tt></dd>
</dl>
<p>If called with a msr input file, <em>e.g.</em></p>
@ -101,22 +103,22 @@
<dl class="docutils">
<dt><strong>&lt;msr_file&gt;</strong></dt>
<dd>name of the msr input or output file to be displayed. This is the only mandatory parameter.</dd>
<dt><strong>- -help</strong></dt>
<dt><strong>&#8211;help</strong></dt>
<dd>displays a small help notice in the shell explaining the basic usage of the program.</dd>
<dt><strong>- -version</strong></dt>
<dt><strong>&#8211;version</strong></dt>
<dd>prints the version number of <tt class="docutils literal"><span class="pre">musrview</span></tt>.</dd>
<dt><strong>-f, - -fourier</strong></dt>
<dt><strong>-f, &#8211;fourier</strong></dt>
<dd>will directly present the Fourier transform of the &lt;msr_file&gt; with Fourier options as defined in the &lt;msr_file&gt;.</dd>
<dt><strong>-a, - -avg</strong></dt>
<dt><strong>-a, &#8211;avg</strong></dt>
<dd>will directly present the averaged data/Fourier of the &lt;msr_file&gt;.</dd>
<dt><strong>-1, - -one_to_one</strong></dt>
<dt><strong>-1, &#8211;one_to_one</strong></dt>
<dd>calculate the theory points <em>only</em> at the data points.</dd>
<dt><strong>- -&lt;graphic_format_extension&gt;</strong></dt>
<dt><strong>&#8211;&lt;graphic_format_extension&gt;</strong></dt>
<dd>will produce a graphics output file without starting a ROOT session. The filename is based on the name of the &lt;msr_file&gt;, <em>e.g.</em> 8472.msr will result in 8472_0.png.
Supported values for <tt class="docutils literal"><span class="pre">&lt;graphic_format_extension&gt;</span></tt> are <em>eps</em>, <em>pdf</em>, <em>gif</em>, <em>jpg</em>, <em>png</em>, <em>svg</em>, <em>xpm</em>, and, <em>root</em>.</dd>
<dt><strong>- -ascii</strong></dt>
<dt><strong>&#8211;ascii</strong></dt>
<dd>will generate an ascii dump of the data and theory as plotted.</dd>
<dt><strong>- -timeout &lt;timeout&gt;</strong></dt>
<dt><strong>&#8211;timeout &lt;timeout&gt;</strong></dt>
<dd>&lt;timeout&gt; given in seconds after which <tt class="docutils literal"><span class="pre">musrview</span></tt> terminates. If &lt;timeout&gt; <span class="math">\(\leq\)</span> 0, no timeout will take place. Default for &lt;timeout&gt; is 0.</dd>
</dl>
<p>If called with a msr file and the <tt class="docutils literal"><span class="pre">--&lt;graphic_format_extension&gt;</span></tt> option, <em>e.g.</em></p>
@ -175,55 +177,55 @@ Supported values for <tt class="docutils literal"><span class="pre">&lt;graphic_
<dd><dl class="first last docutils">
<dt><strong>&lt;msr_files&gt;</strong></dt>
<dd>msr-file name(s). These msr-files are used for the Fourier transform. It can be a list of msr-files, <em>e.g.</em> <tt class="docutils literal"><span class="pre">musrFT</span> <span class="pre">3110.msr</span> <span class="pre">3111.msr</span></tt></dd>
<dt><strong>-df, - -data-file &lt;data-file&gt;</strong></dt>
<dt><strong>-df, &#8211;data-file &lt;data-file&gt;</strong></dt>
<dd>This allows to feed only μSR data file(s) to perform the Fourier transform. Since the extended &lt;msr-file&gt; information are missing, they will need to be provided by to options, or <tt class="docutils literal"><span class="pre">musrFT</span></tt> tries to guess, based on <a class="reference internal" href="#musrfit-startup"><em>musrfit_startup.xml</em></a> settings.</dd>
</dl>
</dd>
<dt><strong>Options</strong></dt>
<dd><dl class="first last docutils">
<dt><strong>- -help</strong></dt>
<dt><strong>&#8211;help</strong></dt>
<dd>display a help and exit.</dd>
<dt><strong>- -version</strong></dt>
<dt><strong>&#8211;version</strong></dt>
<dd>output version information and exit.</dd>
<dt><strong>-g, - -graphic-format &lt;graphic-format-extension&gt;</strong></dt>
<dt><strong>-g, &#8211;graphic-format &lt;graphic-format-extension&gt;</strong></dt>
<dd>will produce a graphic-output-file without starting a root session. The name is based either on the &lt;msr-file&gt; or the &lt;data-file&gt;, <em>e.g.</em> <tt class="docutils literal"><span class="pre">3310.msr</span> <span class="pre">-&gt;</span> <span class="pre">3310_0.png</span></tt>. Supported graphic-format-extension: <em>eps</em>, <em>pdf</em>, <em>gif</em>, <em>jpg</em>, <em>png</em>, <em>svg</em>, <em>xpm</em>, and <em>root</em>.</dd>
<dt><strong>- -dump &lt;fln&gt;</strong></dt>
<dt><strong>&#8211;dump &lt;fln&gt;</strong></dt>
<dd>rather than starting a root session and showing Fourier graphs of the data, it will output the Fourier data in an ascii file &lt;fln&gt;.</dd>
<dt><strong>-br, - -background-range &lt;start&gt; &lt;end&gt;</strong></dt>
<dt><strong>-br, &#8211;background-range &lt;start&gt; &lt;end&gt;</strong></dt>
<dd>background interval used to estimate the background to be subtracted before the Fourier transform. &lt;start&gt;, &lt;end&gt; to be given in bins.</dd>
<dt><strong>-bg, - -background</strong></dt>
<dt><strong>-bg, &#8211;background</strong></dt>
<dd>gives the background explicit for each histogram.</dd>
<dt><strong>-fo, - -fourier-option &lt;fopt&gt;</strong></dt>
<dt><strong>-fo, &#8211;fourier-option &lt;fopt&gt;</strong></dt>
<dd>&lt;fopt&gt; can be &#8216;<em>real</em>&#8216;, &#8216;<em>imag</em>&#8216;, &#8216;<em>real+imag</em>&#8216;, &#8216;<em>power</em>&#8216;, or &#8216;<em>phase</em>&#8216;. If this is not defined (neither on the command line nor in the <a class="reference internal" href="#musrfit-startup"><em>musrfit_startup.xml</em></a>) &#8216;<em>power</em>&#8216; will be used.</dd>
<dt><strong>-ap, - -apodization &lt;val&gt;</strong></dt>
<dt><strong>-ap, &#8211;apodization &lt;val&gt;</strong></dt>
<dd>&lt;val&gt; can be either &#8216;<em>none</em>&#8216;, &#8216;<em>weak</em>&#8216;, &#8216;<em>medium</em>&#8216;, &#8216;<em>strong</em>&#8216;. Default will be &#8216;<em>none</em>&#8216;.</dd>
<dt><strong>-fp, - -fourier-power &lt;N&gt;</strong></dt>
<dt><strong>-fp, &#8211;fourier-power &lt;N&gt;</strong></dt>
<dd>&lt;N&gt; being the Fourier power, i.e. <tt class="docutils literal"><span class="pre">2^&lt;N&gt;</span></tt> used for zero padding. Default is -1, i.e. <em>no</em> zero padding will be performed.</dd>
<dt><strong>-u, - -units &lt;units&gt;</strong></dt>
<dt><strong>-u, &#8211;units &lt;units&gt;</strong></dt>
<dd>&lt;units&gt; is used to define the abscissa of the Fourier transform. One may choose between the fields (<em>Gauss</em>) or (<em>Tesla</em>), the frequency (<em>MHz</em>), and the angular-frequency domain (<em>Mc/s</em>). Default will be &#8216;<em>MHz</em>&#8216;.</dd>
<dt><strong>-ph, - -phase &lt;val&gt;</strong></dt>
<dt><strong>-ph, &#8211;phase &lt;val&gt;</strong></dt>
<dd>defines the initial phase &lt;val&gt;. This only is of concern for &#8216;<em>real</em>&#8216;, &#8216;<em>imag</em>&#8216;, and &#8216;<em>real+imag</em>&#8216;. Default will be 0.0.</dd>
<dt><strong>-fr, - -fourier-range &lt;start&gt; &lt;end&gt;</strong></dt>
<dt><strong>-fr, &#8211;fourier-range &lt;start&gt; &lt;end&gt;</strong></dt>
<dd>Fourier range. &lt;start&gt;, &lt;end&gt; are interpreted in the units given. Default will be -1.0 for both which means, take the full Fourier range.</dd>
<dt><strong>-tr, - -time-range &lt;start&gt; &lt;end&gt;</strong></dt>
<dt><strong>-tr, &#8211;time-range &lt;start&gt; &lt;end&gt;</strong></dt>
<dd>time domain range to be used for Fourier transform. &lt;start&gt;, &lt;end&gt; are to be given in (μs). If nothing is provided, the full time range found in the data file(s) will be used.</dd>
<dt><strong>- -histo &lt;list&gt;</strong></dt>
<dt><strong>&#8211;histo &lt;list&gt;</strong></dt>
<dd>give the &lt;list&gt; of histograms to be used for the Fourier transform. <em>E.g.</em> <tt class="docutils literal"><span class="pre">musrFT</span> <span class="pre">-df</span> <span class="pre">lem15_his_01234.root</span> <span class="pre">--histo</span> <span class="pre">1</span> <span class="pre">3</span></tt>, will only be needed together with the option <tt class="docutils literal"><span class="pre">--data-file</span></tt>. If multiple data files are given, &lt;list&gt; will apply to all data-files given. If <tt class="docutils literal"><span class="pre">--histo</span></tt> is not given, <em>all</em> histos of a data file will be used. &lt;list&gt; can be anything like: 2 3 6, or 2-17, or 1-6 9, etc.</dd>
<dt><strong>-a, - -average</strong></dt>
<dt><strong>-a, &#8211;average</strong></dt>
<dd>show the average of all <strong>ALL</strong> Fourier transformed data.</dd>
<dt><strong>-ad, - -average-per-data-set</strong></dt>
<dt><strong>-ad, &#8211;average-per-data-set</strong></dt>
<dd>show the average of <strong>per-data-set</strong> Fourier transformed data.</dd>
<dt><strong>- -t0 &lt;list&gt;</strong></dt>
<dd>A list of t0&#8217;s can be provided. This in conjunction with <tt class="docutils literal"><span class="pre">--data-file</span></tt> and <tt class="docutils literal"><span class="pre">--fourier-option</span> <span class="pre">real</span></tt> allows to get the proper initial phase if t0&#8217;s are known. If a single t0 for multiple histos is given, it is assume, that this t0 is common to <em>all</em> histos. Example: <tt class="docutils literal"><span class="pre">musrFT</span> <span class="pre">-df</span> <span class="pre">lem15_his_01234.root</span> <span class="pre">-fo</span> <span class="pre">real</span> <span class="pre">--t0</span> <span class="pre">2750</span> <span class="pre">--histo</span> <span class="pre">1</span> <span class="pre">3</span></tt>.</dd>
<dt><strong>-pa, - -packing &lt;N&gt;</strong></dt>
<dt><strong>-pa, &#8211;packing &lt;N&gt;</strong></dt>
<dd>if &lt;N&gt; (an integer), the time domain data will first be packed/rebinned by &lt;N&gt;.</dd>
<dt><strong>- -title &lt;title&gt;</strong></dt>
<dt><strong>&#8211;title &lt;title&gt;</strong></dt>
<dd>give a global title for the plot.</dd>
<dt><strong>- -create-msr-file &lt;fln&gt;</strong></dt>
<dt><strong>&#8211;create-msr-file &lt;fln&gt;</strong></dt>
<dd>creates a msr-file based on the command line options provided. This will help on the way to a full fitting model.</dd>
<dt><strong>-lc, - -lifetimecorrection &lt;fudge&gt;</strong></dt>
<dt><strong>-lc, &#8211;lifetimecorrection &lt;fudge&gt;</strong></dt>
<dd>try to eliminate the muon life time decay. Only makes sense for low transverse fields. &lt;fudge&gt; is a tweaking factor (scaling factor for the estimated t0) and should be kept around 1.0.</dd>
<dt><strong>- -timeout &lt;timeout&gt;</strong></dt>
<dt><strong>&#8211;timeout &lt;timeout&gt;</strong></dt>
<dd>&lt;timeout&gt; given in seconds after which <tt class="docutils literal"><span class="pre">musrFT</span></tt> terminates. If &lt;timeout&gt; <span class="math">\(\leq\)</span> 0, no timeout will take place. Default &lt;timeout&gt; is 3600 sec.</dd>
</dl>
</dd>
@ -277,13 +279,13 @@ Supported values for <tt class="docutils literal"><span class="pre">&lt;graphic_
<dl class="docutils">
<dt><strong>&lt;msr_file&gt;</strong></dt>
<dd>name of an msr file.</dd>
<dt><strong>-g, - -getT0FromPromptPeak [&lt;firstGoodBinOffset&gt;]</strong></dt>
<dt><strong>-g, &#8211;getT0FromPromptPeak [&lt;firstGoodBinOffset&gt;]</strong></dt>
<dd>tries to estimate t0 from the prompt peak (maximum entry) in each histogram and writes the corresponding values to the t0 lines in the <a class="reference internal" href="#msr-run-block"><em>RUN blocks</em></a> of the msr file. If an optional number &lt;firstGoodBinOffset&gt; is given, the lower limit of the data range will be set to t0 + &lt;firstGoodBinOffset&gt;.</dd>
<dt><strong>- -timeout &lt;timeout&gt;</strong></dt>
<dt><strong>&#8211;timeout &lt;timeout&gt;</strong></dt>
<dd>&lt;timeout&gt; given in seconds after which musrview terminates. If &lt;timeout&gt; <span class="math">\(\leq\)</span> 0, no timeout will take place. Default for &lt;timeout&gt; is 0.</dd>
<dt><strong>- -help</strong></dt>
<dt><strong>&#8211;help</strong></dt>
<dd>displays a small help notice in the shell explaining the basic usage of the program.</dd>
<dt><strong>- -version</strong></dt>
<dt><strong>&#8211;version</strong></dt>
<dd>prints the version number of musrt0.</dd>
</dl>
<p>The interactive mode of <tt class="docutils literal"><span class="pre">musrt0</span></tt> is started if the program is called with a sole msr-file argument, <em>e.g.</em></p>
@ -327,7 +329,7 @@ Supported values for <tt class="docutils literal"><span class="pre">&lt;graphic_
<dd>input WKM msr file (mandatory first parameter).</dd>
<dt><strong>&lt;msr_file_out&gt;</strong></dt>
<dd>converted output musrfit msr file (mandatory second parameter).</dd>
<dt><strong>- -help</strong></dt>
<dt><strong>&#8211;help</strong></dt>
<dd>displays a small help notice in the shell explaining the basic usage of the program.</dd>
</dl>
<p>A typical example then looks like:</p>
@ -410,13 +412,13 @@ Supported values for <tt class="docutils literal"><span class="pre">&lt;graphic_
<span id="index-9"></span><h3>dump_header<a class="headerlink" href="#dump-header" title="Permalink to this headline"></a></h3>
<p><tt class="docutils literal"><span class="pre">dump_header</span></tt> is a little program which tries to read a μSR data file and sends the relevant information (required header info, start of the histos, etc.) to the standard output. Currently the following μSR data file formats are supported: <em>MusrROOT</em>, <em>ROOT</em> (old LEM format), <em>PSI-BIN</em>, <em>PSI-MDU</em>, <em>NeXus</em> (IDF1 and IDF2), <em>MUD</em>, and <em>WKM</em>.</p>
<dl class="docutils">
<dt><strong>-rn, - -runNo &lt;runNo&gt;</strong></dt>
<dt><strong>-rn, &#8211;runNo &lt;runNo&gt;</strong></dt>
<dd>run number of the header to be dumped.</dd>
<dt><strong>-fn, - -fileName &lt;fileName&gt;</strong></dt>
<dt><strong>-fn, &#8211;fileName &lt;fileName&gt;</strong></dt>
<dd>muSR data file name.</dd>
<dt><strong>-ff, - -fileFormat &lt;fileFormat&gt;</strong></dt>
<dt><strong>-ff, &#8211;fileFormat &lt;fileFormat&gt;</strong></dt>
<dd>where &lt;fileFormat&gt; is one of the above listed ones.</dd>
<dt><strong>-y, - -year &lt;year&gt;</strong></dt>
<dt><strong>-y, &#8211;year &lt;year&gt;</strong></dt>
<dd>&lt;year&gt; has to be a 4 digit value, <em>e.g.</em> 2005, if provided it is used to generate the file name for the given &lt;runNo&gt;, otherwise the current year is used. If a file name is given, this option has no effect.</dd>
<dt><strong>-s, &#8211;summary</strong></dt>
<dd>this option is used for LE-μSR data sets only. It will, additionally to the header information, print the summary file content.</dd>
@ -2601,107 +2603,22 @@ here:</p>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">User manual</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#available-executables-configuration-files-and-their-basic-usage">Available Executables, Configuration Files and their Basic Usage</a><ul>
<li><a class="reference internal" href="#musrfit">musrfit</a></li>
<li><a class="reference internal" href="#musrview">musrview</a></li>
<li><a class="reference internal" href="#musrft">musrFT</a></li>
<li><a class="reference internal" href="#musrt0">musrt0</a></li>
<li><a class="reference internal" href="#msr2msr">msr2msr</a></li>
<li><a class="reference internal" href="#msr2data">msr2data</a></li>
<li><a class="reference internal" href="#any2many">any2many</a></li>
<li><a class="reference internal" href="#dump-header">dump_header</a></li>
<li><a class="reference internal" href="#musrfit-startup-xml">musrfit_startup.xml</a></li>
</ul>
</li>
<li><a class="reference internal" href="#description-of-the-msr-file-format">Description of the msr File Format</a><ul>
<li><a class="reference internal" href="#the-title">The Title</a></li>
<li><a class="reference internal" href="#the-fitparameter-block">The FITPARAMETER Block</a></li>
<li><a class="reference internal" href="#the-theory-block">The THEORY Block</a></li>
<li><a class="reference internal" href="#the-functions-block">The FUNCTIONS Block</a></li>
<li><a class="reference internal" href="#the-global-block">The GLOBAL Block</a></li>
<li><a class="reference internal" href="#the-run-block">The RUN Block</a></li>
<li><a class="reference internal" href="#the-commands-block">The COMMANDS Block</a></li>
<li><a class="reference internal" href="#the-fourier-block">The FOURIER Block</a></li>
<li><a class="reference internal" href="#the-plot-block">The PLOT Block</a></li>
<li><a class="reference internal" href="#the-statistic-block">The STATISTIC Block</a></li>
</ul>
</li>
<li><a class="reference internal" href="#fit-types">Fit Types</a><ul>
<li><a class="reference internal" href="#single-histogram-fit-fit-type-0">Single Histogram Fit (fit type 0)</a></li>
<li><a class="reference internal" href="#single-histogram-rrf-fit-fit-type-1">Single Histogram RRF Fit (fit type 1)</a></li>
<li><a class="reference internal" href="#asymmetry-fit-fit-type-2">Asymmetry Fit (fit type 2)</a></li>
<li><a class="reference internal" href="#asymmetry-rrf-fit-fit-type-3">Asymmetry RRF Fit (fit type 3)</a></li>
<li><a class="reference internal" href="#negative-muon-mgrsr-fit-fit-type-4">Negative Muon μSR Fit (fit type 4)</a></li>
<li><a class="reference internal" href="#beta-nmr-asymmetry-fit-fit-type-5">beta-NMR Asymmetry Fit (fit type 5)</a></li>
<li><a class="reference internal" href="#non-mgrsr-fit-fit-type-8">Non-μSR Fit (fit type 8)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#id38">User Functions</a><ul>
<li><a class="reference internal" href="#user-function-without-global-user-function-object-access">User Function without global user-function-object access</a></li>
<li><a class="reference internal" href="#user-function-with-global-user-function-object-access">User Function with global user-function-object access</a></li>
<li><a class="reference internal" href="#rge-file-handler-for-low-energy-mgrsr">rge-file handler for Low-Energy μSR</a></li>
</ul>
</li>
<li><a class="reference internal" href="#technical-description-of-the-musrfit-framework">Technical Description of the musrfit framework</a></li>
</ul>
</li>
</ul>
<div class="bottomnav">
<p>
«&#160;&#160;<a href="tutorial.html">Tutorial for <tt class="docutils literal"><span class="pre">musrfit</span></tt></a>
&#160;&#160;::&#160;&#160;
<a class="uplink" href="index.html">Contents</a>
&#160;&#160;::&#160;&#160;
<a href="user-libs.html">Documentation of user libs (user functions)</a>&#160;&#160;»
</p>
<h4>Previous topic</h4>
<p class="topless"><a href="tutorial.html"
title="previous chapter">Tutorial for <tt class="docutils literal"><span class="pre">musrfit</span></tt></a></p>
<h4>Next topic</h4>
<p class="topless"><a href="user-libs.html"
title="next chapter">Documentation of user libs (user functions)</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/user-manual.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="user-libs.html" title="Documentation of user libs (user functions)"
>next</a> |</li>
<li class="right" >
<a href="tutorial.html" title="Tutorial for musrfit"
>previous</a> |</li>
<li><a href="index.html">musrfit 1.7.4 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2021, Andreas Suter.
Last updated on Aug 06, 2021.
Last updated on Oct 06, 2021.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>