update of the technical docu

This commit is contained in:
suter_a 2015-04-01 08:40:33 +02:00
parent ee617d4af5
commit e4f11aca8c
2 changed files with 17 additions and 6 deletions

View File

@ -38,6 +38,7 @@ How to setup musrfit on different platforms: \texttt{http://lmu.web.psi.ch/musrf
<p>The musrfit framework provies the following programs: <p>The musrfit framework provies the following programs:
- \ref musrfit Carries out fits based on a msr-file. - \ref musrfit Carries out fits based on a msr-file.
- \ref musrview Is used show the data in a graphical representation. - \ref musrview Is used show the data in a graphical representation.
- \ref musrFT Is used to show Fourier transforms of data without the need of a theory (raw data Fourier transform).
- \ref musrt0 Is used to set graphically t0's, background and data ranges off raw histogram data. - \ref musrt0 Is used to set graphically t0's, background and data ranges off raw histogram data.
- \ref musrparam Can be used to generate ascii output files with extracted fit-parameters (from msr-files) and independent additional variables like temperature, field, ... The ascii output files can than be used to plot parameters, e.g. by gnuplot. - \ref musrparam Can be used to generate ascii output files with extracted fit-parameters (from msr-files) and independent additional variables like temperature, field, ... The ascii output files can than be used to plot parameters, e.g. by gnuplot.
- \ref msr2data A program (originally written by Bastian M. Wojek). Its purpose is to process/generate multiple musrfit msr-files with the same parameters and summarize the fitting results either in a TRIUMF DB or a column ASCII file. - \ref msr2data A program (originally written by Bastian M. Wojek). Its purpose is to process/generate multiple musrfit msr-files with the same parameters and summarize the fitting results either in a TRIUMF DB or a column ASCII file.
@ -89,6 +90,12 @@ This two points are somewhat contradictory, and currently it is not clear which
<p>Here will eventually follow a more technical description of musrview. If you looking for a user-manual like description, please check \htmlonly<a href="http://lmu.web.psi.ch/musrfit/user/MUSR/MusrFit.html">musrfit user manual</a>\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/musrfit/user/MUSR/MusrFit.html} \endlatexonly <p>Here will eventually follow a more technical description of musrview. If you looking for a user-manual like description, please check \htmlonly<a href="http://lmu.web.psi.ch/musrfit/user/MUSR/MusrFit.html">musrfit user manual</a>\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/musrfit/user/MUSR/MusrFit.html} \endlatexonly
//****************************************************************************************************
\page musrFTPage
\section musrFT musrFT
<p>Here will eventually follow a more technical description of musrFT. If you looking for a user-manual like description, please check \htmlonly<a href="http://lmu.web.psi.ch/musrfit/user/MUSR/MusrFit.html">musrfit user manual</a>\endhtmlonly \latexonly musrfit user manual: \texttt{http://lmu.web.psi.ch/musrfit/user/MUSR/MusrFit.html} \endlatexonly
//**************************************************************************************************** //****************************************************************************************************
\page musrt0Page \page musrt0Page
\section musrt0 musrt0 \section musrt0 musrt0

View File

@ -23,7 +23,7 @@ PROJECT_NAME = musrfit
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
# if some version control system is used. # if some version control system is used.
PROJECT_NUMBER = 0.13.0 PROJECT_NUMBER = 0.14.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.
@ -462,17 +462,19 @@ WARN_LOGFILE =
INPUT = musrfit.dox \ INPUT = musrfit.dox \
../src/include/PFitterFcn.h \ ../src/include/PFitterFcn.h \
../src/include/PFitter.h \ ../src/include/PFitter.h \
../src/include/PFourier.h \ ../src/include/PFourier.h \
../src/include/PFourierCanvas.h \
../src/include/PFunctionGrammar.h \ ../src/include/PFunctionGrammar.h \
../src/include/PFunction.h \ ../src/include/PFunction.h \
../src/include/PFunctionHandler.h \ ../src/include/PFunctionHandler.h \
../src/include/PMsr2Data.h \ ../src/include/PMsr2Data.h \
../src/include/PMsrHandler.h \ ../src/include/PMsrHandler.h \
../src/include/PMusrCanvas.h \ ../src/include/PMusrCanvas.h \
../src/include/PMusrCanvasLinkDef.h \ ../src/include/PMusrCanvasLinkDef.h \
../src/include/PMusr.h \ ../src/include/PMusr.h \
../src/include/PMusrT0.h \ ../src/include/PMusrT0.h \
../src/include/PMusrT0LinkDef.h \ ../src/include/PMusrT0LinkDef.h \
../src/include/PPrepFourier.h \
../src/include/PRunAsymmetry.h \ ../src/include/PRunAsymmetry.h \
../src/include/PRunBase.h \ ../src/include/PRunBase.h \
../src/include/PRunDataHandler.h \ ../src/include/PRunDataHandler.h \
@ -488,7 +490,8 @@ INPUT = musrfit.dox \
../src/include/PUserFcn.h \ ../src/include/PUserFcn.h \
../src/classes/PFitter.cpp \ ../src/classes/PFitter.cpp \
../src/classes/PFitterFcn.cpp \ ../src/classes/PFitterFcn.cpp \
../src/classes/PFourier.cpp \ ../src/classes/PFourier.cpp \
../src/classes/PFourierCanvas.cpp \
../src/classes/PFunction.cpp \ ../src/classes/PFunction.cpp \
../src/classes/PFunctionHandler.cpp \ ../src/classes/PFunctionHandler.cpp \
../src/classes/PMsr2Data.cpp \ ../src/classes/PMsr2Data.cpp \
@ -496,6 +499,7 @@ INPUT = musrfit.dox \
../src/classes/PMusrCanvas.cpp \ ../src/classes/PMusrCanvas.cpp \
../src/classes/PMusr.cpp \ ../src/classes/PMusr.cpp \
../src/classes/PMusrT0.cpp \ ../src/classes/PMusrT0.cpp \
../src/classes/PPrepFourier.cpp \
../src/classes/PRunAsymmetry.cpp \ ../src/classes/PRunAsymmetry.cpp \
../src/classes/PRunBase.cpp \ ../src/classes/PRunBase.cpp \
../src/classes/PRunDataHandler.cpp \ ../src/classes/PRunDataHandler.cpp \