Files
musrfit/doc/technical/html/musrWiz/latex/classPParam.tex
T
2026-07-31 18:47:29 +00:00

384 lines
17 KiB
TeX

\doxysection{PParam Class Reference}
\hypertarget{classPParam}{}\label{classPParam}\index{PParam@{PParam}}
The \doxylink{classPParam}{PParam} class handles a single fit parameter for the musr\+Wiz application.
{\ttfamily \#include $<$musr\+Wiz.\+h$>$}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\mbox{\hyperlink{classPParam_ae27a422541e7d29c6447b21b4f6a6c1c}{PParam}} ()
\begin{DoxyCompactList}\small\item\em Constructor. Initializes the parameter to default values. \end{DoxyCompactList}\item
\mbox{\hyperlink{classPParam_af58fe4f00392c0df82e25f84d9a0679c}{\texorpdfstring{$\sim$}{\string~}\+PParam}} ()
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_ac214997c5afc1f2285a627bb20eaa18d}{init}} ()
\begin{DoxyCompactList}\small\item\em Initializes all member variables to default/undefined values. \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_a778c95968f00f2f3aa549577ba362b96}{get\+Name}} ()
\begin{DoxyCompactList}\small\item\em Returns the parameter name. \end{DoxyCompactList}\item
int \mbox{\hyperlink{classPParam_a87d01a2ed697a4f0abd523b9c90c5ac7}{get\+Number}} ()
\begin{DoxyCompactList}\small\item\em Returns the parameter number. \end{DoxyCompactList}\item
double \mbox{\hyperlink{classPParam_a2956f8362f2bdd407b6ad6281aa5d5e7}{get\+Value}} ()
\begin{DoxyCompactList}\small\item\em Returns the parameter value. \end{DoxyCompactList}\item
double \mbox{\hyperlink{classPParam_a403904aa2a762257c9f8023270d7c763}{get\+Step}} ()
\begin{DoxyCompactList}\small\item\em Returns the step size for the fit. \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_ab98ed3f3624440aa105fa4c0db23a6ae}{get\+Pos\+Err}} ()
\begin{DoxyCompactList}\small\item\em Returns the positive error string. \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_a39fa8aa65f306f94a568b882da9f0352}{get\+Bound\+Low}} ()
\begin{DoxyCompactList}\small\item\em Returns the lower bound for the parameter. \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_af13cc4f77bbc4fe6c25db2870289d14a}{get\+Bound\+High}} ()
\begin{DoxyCompactList}\small\item\em Returns the upper bound for the parameter. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_ab67feebe2e71ee271eff36f7ba19c8c4}{set\+Name}} (QString str)
\begin{DoxyCompactList}\small\item\em Sets the parameter name. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_af61ba3857b82d74d476979bce90c2602}{set\+Number}} (int ival)
\begin{DoxyCompactList}\small\item\em Sets the parameter number. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_af2a442e78f3dc59f158b6ac35b229c1e}{set\+Value}} (double dval)
\begin{DoxyCompactList}\small\item\em Sets the parameter value. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_a8b49bb5350e771869a1c026c0bcd44eb}{set\+Step}} (double dval)
\begin{DoxyCompactList}\small\item\em Sets the step size. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_a83dec215563454000b22ef58b099b086}{set\+Pos\+Err}} (QString str)
\begin{DoxyCompactList}\small\item\em Sets the positive error string. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_a5bfe2ea9e6955455cff5e9b606c1aa5f}{set\+Bound\+Low}} (QString str)
\begin{DoxyCompactList}\small\item\em Sets the lower bound. \end{DoxyCompactList}\item
void \mbox{\hyperlink{classPParam_a894eda8b848119243dd02da2b2a85d45}{set\+Bound\+High}} (QString str)
\begin{DoxyCompactList}\small\item\em Sets the upper bound. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item
QString \mbox{\hyperlink{classPParam_af1fe6ad04c9d415365a5eb91d7f575f1}{f\+Name}}
\begin{DoxyCompactList}\small\item\em parameter name \end{DoxyCompactList}\item
int \mbox{\hyperlink{classPParam_aea646cc0a1e4b689ca356fba3586e35d}{f\+Number}}
\begin{DoxyCompactList}\small\item\em parameter number \end{DoxyCompactList}\item
double \mbox{\hyperlink{classPParam_a81c8cea226642b55680bc57c2b4ab322}{f\+Value}}
\begin{DoxyCompactList}\small\item\em parameter value \end{DoxyCompactList}\item
double \mbox{\hyperlink{classPParam_a06e6eed86c6a8bbd3401009ed1d08dad}{f\+Step}}
\begin{DoxyCompactList}\small\item\em step size for fitting \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_adc6125700bb71cf241a48a750af3df4c}{f\+Pos\+Err}}
\begin{DoxyCompactList}\small\item\em positive error (or "{}none"{}) \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_a3d9666f062536d4dcfa891364e362e43}{f\+Bound\+Low}}
\begin{DoxyCompactList}\small\item\em lower bound (optional) \end{DoxyCompactList}\item
QString \mbox{\hyperlink{classPParam_a8015b7aed8093ce705e5fdb1ecd3b828}{f\+Bound\+High}}
\begin{DoxyCompactList}\small\item\em upper bound (optional) \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Detailed Description}
The \doxylink{classPParam}{PParam} class handles a single fit parameter for the musr\+Wiz application.
This class encapsulates all properties of a musrfit fit parameter including its name, number, value, step size, positive error, and optional lower/upper bounds. It is used throughout the musr\+Wiz wizard to manage parameter definitions.
\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classPParam_ae27a422541e7d29c6447b21b4f6a6c1c}\index{PParam@{PParam}!PParam@{PParam}}
\index{PParam@{PParam}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{PParam()}{PParam()}}
{\footnotesize\ttfamily \label{classPParam_ae27a422541e7d29c6447b21b4f6a6c1c}
PParam\+::\+PParam (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Constructor. Initializes the parameter to default values.
\Hypertarget{classPParam_af58fe4f00392c0df82e25f84d9a0679c}\index{PParam@{PParam}!````~PParam@{\texorpdfstring{$\sim$}{\string~}PParam}}
\index{````~PParam@{\texorpdfstring{$\sim$}{\string~}PParam}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PParam()}{\string~PParam()}}
{\footnotesize\ttfamily \label{classPParam_af58fe4f00392c0df82e25f84d9a0679c}
PParam\+::\texorpdfstring{$\sim$}{\string~}\+PParam (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Destructor.
\doxysubsection{Member Function Documentation}
\Hypertarget{classPParam_af13cc4f77bbc4fe6c25db2870289d14a}\index{PParam@{PParam}!getBoundHigh@{getBoundHigh}}
\index{getBoundHigh@{getBoundHigh}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getBoundHigh()}{getBoundHigh()}}
{\footnotesize\ttfamily \label{classPParam_af13cc4f77bbc4fe6c25db2870289d14a}
QString PParam\+::get\+Bound\+High (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the upper bound for the parameter.
\begin{DoxyReturn}{Returns}
Upper bound as QString.
\end{DoxyReturn}
\Hypertarget{classPParam_a39fa8aa65f306f94a568b882da9f0352}\index{PParam@{PParam}!getBoundLow@{getBoundLow}}
\index{getBoundLow@{getBoundLow}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getBoundLow()}{getBoundLow()}}
{\footnotesize\ttfamily \label{classPParam_a39fa8aa65f306f94a568b882da9f0352}
QString PParam\+::get\+Bound\+Low (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the lower bound for the parameter.
\begin{DoxyReturn}{Returns}
Lower bound as QString.
\end{DoxyReturn}
\Hypertarget{classPParam_a778c95968f00f2f3aa549577ba362b96}\index{PParam@{PParam}!getName@{getName}}
\index{getName@{getName}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
{\footnotesize\ttfamily \label{classPParam_a778c95968f00f2f3aa549577ba362b96}
QString PParam\+::get\+Name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the parameter name.
\begin{DoxyReturn}{Returns}
Parameter name as QString.
\end{DoxyReturn}
\Hypertarget{classPParam_a87d01a2ed697a4f0abd523b9c90c5ac7}\index{PParam@{PParam}!getNumber@{getNumber}}
\index{getNumber@{getNumber}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getNumber()}{getNumber()}}
{\footnotesize\ttfamily \label{classPParam_a87d01a2ed697a4f0abd523b9c90c5ac7}
int PParam\+::get\+Number (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the parameter number.
\begin{DoxyReturn}{Returns}
Parameter number.
\end{DoxyReturn}
\Hypertarget{classPParam_ab98ed3f3624440aa105fa4c0db23a6ae}\index{PParam@{PParam}!getPosErr@{getPosErr}}
\index{getPosErr@{getPosErr}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getPosErr()}{getPosErr()}}
{\footnotesize\ttfamily \label{classPParam_ab98ed3f3624440aa105fa4c0db23a6ae}
QString PParam\+::get\+Pos\+Err (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the positive error string.
\begin{DoxyReturn}{Returns}
Positive error as QString.
\end{DoxyReturn}
\Hypertarget{classPParam_a403904aa2a762257c9f8023270d7c763}\index{PParam@{PParam}!getStep@{getStep}}
\index{getStep@{getStep}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getStep()}{getStep()}}
{\footnotesize\ttfamily \label{classPParam_a403904aa2a762257c9f8023270d7c763}
double PParam\+::get\+Step (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the step size for the fit.
\begin{DoxyReturn}{Returns}
Step size.
\end{DoxyReturn}
\Hypertarget{classPParam_a2956f8362f2bdd407b6ad6281aa5d5e7}\index{PParam@{PParam}!getValue@{getValue}}
\index{getValue@{getValue}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{getValue()}{getValue()}}
{\footnotesize\ttfamily \label{classPParam_a2956f8362f2bdd407b6ad6281aa5d5e7}
double PParam\+::get\+Value (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Returns the parameter value.
\begin{DoxyReturn}{Returns}
Parameter value.
\end{DoxyReturn}
\Hypertarget{classPParam_ac214997c5afc1f2285a627bb20eaa18d}\index{PParam@{PParam}!init@{init}}
\index{init@{init}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{init()}{init()}}
{\footnotesize\ttfamily \label{classPParam_ac214997c5afc1f2285a627bb20eaa18d}
void PParam\+::init (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})}
Initializes all member variables to default/undefined values.
\doxylink{classPParam_ac214997c5afc1f2285a627bb20eaa18d}{PParam\+::init} initializes all member variables to default/undefined values.
Sets name, pos\+Err, bound\+Low, and bound\+High to "{}\+Un\+Def"{}, number to -\/1, and value/step to 0.\+0. \Hypertarget{classPParam_a894eda8b848119243dd02da2b2a85d45}\index{PParam@{PParam}!setBoundHigh@{setBoundHigh}}
\index{setBoundHigh@{setBoundHigh}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setBoundHigh()}{setBoundHigh()}}
{\footnotesize\ttfamily \label{classPParam_a894eda8b848119243dd02da2b2a85d45}
void PParam\+::set\+Bound\+High (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the upper bound.
\begin{DoxyParams}{Parameters}
{\em str} & Upper bound to set. \\
\hline
\end{DoxyParams}
\Hypertarget{classPParam_a5bfe2ea9e6955455cff5e9b606c1aa5f}\index{PParam@{PParam}!setBoundLow@{setBoundLow}}
\index{setBoundLow@{setBoundLow}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setBoundLow()}{setBoundLow()}}
{\footnotesize\ttfamily \label{classPParam_a5bfe2ea9e6955455cff5e9b606c1aa5f}
void PParam\+::set\+Bound\+Low (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the lower bound.
\begin{DoxyParams}{Parameters}
{\em str} & Lower bound to set. \\
\hline
\end{DoxyParams}
\Hypertarget{classPParam_ab67feebe2e71ee271eff36f7ba19c8c4}\index{PParam@{PParam}!setName@{setName}}
\index{setName@{setName}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setName()}{setName()}}
{\footnotesize\ttfamily \label{classPParam_ab67feebe2e71ee271eff36f7ba19c8c4}
void PParam\+::set\+Name (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the parameter name.
\begin{DoxyParams}{Parameters}
{\em str} & Name to set. \\
\hline
\end{DoxyParams}
\Hypertarget{classPParam_af61ba3857b82d74d476979bce90c2602}\index{PParam@{PParam}!setNumber@{setNumber}}
\index{setNumber@{setNumber}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setNumber()}{setNumber()}}
{\footnotesize\ttfamily \label{classPParam_af61ba3857b82d74d476979bce90c2602}
void PParam\+::set\+Number (\begin{DoxyParamCaption}\item[{int}]{ival}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the parameter number.
\begin{DoxyParams}{Parameters}
{\em ival} & Number to set. \\
\hline
\end{DoxyParams}
\Hypertarget{classPParam_a83dec215563454000b22ef58b099b086}\index{PParam@{PParam}!setPosErr@{setPosErr}}
\index{setPosErr@{setPosErr}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setPosErr()}{setPosErr()}}
{\footnotesize\ttfamily \label{classPParam_a83dec215563454000b22ef58b099b086}
void PParam\+::set\+Pos\+Err (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the positive error string.
\begin{DoxyParams}{Parameters}
{\em str} & Positive error to set. \\
\hline
\end{DoxyParams}
\Hypertarget{classPParam_a8b49bb5350e771869a1c026c0bcd44eb}\index{PParam@{PParam}!setStep@{setStep}}
\index{setStep@{setStep}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setStep()}{setStep()}}
{\footnotesize\ttfamily \label{classPParam_a8b49bb5350e771869a1c026c0bcd44eb}
void PParam\+::set\+Step (\begin{DoxyParamCaption}\item[{double}]{dval}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the step size.
\begin{DoxyParams}{Parameters}
{\em dval} & Step size to set. \\
\hline
\end{DoxyParams}
\Hypertarget{classPParam_af2a442e78f3dc59f158b6ac35b229c1e}\index{PParam@{PParam}!setValue@{setValue}}
\index{setValue@{setValue}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{setValue()}{setValue()}}
{\footnotesize\ttfamily \label{classPParam_af2a442e78f3dc59f158b6ac35b229c1e}
void PParam\+::set\+Value (\begin{DoxyParamCaption}\item[{double}]{dval}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
Sets the parameter value.
\begin{DoxyParams}{Parameters}
{\em dval} & Value to set. \\
\hline
\end{DoxyParams}
\doxysubsection{Member Data Documentation}
\Hypertarget{classPParam_a8015b7aed8093ce705e5fdb1ecd3b828}\index{PParam@{PParam}!fBoundHigh@{fBoundHigh}}
\index{fBoundHigh@{fBoundHigh}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fBoundHigh}{fBoundHigh}}
{\footnotesize\ttfamily \label{classPParam_a8015b7aed8093ce705e5fdb1ecd3b828}
QString PParam\+::f\+Bound\+High\hspace{0.3cm}{\ttfamily [private]}}
upper bound (optional)
\Hypertarget{classPParam_a3d9666f062536d4dcfa891364e362e43}\index{PParam@{PParam}!fBoundLow@{fBoundLow}}
\index{fBoundLow@{fBoundLow}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fBoundLow}{fBoundLow}}
{\footnotesize\ttfamily \label{classPParam_a3d9666f062536d4dcfa891364e362e43}
QString PParam\+::f\+Bound\+Low\hspace{0.3cm}{\ttfamily [private]}}
lower bound (optional)
\Hypertarget{classPParam_af1fe6ad04c9d415365a5eb91d7f575f1}\index{PParam@{PParam}!fName@{fName}}
\index{fName@{fName}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fName}{fName}}
{\footnotesize\ttfamily \label{classPParam_af1fe6ad04c9d415365a5eb91d7f575f1}
QString PParam\+::f\+Name\hspace{0.3cm}{\ttfamily [private]}}
parameter name
\Hypertarget{classPParam_aea646cc0a1e4b689ca356fba3586e35d}\index{PParam@{PParam}!fNumber@{fNumber}}
\index{fNumber@{fNumber}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fNumber}{fNumber}}
{\footnotesize\ttfamily \label{classPParam_aea646cc0a1e4b689ca356fba3586e35d}
int PParam\+::f\+Number\hspace{0.3cm}{\ttfamily [private]}}
parameter number
\Hypertarget{classPParam_adc6125700bb71cf241a48a750af3df4c}\index{PParam@{PParam}!fPosErr@{fPosErr}}
\index{fPosErr@{fPosErr}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fPosErr}{fPosErr}}
{\footnotesize\ttfamily \label{classPParam_adc6125700bb71cf241a48a750af3df4c}
QString PParam\+::f\+Pos\+Err\hspace{0.3cm}{\ttfamily [private]}}
positive error (or "{}none"{})
\Hypertarget{classPParam_a06e6eed86c6a8bbd3401009ed1d08dad}\index{PParam@{PParam}!fStep@{fStep}}
\index{fStep@{fStep}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fStep}{fStep}}
{\footnotesize\ttfamily \label{classPParam_a06e6eed86c6a8bbd3401009ed1d08dad}
double PParam\+::f\+Step\hspace{0.3cm}{\ttfamily [private]}}
step size for fitting
\Hypertarget{classPParam_a81c8cea226642b55680bc57c2b4ab322}\index{PParam@{PParam}!fValue@{fValue}}
\index{fValue@{fValue}!PParam@{PParam}}
\doxysubsubsection{\texorpdfstring{fValue}{fValue}}
{\footnotesize\ttfamily \label{classPParam_a81c8cea226642b55680bc57c2b4ab322}
double PParam\+::f\+Value\hspace{0.3cm}{\ttfamily [private]}}
parameter value
The documentation for this class was generated from the following files\+:\begin{DoxyCompactItemize}
\item
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{musrWiz_8h}{musr\+Wiz.\+h}}\item
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{musrWiz_8cpp}{musr\+Wiz.\+cpp}}\end{DoxyCompactItemize}