musrfit/doc/html/user/MUSR/MusrGui.html

399 lines
34 KiB
HTML

<!DOCTYPE html><html lang="en">
<!-- Mirrored from intranet.psi.ch/MUSR/MusrGui?cover=print by HTTrack Website Copier/3.x [XR&CO'2010], Fri, 16 Dec 2016 16:00:59 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8"><!-- /Added by HTTrack -->
<head>
<link rel="stylesheet" href="../pub/System/HeadlinesPlugin/style.css" type="text/css" media="all" />
<title> MUSR :: MusrGui</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.5, user-scalable=yes" />
<meta name="mobile-web-app-capable" content="yes" />
<meta name="mobile-web-app-status-bar-style" content="black-translucent" />
<meta name="apple-mobile-web-app-capable" content="yes" />
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
<link rel="icon" href="../pub/Main/WebPreferences/favicon.ico" type="image/x-icon" />
<link rel="shortcut icon" href="../pub/Main/WebPreferences/favicon.ico" type="image/x-icon" />
<link rel="alternate" href="https://intranet.psi.ch/wiki/bin/edit/MUSR/MusrGui?t=1481904043" type="application/x-wiki" title="edit MusrGui" />
<meta name="TEXT_NUM_TOPICS" content="Number of topics:" />
<meta name="TEXT_MODIFY_SEARCH" content="Modify search" />
<meta name="robots" content="noindex" /><link rel="alternate" type="application/rss+xml" title="RSS Feed" href="WebRsshtml.html" />
<base /><!--[if IE]></base><![endif]--><link class='head CLASSIFICATIONPLUGIN::CSS' rel="stylesheet" href="../pub/System/ClassificationPlugin/styles.css" media="all" /><!--CLASSIFICATIONPLUGIN::CSS-->
<link class='head SMILIESPLUGIN' rel='stylesheet' href='../pub/System/SmiliesPlugin/smilies.css' type='text/css' media='all' /><!--SMILIESPLUGIN-->
<link class='head FOOTNOTEPLUGIN_LINKCSS' rel="stylesheet" href="../pub/System/FootNotePlugin/styles.css" type="text/css" media="all" /><!--FOOTNOTEPLUGIN_LINKCSS-->
<link class='head JQUERYPLUGIN::COMMENT' rel='stylesheet' href='../pub/System/CommentPlugin/commentf5b6.css?version=3.0' type='text/css' media='all' /><!--JQUERYPLUGIN::COMMENT-->
<style class='head TABLEPLUGIN_default' type="text/css" media="all">
body .foswikiTable {border-width:1px}
body .foswikiTable .tableSortIcon img {padding-left:.3em; vertical-align:text-bottom}
body .foswikiTable td {border-style:solid none; vertical-align:top}
body .foswikiTable th {border-style:none solid; vertical-align:top; background-color:#d6d3cf; color:#000000}
body .foswikiTable th a:link {color:#000000}
body .foswikiTable th a:visited {color:#000000}
body .foswikiTable th a:hover {color:#000000; background-color:#d6d3cf}
body .foswikiTable th.foswikiSortedCol {background-color:#c4c1ba}
body .foswikiTable tr.foswikiTableRowdataBg0 td {background-color:#ffffff}
body .foswikiTable tr.foswikiTableRowdataBg0 td.foswikiSortedCol {background-color:#f7f7f6}
body .foswikiTable tr.foswikiTableRowdataBg1 td {background-color:#f7f7f6}
body .foswikiTable tr.foswikiTableRowdataBg1 td.foswikiSortedCol {background-color:#f0f0ee}
</style><!--TABLEPLUGIN_default-->
<style class='head TABLEPLUGIN_specific' type="text/css" media="all">
body .foswikiTable#tableMusrGui1 td {vertical-align:middle; vertical-align:top}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol0 {text-align:left}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol1 {text-align:left}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol2 {text-align:left}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol3 {text-align:right}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol4 {text-align:left}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol5 {text-align:left}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol6 {text-align:left}
body .foswikiTable#tableMusrGui1 td.foswikiTableCol7 {text-align:left}
body .foswikiTable#tableMusrGui1 th {vertical-align:middle; background-color:#ffffff; color:#0066cc; text-align:left}
body .foswikiTable#tableMusrGui1 th a:link {color:#0066cc}
body .foswikiTable#tableMusrGui1 th a:visited {color:#0066cc}
body .foswikiTable#tableMusrGui1 th a:hover {color:#0066cc; background-color:#ffffff}
body .foswikiTable#tableMusrGui1 th.foswikiSortedCol {background-color:#eeeeee}
body .foswikiTable#tableMusrGui1 tr.foswikiTableRowdataBg0 td {background-color:#ffffff}
body .foswikiTable#tableMusrGui1 tr.foswikiTableRowdataBg0 td.foswikiSortedCol {background-color:#f5f5f5}
</style><!--TABLEPLUGIN_specific-->
<link class='head JQUERYPLUGIN::TWISTY' rel='stylesheet' href='../pub/System/TwistyPlugin/twisty327a.css?version=1.6.0' type='text/css' media='all' /><!--JQUERYPLUGIN::TWISTY: requires= missing ids: JavascriptFiles/foswikiPref-->
<link class='head IMAGEPLUGIN' rel="stylesheet" href="../pub/System/ImagePlugin/style.css" type="text/css" media="all" /><!--IMAGEPLUGIN--><link rel='stylesheet' href='../pub/System/SkinTemplates/base.css' media='all' type='text/css' />
<style type="text/css" media="all">
@import url('../pub/System/PatternSkinTheme/layout.css');
@import url('../pub/System/PatternSkinTheme2009/style.css');
@import url('../pub/System/PatternSkinTheme2009/colors.css');
</style>
<link rel='stylesheet' href='../pub/System/PatternSkinTheme2009/column_left.css' media='all' type='text/css' />
<link rel='stylesheet' href='../pub/System/PatternSkinTheme2009/variant_twiki.css' media='all' type='text/css' /><style type="text/css" media="all">
/* Styles that are set using variables */
.patternBookView .foswikiTopRow,
.patternWebIndicator,
.patternWebIndicator a {
background-color:#D0D0D0;
}
#patternTopBarContents { background-image:url(../pub/System/PatternSkin/header5.gif); background-repeat:repeat-x;}
#patternTopBarContents { background-color:#ffffff;}
.patternBookView {
border-color:#D0D0D0;
}
.patternPreviewPage #patternMain {
/* uncomment to set the preview image */
/*background-image:url("/pub/System/PreviewBackground/preview2bg.gif");*/
}
</style>
<style type="text/css" media="all">
@import url("../pub/System/PsiSkin/psicolors.css");
@import url("../pub/System/PsiSkin/psistyle.css");
.foswikiTopic {overflow: hidden;}
</style>
<link rel='stylesheet' href='../pub/System/PatternSkin/print.css' media='all' type='text/css' />
<!--[if IE 7 ]><style type="text/css" media="screen">
.foswikiAttachments,
.foswikiForm,
.foswikiHelp,
.foswikiPreviewArea,
.patternPreviewPage .foswikiForm,
.patternSigLine,
.patternToolBar,
.patternTop,
.patternTopicAction,
#patternSideBarContents .patternLeftBarPersonal,
#patternSideBarContents h2,
#patternSideBarContents li,
#patternTopBarButtons ul {
height:1%;
}
#patternSideBarContents .patternLeftBarPersonal {
width:100%;
}
.foswikiFormStep {
height:100%;
}
#foswikiLogin {
margin-left: 25%;
margin-right: 25%;
}
#foswikiLogin .foswikiFormSteps {
width:auto;
}
#foswikiLogin input[type="text"],
#foswikiLogin input[type="password"] {
width: auto;
}
.patternShadow {
border:10px solid #fff;
margin-top:10px;
margin-bottom:10px;
border:2px solid #ccc;
}
</style><![endif]-->
<!--[if lte IE 9]>
<![endif]-->
<!--[if gt IE 9]><!-->
<!--<![endif]-->
<!--JQUERYPLUGIN-->
<!--JQUERYPLUGIN::MIGRATE-->
<!--JQUERYPLUGIN::LIVEQUERY-->
<!--JQUERYPLUGIN::FOSWIKI-->
<!--JavascriptFiles/foswikiString-->
<!--JavascriptFiles/foswikiPref-->
<!--JavascriptFiles/foswikiForm-->
<!--PatternSkin/pattern-->
<!--JQUERYPLUGIN::METADATA-->
<!--JQUERYPLUGIN::CHILI-->
<!--JQUERYPLUGIN::FOSWIKI::PREFERENCES-->
<!--JQUERYPLUGIN::TWISTY-->
<!--JQUERYPLUGIN::COMMENT--><link class='head FOOTNOTEPLUGIN_LINKCSS' rel="stylesheet" href="../pub/System/FootNotePlugin/styles.css" type="text/css" media="all" /><!--FOOTNOTEPLUGIN_LINKCSS-->
</head>
<body class="foswikiNoJs patternViewPage patternPrintPage">
<span id="PageTop"></span><div class="foswikiPage"><div id="patternScreen">
<div id="patternPageShadow">
<div id="patternPage">
<div id="patternOuter" class="clear">
<div id="patternFloatWrap">
<div id="patternMain">
<div id="patternMainContents">
<div class="patternContent"><div class="foswikiTopic">
<h1 id="A_61_61musredit_47_40musrgui_41_61_61"> <code><b>musredit / (musrgui)</b></code> </h1>
<p></p>
<div class="foswikiToc" id="foswikiTOC"> <ul>
<li> <a href="MusrGui.html#A_61_61musredit_47_40musrgui_41_61_61"> musredit / (musrgui) </a>
</li> <li> <a href="MusrGui.html#A_1_Introduction"> 1 Introduction </a>
</li> <li> <a href="MusrGui.html#A_2_Available_Executables_44_Configuration_Files_and_their_Basic_Usage"> 2 Available Executables, Configuration Files and their Basic Usage </a> <ul>
<li> <a href="MusrGui.html#A_2.1_musredit_47_40musrgui_41"> 2.1 musredit / (musrgui) </a>
</li> <li> <a href="MusrGui.html#A_2.2_musredit_startup.xml_47_musrgui_startup.xml"> 2.2 musredit_startup.xml / musrgui_startup.xml </a>
</li></ul>
</li> <li> <a href="MusrGui.html#A_3_61_61musrfit_61_61_Features"> 3 musrfit Features </a>
</li> <li> <a href="MusrGui.html#A_4_Editor_Features"> 4 Editor Features </a>
</li> <li> <a href="MusrGui.html#A_5_Bugtracking"> 5 Bugtracking </a>
</li></ul>
</div>
<p></p>
<h1 id="A_1_Introduction"> 1 Introduction </h1>
<code>musredit</code> and <code>musrgui</code> are editors which also provide a graphical user interface to the programs contained in the <code><a href="MusrFit.html">musrfit</a></code> suite and are intended to help the user handle <code>musrfit</code> msr files. They are implemented in <code>C++</code> and use the <a href="http://qt.nokia.com/">Qt</a> framework. Principally, <code>musrgui</code> and <code>musredit</code> are doing the same, but are based on different Qt versions. <code>musrgui</code> is based on Qt 3.x and will only be maintained on bug-fixing level since the Qt 3.x licensing is less straight forward than the Qt 4.x one. <code>musredit</code> is based on Qt 4.6 (or above) and this is the program which will be developed further.<br>
On this documentation page only the features related to <code>musrfit</code> are described&mdash;the basic editor functions which should be self-explanatory are not.
<strong><span class='foswikiRedFG'>Before going on using <code>musrgui</code> / <code>musredit</code> it is strongly recommended to read the <a href="MusrFit.html">manual</a> of <code>musrfit</code> first!</span></strong>
<p></p>
<h1 id="A_2_Available_Executables_44_Configuration_Files_and_their_Basic_Usage"> 2 Available Executables, Configuration Files and their Basic Usage </h1>
<span id="MusrEdit"></span>
<h2 id="A_2.1_musredit_47_40musrgui_41"> 2.1 musredit / (musrgui) </h2>
<code>musredit</code> / <code>musrgui</code> are the editor executables. If called from within a shell they accept a few optional parameters: <dl>
<dt> &lt;msr_files&gt; </dt><dd> file names of the msr files that should be opened in separate editor tabs on startup of <code>musrgui</code> / <code>musredit</code>.
</dd> <dt> --help </dt><dd> displays a small help notice in the shell explaining the basic usage of the program
</dd> <dt> --version </dt><dd> prints the version number of <code>musrgui</code> / <code>musredit</code>
</dd></dl>
<p></p>
If called without any parameters an empty editor window opens.
<p></p>
<span id="MusreditStartupXml"></span>
<h2 id="A_2.2_musredit_startup.xml_47_musrgui_startup.xml"> 2.2 musredit_startup.xml / musrgui_startup.xml </h2>
<code><b>musredit_startup.xml</b></code> / <code><b>musrgui_startup.xml</b></code> are configuration files located at the <code>musredit</code> / <code>musrgui</code> binary path. It is also possible to have another version of this file in the working directory which then will be used!
<p></p>
In this file the following XML tags are allowed to define settings and might proof useful for all users of <code>musredit</code> / <code>musrgui</code>: <dl>
<dt> &lt;general&gt;&lt;/general&gt; </dt><dd> set the default paths to executables and files in this environment <dl>
<dt> &lt;exec_path&gt;PATH_TO_EXEC&lt;/exec_path&gt; </dt><dd> set the path <strong>PATH_TO_EXEC</strong> where the executables <code>musrfit</code>, <code>musrview</code>, <code>musrt0</code>, etc. can be found (inside the &lt;general&gt; environment)
</dd> <dt> &lt;default_save_path&gt;SAV_PATH&lt;/default_save_path&gt; </dt><dd> specify the path <strong>SAV_PATH</strong> where <code>musrgui</code> / <code>musredit</code> point by default when opening and saving msr files (inside the &lt;general&gt; environment)
</dd> <dt> &lt;msr_default_file_path&gt;MSR_DEF_PATH&lt;/msr_default_file_path&gt; </dt><dd> set the path <strong>MSR_DEF_PATH</strong> where the <a class="foswikiCurrentTopicLink" href="#MusrfitFeatures">default msr files provided by</a> <code>musrgui</code> are stored (inside the &lt;general&gt; environment)
</dd> <dt> &lt;title_from_data_file&gt;y/n&lt;/title_from_data_file&gt; </dt><dd> specify if <code>musrfit</code> should be called with the <a href="MusrFit.html#MusrFit">-t option</a> by default (inside the &lt;general&gt; environment)
</dd> <dt> &lt;enable_musrt0&gt;y/n&lt;/enable_musrt0&gt; </dt><dd> specify if <code><a href="MusrFit.html#MusrT0">musrt0</a></code> can be called from within <code>musrgui</code> / <code>musredit</code> (inside the &lt;general&gt; environment)
</dd></dl>
</dd> <dt> &lt;font_settings&gt;&lt;/font_settings&gt; </dt><dd> set the default font in this environment <dl>
<dt> &lt;font_name&gt;FONT&lt;/font_name&gt; </dt><dd> specify the name of the font <strong>FONT</strong> to be used by default in <code>musrgui</code> / <code>musredit</code> (inside the &lt;font_settings&gt; environment)
</dd> <dt> &lt;font_size&gt;N&lt;/font_size&gt; </dt><dd> specify the size <strong>N</strong> of the font to be used by default in <code>musrgui</code> / <code>musredit</code> (inside the &lt;font_settings&gt; environment)
</dd></dl>
</dd> <dt> &lt;msr_file_defaults&gt;&lt;/msr_file_defaults&gt; </dt><dd> put the default settings for newly created msr files in this environment <dl>
<dt> &lt;beamline&gt;BL&lt;/beamline&gt; </dt><dd> set the name of the muon beamline <strong>BL</strong> here (inside a &lt;msr_file_defaults&gt;-environment)
</dd> <dt> &lt;institute&gt;INST&lt;/institute&gt; </dt><dd> set the name of the facility <strong>INST</strong> where the beamline <strong>BL</strong> is located. Valid settings are <strong>PSI</strong>, <strong>RAL</strong>, <strong>JPARC</strong>, and <strong>TRIUMF</strong> (inside a &lt;msr_file_defaults&gt; environment)
</dd> <dt> &lt;file_format&gt;FF&lt;/file_format&gt; </dt><dd> specify the default data file format <strong>FF</strong> here. Valid formats are <strong>NEXUS</strong>, <strong>ROOT-NPP</strong>, <strong>ROOT-PPC</strong>, <strong>PSI-BIN</strong>, <strong>PSI-MDU</strong>, <strong>MDU-ASCII</strong>, <strong>WKM</strong>, <strong>MUD</strong>, <strong>ASCII</strong>, and <strong>DB</strong> (inside a &lt;msr_file_defaults&gt; environment)
</dd> <dt> &lt;lifetime_correction&gt;y/n&lt;/lifetime_correction&gt; </dt><dd> choose if by default the <strong>lifetimecorrection</strong> <a href="MusrFit.html#LifeTimeCorrection">option</a> should be set (inside a &lt;msr_file_defaults&gt; environment)
</dd></dl>
</dd> <dt> &lt;msr2data_defaults&gt;&lt;/msr2data_defaults&gt; </dt><dd> define the default <a href="Msr2Data.html#OptionalParameters">options</a> for calling <code><a href="Msr2Data.html">msr2data</a></code> in this environment; the options set here are ticked by default in the <a href="Msr2Data.html#MusrGuiInterface">graphical interface</a> of <code>musrgui</code> / <code>musredit</code>. <dl>
<dt> &lt;chain_fit&gt;y/n&lt;/chain_fit&gt; </dt><dd> (un)set the chain fit (<strong>!</strong>) option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;write_data_header&gt;y/n&lt;/write_data_header&gt; </dt><dd> (un)set the <strong>noheader</strong> option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;ignore_data_header_info&gt;y/n&lt;/ignore_data_header_info&gt; </dt><dd> (un)set the <strong>nosummary</strong> option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;keep_minuit2_output&gt;y/n&lt;/keep_minuit2_output&gt; </dt><dd> (un)set the <strong>-k</strong> option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;write_column_data&gt;y/n&lt;/write_column_data&gt; </dt><dd> (un)set the <strong>data</strong> option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;create_msr_file_only&gt;y/n&lt;/create_msr_file_only&gt; </dt><dd> (un)set the <strong>msr</strong> option in case a template run is specified (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;fit_only&gt;y/n&lt;/fit_only&gt; </dt><dd> (un)set the <strong>fit</strong> option in case no template run is specified (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;global&gt;y/n&lt;/global&gt; </dt><dd> (un)set the <strong>global</strong> option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;global_plus&gt;y/n&lt;/global_plus&gt; </dt><dd> (un)set the <strong>global+</strong> option (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;recreate_data_file&gt;y/n&lt;/recreate_data_file&gt; </dt><dd> (un)set the <code>musrgui</code> / <code>musredit</code> option for recreating the output file (inside a &lt;msr2data_defaults&gt; environment)
</dd> <dt> &lt;open_file_after_fitting&gt;y/n&lt;/open_file_after_fitting&gt; </dt><dd> (un)set the <code>musrgui</code> / <code>musredit</code> option for opening msr files after fitting (inside a &lt;msr2data_defaults&gt; environment)
</dd></dl>
</dd></dl>
<p></p>
Additionally, there are some settings defined in this XML file which should be only changed by experienced users who like to add new features to <code>musrgui</code> / <code>musredit</code>: <dl>
<dt> &lt;help_section&gt;&lt;/help_section&gt; </dt><dd> define various help messages in this environment <dl>
<dt> &lt;help_main&gt;HELP TEXT&lt;/help_main&gt; </dt><dd> set the main help message <strong>HELP TEXT</strong> here (inside a &lt;help_section&gt; environment)
</dd></dl>
</dd> <dt> &lt;func_pixmap_path&gt;PIX_PATH&lt;/func_pixmap_path&gt; </dt><dd> set the path <strong>PIX_PATH</strong> to <img alt="LaTeX_logo.png" src="../pub/MUSR/MusrGui/LaTeX_logo.png" /> pixmaps visualizing the various supported theory functions
</dd> <dt> &lt;theory_functions&gt;&lt;/theory_functions&gt; </dt><dd> define the functions for a msr file's THEORY block <a href="MusrFit.html#TheoryTable">according to the correct syntax</a> in this environment <dl>
<dt> &lt;func&gt;&lt;/func&gt; </dt><dd> specify a function here (inside a &lt;theory_functions&gt; environment) <dl>
<dt> &lt;name&gt;NAME&lt;/name&gt; </dt><dd> the <strong>NAME</strong> of the function in the msr file (inside a &lt;func&gt; environment)
</dd> <dt> &lt;comment&gt;COMMENT&lt;/comment&gt; </dt><dd> description of the used parameters (inside a &lt;func&gt; environment)
</dd> <dt> &lt;label&gt;LABEL&lt;/label&gt; </dt><dd> <strong>LABEL</strong> of the function in the <code>musrgui</code> / <code>musredit</code> menu (inside a &lt;func&gt; environment)
</dd> <dt> &lt;pixmap&gt;PIXMAP&lt;/pixmap&gt; </dt><dd> <img alt="LaTeX_logo.png" src="../pub/MUSR/MusrGui/LaTeX_logo.png" /> picture used to describe the function and stored in the <strong>PIX_PATH</strong> (inside a &lt;func&gt; environment)
</dd> <dt> &lt;params&gt;N&lt;/params&gt; </dt><dd> number of parameters <strong>N</strong> used by the function (inside a &lt;func&gt; environment)
</dd></dl>
</dd></dl>
</dd></dl>
<p></p>
An example of the <code><b>musrgui_startup.xml</b></code> looks like:
<pre class="html">
&#60;?xml version&#61;&#34;1.0&#34; encoding&#61;&#34;UTF-8&#34;?&#62;
&#60;musrgui&#95;startup xmlns&#61;&#34;https://intranet.psi.ch/MUSR/MusrGui&#34;&#62;
&#60;general&#62;
&#60;exec&#95;path&#62;/usr/local/bin&#60;/exec&#95;path&#62;
&#60;default&#95;save&#95;path&#62;./&#60;/default&#95;save&#95;path&#62;
&#60;msr&#95;default&#95;file&#95;path&#62;/home/user/analysis/musrfit/src/musrgui&#60;/msr&#95;default&#95;file&#95;path&#62;
&#60;/general&#62;
&#60;font&#95;settings&#62;
&#60;font&#95;name&#62;Courier New&#60;/font&#95;name&#62;
&#60;font&#95;size&#62;10&#60;/font&#95;size&#62;
&#60;/font&#95;settings&#62;
&#60;msr&#95;file&#95;defaults&#62;
&#60;beamline&#62;mue4&#60;/beamline&#62;
&#60;institute&#62;psi&#60;/institute&#62;
&#60;file&#95;format&#62;root-npp&#60;/file&#95;format&#62;
&#60;lifetime&#95;correction&#62;y&#60;/lifetime&#95;correction&#62;
&#60;/msr&#95;file&#95;defaults&#62;
&#60;msr2data&#95;defaults&#62;
&#60;chain&#95;fit&#62;y&#60;/chain&#95;fit&#62;
&#60;write&#95;data&#95;header&#62;y&#60;/write&#95;data&#95;header&#62;
&#60;ignore&#95;data&#95;header&#95;info&#62;n&#60;/ignore&#95;data&#95;header&#95;info&#62;
&#60;keep&#95;minuit2&#95;output&#62;n&#60;/keep&#95;minuit2&#95;output&#62;
&#60;write&#95;column&#95;data&#62;n&#60;/write&#95;column&#95;data&#62;
&#60;recreate&#95;data&#95;file&#62;n&#60;/recreate&#95;data&#95;file&#62;
&#60;open&#95;file&#95;after&#95;fitting&#62;y&#60;/open&#95;file&#95;after&#95;fitting&#62;
&#60;create&#95;msr&#95;file&#95;only&#62;n&#60;/create&#95;msr&#95;file&#95;only&#62;
&#60;fit&#95;only&#62;n&#60;/fit&#95;only&#62;
&#60;global&#62;n&#60;/global&#62;
&#60;global&#95;plus&#62;n&#60;/global&#95;plus&#62;
&#60;/msr2data&#95;defaults&#62;
&#60;help&#95;section&#62;
&#60;help&#95;main&#62;
For a detailed description of the aim and structure of a msr file see http://lmu.web.psi.ch/facilities/software/musrfit/user/MUSR/MusrFit.html
&#60;/help&#95;main&#62;
&#60;/help&#95;section&#62;
&#60;func&#95;pixmap&#95;path&#62;/home/user/analysis/musrfit/src/musrgui/latex&#95;images&#60;/func&#95;pixmap&#95;path&#62;
&#60;theory&#95;functions&#62;
&#60;func&#62;
&#60;name&#62;asymmetry&#60;/name&#62;
&#60;comment&#62;&#60;/comment&#62;
&#60;label&#62;Asymmetry&#60;/label&#62;
&#60;pixmap&#62;asymmetry.png&#60;/pixmap&#62;
&#60;params&#62;1&#60;/params&#62;
&#60;/func&#62;
&#60;func&#62;
&#60;name&#62;simplExpo&#60;/name&#62;
&#60;comment&#62;(rate)&#60;/comment&#62;
&#60;label&#62;simple Exp&#60;/label&#62;
&#60;pixmap&#62;simpleExp.png&#60;/pixmap&#62;
&#60;params&#62;1&#60;/params&#62;
&#60;/func&#62;
&#60;func&#62;
&#60;name&#62;simplGss&#60;/name&#62;
&#60;comment&#62;(rate)&#60;/comment&#62;
&#60;label&#62;simple Gauss&#60;/label&#62;
&#60;pixmap&#62;simpleGauss.png&#60;/pixmap&#62;
&#60;params&#62;1&#60;/params&#62;
&#60;/func&#62;
&#60;/theory&#95;function&#62;
&#60;/musrgui&#95;startup&#62;
</pre>
<p></p>
<span id="MusrfitFeatures"></span>
<h1 id="A_3_61_61musrfit_61_61_Features"> 3 <code><b>musrfit</b></code> Features </h1>
The features of <code>musrfit</code> which can be accessed by the graphical front ends <code>musrgui</code> / <code>musredit</code> are described in the following. All functions can either be called by choosing them from the MusrFit menu, by clicking the respective button in the MusrFit bar, or by using a keyboard shortcut.
<p></p>
$ <img alt="musrasym.png" src="../pub/MUSR/MusrGui/musrasym.png" /> Asymmetry Default (Alt+a): Generate a full msr file suitable for the <a href="MusrFit.html#FitTypes">fit type</a> <strong>2</strong> of <code>musrfit</code> from defaults. Calling this function opens a window where the relative path and file name to a data file as well as the file format that should be used have to be specified. For instance if the data file <code><b>/path-to-datadir/2007/lem07_his_8472.root</b></code> should be used and <code><b>/path-to-datadir</b></code> is on the path where <code>musrfit</code> <a href="MusrFit.html#PathToDataFiles">looks for data files</a> then the file name would be <code><b>2007/lem07_his_8472</b></code> and the file format either <strong>ROOT-NPP</strong> or <strong>ROOT-PPC</strong>.
<p></p>
$ <img alt="musrsinglehisto.png" src="../pub/MUSR/MusrGui/musrsinglehisto.png" /> Single-Histogram Default (Alt+h): Generate a full msr file suitable for the <a href="MusrFit.html#FitTypes">fit type</a> <strong>0</strong> of <code>musrfit</code> from defaults. Calling this function opens a window where the relative path and file name to a data file as well as the file format that should be used have to be specified. For instance if the data file <code><b>/path-to-datadir/d2007/deltat_pta_gps_8472.bin</b></code> should be used and <code><b>/path-to-datadir</b></code> is on the path where <code>musrfit</code> <a href="MusrFit.html#PathToDataFiles">looks for data files</a> then the file name would be <code><b>d2007/deltat_pta_gps_8472</b></code> and the file format <strong>PSI-BIN</strong>.
<p></p>
$ <img alt="musrcalcchisq.png" src="../pub/MUSR/MusrGui/musrcalcchisq.png" /> Calculate Chisq (Alt+c): <pre class="bash">musrfit &#60;msr&#95;file&#62; --chisq-only</pre> is called for the <strong>&lt;msr_file&gt;</strong> selected in the editor. For further information refer to the <a href="MusrFit.html#MusrFit">manual</a> of <code>musrfit</code>.
<p></p>
$ <img alt="musrfit.png" src="../pub/MUSR/MusrGui/musrfit.png" /> Fit (Alt+f): <pre class="bash">musrfit &#60;msr&#95;file&#62; &#91;optional parameters&#93;</pre> is called for the <strong>&lt;msr_file&gt;</strong> selected in the editor. The optional parameters may be chosen under <a class="foswikiCurrentTopicLink" href="#MusrPrefs">Preferences</a>. For further information refer to the <a href="MusrFit.html#MusrFit">manual</a> of <code>musrfit</code>.
<p></p>
$ <img alt="musrswap.png" src="../pub/MUSR/MusrGui/musrswap.png" /> Swap Msr &#8596; Mlog (Alt+s): Swap the msr and mlog files. E.g., for a file called <code><b>8472_zf.msr</b></code>, this is copied to <code><b>8472_zf.mlog</b></code> and vice versa.
<p></p>
$ <img alt="musrmsr2data.png" src="../pub/MUSR/MusrGui/musrmsr2data.png" /> Msr2data (Alt+m): Opens a graphical interface to the <code>msr2data</code> program described in detail in its own <a href="Msr2Data.html#MusrGuiInterface">manual</a>.
<p></p>
$ <img alt="musrview.png" src="../pub/MUSR/MusrGui/musrview.png" /> View (Alt+v): <pre class="bash">musrview &#60;msr&#95;file&#62;</pre> is called for the <strong>&lt;msr_file&gt;</strong> selected in the editor. For further information refer to the <a href="MusrFit.html#MusrView">manual</a> of <code>musrfit</code>.
<p></p>
$ <img alt="musrt0.png" src="../pub/MUSR/MusrGui/musrt0.png" /> T0 (Alt+t): <pre class="bash">musrt0 &#60;msr&#95;file&#62;</pre> is called for the <strong>&lt;msr_file&gt;</strong> selected in the editor. For further information refer to the <a href="MusrFit.html#MusrT0">manual</a> of <code>musrfit</code>.
<p></p>
$ <img alt="musrFT.png" src="../pub/MUSR/MusrGui/musrFT.png" /> Raw Fourier: <code>musrFT &lt;with-many-options&gt;</code> is called. For a proper documentation of it, check the <a href="MusrFit.html#MusrFT">manual</a> of <code>musrFT</code>.
<p></p>
<span id="MusrPrefs"></span>
$ <img alt="musrprefs.png" src="../pub/MUSR/MusrGui/musrprefs.png" /> Preferences (Alt+p): Opens a window in which the optional parameters that should be passed to <code>musrfit</code> can be chosen. These options are <code><b>--keep-mn2-output</b></code>, <code><b>--dump ascii</b></code>, <code><b>--dump root</b></code>, and <code><b>--title-from-data-file</b></code>. For further information refer to the <a href="MusrFit.html#MusrFit">manual</a> of <code>musrfit</code>. Additionally, the access to <code>musrt0</code> can be enabled temporarily.
<p></p>
$ <img alt="musrdump.png" src="../pub/MUSR/MusrGui/musrdump.png" /> Dump Header: Opens a file dialog which allows to select a &mu;SR data file. When this file can be read, the run header info is dumped into a dialog window. Essentially this calls <code><b>dump_header</b></code> internally.
<p></p>
<span id="EditorFeatures"></span>
<h1 id="A_4_Editor_Features"> 4 Editor Features </h1>
Besides the functions described above and which are mostly interfacing <code>musrfit/msr2data</code> the editors of <code>musrgui</code> / <code>musredit</code> offer various functions for manipulating especially <code>musrfit</code> msr files:
<img class='imagePlain imagePlain_right ' src='../pub/MUSR/MusrGui/igp_4e5811420d6b5b31cac70e88b8477a14_musrgui-editor-v0.png' alt='musrgui editor features' title='musrgui-editor-v0.png' width='415' height='566' style='' /> <ul>
<li> Upon right-clicking an open msr file a menu as shown to the right is displayed which offers the addition of any valid msr file block or theory function. In case a simple theory function is chosen, the function will be inserted into the THEORY block using the <a href="MusrFit.html#TheoryTable">correct syntax</a>. If one chooses to add a whole block to the file a dialog opens in which the necessary information for each block as described in the <a href="MusrFit.html#DescriptionOfTheMsrFileFormat">manual</a> of <code>musrfit</code> can be supplied. <span class='foswikiBlueFG'>This feature is available only in <code>musrgui</code>. In <code>musredit</code> the respective functions can be accessed through the <em>Edit</em> menu.</span>
</li> <li> In order to comment or uncomment lines in a msr file select the according lines and apply <strong>Edit &rarr; (Un)Comment</strong> or use the keyboard shortcut <strong>Ctrl+(Shift)+m</strong>.
</li></ul>
<p></p>
<span id="BugTracking"></span>
<h1 id="A_5_Bugtracking"> 5 Bugtracking </h1>
<p></p>
For reporting bugs or requesting new features and improvements please use the <a href="https://bitbucket.org/muonspin/musrfit/issues">Bitbucket Tracker</a>, <a href="https://tracker.psi.ch/jira/browse/MUSR/">PSI Tracker</a> (PSI account needed) or send an e-mail to A. Suter.
<p></p>
-- <a href="http://www.psi.ch/low-energy-muons/people">AS</a> &amp; <a href="http://www.fsf.org/register_form?referrer=8369">BMW</a></div>
<p></p>
<p></p>
<br class="imageClear" clear="all"/><div class="foswikiAttachments">
<div class="twistyPlugin foswikiMakeVisible"><span id="topicattachmentslist1show" style="display:none" class="twistyRememberSetting twistyTrigger foswikiUnvisited twistyInited"><a class="patternTwistyButton" href="#"><img src="../pub/System/DocumentGraphics/toggleopen.png" border="0" alt="" /><span class="foswikiLinkLabel foswikiUnvisited">Attachments <span class='foswikiSmall foswikiGrayText'>1</span></span></a></span><span id="topicattachmentslist1hide" style="display:none" class="twistyRememberSetting twistyTrigger foswikiUnvisited twistyInited"><a class="patternTwistyButton" href="#"><img src="../pub/System/DocumentGraphics/toggleclose.png" border="0" alt="" /><span class="foswikiLinkLabel foswikiUnvisited">Attachments <span class='foswikiSmall foswikiGrayText'>1</span></span></a></span></div><div class="twistyPlugin"><div id="topicattachmentslist1toggle" style="" class="twistyRememberSetting twistyContent twistyInited">
<table border="1" class="foswikiTable" id="tableMusrGui1" rules="none" summary="Topic attachments"><caption>Topic attachments</caption>
<thead>
<tr class="foswikiTableOdd foswikiTableRowdataBgSorted0 foswikiTableRowdataBg0">
<th class="foswikiTableCol0 foswikiFirstCol"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=0;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">I</a> </th>
<th class="foswikiTableCol1"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=1;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">Attachment</a> </th>
<th class="foswikiTableCol2"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=2;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">Action</a> </th>
<th class="foswikiTableCol3"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=3;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">Size</a> </th>
<th class="foswikiTableCol4"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=4;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">Date</a> </th>
<th class="foswikiTableCol5"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=5;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">Who</a> </th>
<th class="foswikiTableCol6 foswikiLastCol"> <a href="https://intranet.psi.ch/MUSR/MusrGui?cover=print;sortcol=6;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column">Comment</a> </th>
</tr>
</thead>
<tbody>
<tr class="foswikiTableEven foswikiTableRowdataBgSorted0 foswikiTableRowdataBg0">
<td class="foswikiTableCol0 foswikiFirstCol foswikiLast"> <span class='foswikiIcon'><img src='../pub/System/DocumentGraphics/png.png' width='16' height='16' alt='musrgui-editor-v0.png' /></span><span class="foswikiHidden">png</span> </td>
<td class="foswikiTableCol1 foswikiLast"> <a href="../pub/MUSR/MusrGui/musrgui-editor-v0.png">musrgui-editor-v0.png</a> </td>
<td class="foswikiTableCol2 foswikiLast"> <a href="https://intranet.psi.ch/wiki/bin/attach/MUSR/MusrGui?filename=musrgui-editor-v0.png;revInfo=1" title="change, update, previous revisions, move, delete..." rel="nofollow">manage</a> </td>
<td class="foswikiTableCol3 foswikiLast" style="text-align:right"> 37 K </td>
<td class="foswikiTableCol4 foswikiLast"> <span class="foswikiNoBreak">10 Apr 2009 - 14:53</span> </td>
<td class="foswikiTableCol5 foswikiLast"> <a href="https://intranet.psi.ch/Main/UnknownUser">UnknownUser</a> </td>
<td class="foswikiTableCol6 foswikiLastCol foswikiLast"> musrgui options available upon right clicking a open msr-file </td>
</tr>
</tbody></table>
</div></div></div></div>
<div class="patternInfo">This topic: MUSR<span class='foswikiSeparator'>&nbsp;&gt;&nbsp;</span><a class="foswikiCurrentWebHomeLink" href="WebHome.html">WebHome</a> &gt; <a href="MusrFit.html">MusrFit</a><span class='foswikiSeparator'>&nbsp;&gt;&nbsp;</span>MusrGui <br />
Topic revision: <span class='patternRevInfo'>19 Feb 2015, suter_a</span></div>
</div>
</div>
</div>
</div><div id="patternBottomBar"><div id="patternBottomBarContents"><div id="patternWebBottomBar"><span class="foswikiRight"> <a href="http://foswiki.org/"><img src="../pub/System/ProjectLogos/foswiki-badge.png" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" /></a></span>Copyright &copy; by the contributing authors. All material on this collaboration platform is the property of the contributing authors. <br /> Ideas, requests, problems regarding PSI Wiki? <a href='mailto:thomas.buecklers@psi.ch?subject=PSI Wiki %20Feedback%20on%20MUSR.MusrGui'>Send feedback</a></div></div></div>
</div>
</div>
</div>
</div></div><!-- /endWrap -->
<p></p>
<!-- Piwik -->
<noscript><p><img src="../piwik/piwikf832.gif?idsite=7" style="border:0" alt=""></p></noscript>
<!-- End Piwik Tag -->
</body>
<!-- Mirrored from intranet.psi.ch/MUSR/MusrGui?cover=print by HTTrack Website Copier/3.x [XR&CO'2010], Fri, 16 Dec 2016 16:01:01 GMT -->
<!-- Added by HTTrack --><meta http-equiv="content-type" content="text/html;charset=utf-8"><!-- /Added by HTTrack -->
</html>