281 lines
13 KiB
TeX
281 lines
13 KiB
TeX
\doxysection{PDetector Class Reference}
|
|
\hypertarget{classPDetector}{}\label{classPDetector}\index{PDetector@{PDetector}}
|
|
|
|
|
|
The \doxylink{classPDetector}{PDetector} class represents a logical muon detector.
|
|
|
|
|
|
|
|
|
|
{\ttfamily \#include $<$PInstrument\+Def.\+h$>$}
|
|
|
|
\doxysubsubsection*{Public Member Functions}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
\mbox{\hyperlink{classPDetector_af27b28f5e58aca93b7815af9791b20a3}{PDetector}} ()
|
|
\begin{DoxyCompactList}\small\item\em Constructor. \end{DoxyCompactList}\item
|
|
\mbox{\hyperlink{classPDetector_acde12ed89e9d57df00cb492493ccd27c}{\texorpdfstring{$\sim$}{\string~}\+PDetector}} ()
|
|
\begin{DoxyCompactList}\small\item\em Destructor. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPDetector_ab85d7eff86a49479ea34d1f3d68f525b}{set\+Name}} (QString str)
|
|
\begin{DoxyCompactList}\small\item\em Sets the detector name. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPDetector_a0862b4de2233b635326e8485fb652125}{set\+Rel\+Geom\+Phase}} (double phase)
|
|
\begin{DoxyCompactList}\small\item\em Sets the relative geometric phase. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPDetector_ac65e570ab8dda8829fd2de9e1e787113}{set\+Forwards}} (QVector$<$ int $>$ num)
|
|
\begin{DoxyCompactList}\small\item\em Sets the forward detector indices. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPDetector_aaaa780c5bbca1d01c6f4308aa283a755}{set\+Backwards}} (QVector$<$ int $>$ num)
|
|
\begin{DoxyCompactList}\small\item\em Sets the backward detector indices. \end{DoxyCompactList}\item
|
|
void \mbox{\hyperlink{classPDetector_a2432390758336671f369148e099a9951}{set\+Alpha}} (double alpha)
|
|
\begin{DoxyCompactList}\small\item\em Sets the alpha correction factor. \end{DoxyCompactList}\item
|
|
QString \mbox{\hyperlink{classPDetector_a259e664dce77fd9d436af196e32153e9}{get\+Name}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the detector name. \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{classPDetector_a88fe9865b84246cabd648c073419cce9}{get\+Rel\+Geom\+Phase}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the relative geometric phase. \end{DoxyCompactList}\item
|
|
QVector$<$ int $>$ \mbox{\hyperlink{classPDetector_ab0a75fbc1bb8701c260640f612f65bf1}{get\+Forwards}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the forward detector indices. \end{DoxyCompactList}\item
|
|
QVector$<$ int $>$ \mbox{\hyperlink{classPDetector_a34b570a8906d55e4677ea6bd800eef1e}{get\+Backwards}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the backward detector indices. \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{classPDetector_af368fc9d9d616c0550f031bb2f57a088}{get\+Alpha}} ()
|
|
\begin{DoxyCompactList}\small\item\em Returns the alpha correction factor. \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
\doxysubsubsection*{Private Attributes}
|
|
\begin{DoxyCompactItemize}
|
|
\item
|
|
QString \mbox{\hyperlink{classPDetector_abd7fef76d78ff16b539daac63a4e4a8b}{f\+Name}}
|
|
\begin{DoxyCompactList}\small\item\em detector name \end{DoxyCompactList}\item
|
|
QVector$<$ int $>$ \mbox{\hyperlink{classPDetector_a9a3df488851b88d6c04ada6fb25fa339}{f\+Forward}}
|
|
\begin{DoxyCompactList}\small\item\em forward detector indices \end{DoxyCompactList}\item
|
|
QVector$<$ int $>$ \mbox{\hyperlink{classPDetector_aa8bdf5bb990b8cfd9efdbeea304f56f6}{f\+Backward}}
|
|
\begin{DoxyCompactList}\small\item\em backward detector indices \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{classPDetector_a545738c8045edf1278a3f4dba2650b55}{f\+Alpha}}
|
|
\begin{DoxyCompactList}\small\item\em alpha correction factor \end{DoxyCompactList}\item
|
|
double \mbox{\hyperlink{classPDetector_a1e83797c531d53101446b0dd0786a3de}{f\+Rel\+Geom\+Phase}}
|
|
\begin{DoxyCompactList}\small\item\em relative geometric phase in degrees \end{DoxyCompactList}\end{DoxyCompactItemize}
|
|
|
|
|
|
\doxysubsection{Detailed Description}
|
|
The \doxylink{classPDetector}{PDetector} class represents a logical muon detector.
|
|
|
|
This class encapsulates the properties of a detector configuration including its name, relative geometric phase, forward/backward detector indices, and alpha parameter (for asymmetry fits). It is used in the instrument definition to specify detector groupings for different measurement setups.
|
|
|
|
\doxysubsection{Constructor \& Destructor Documentation}
|
|
\Hypertarget{classPDetector_af27b28f5e58aca93b7815af9791b20a3}\index{PDetector@{PDetector}!PDetector@{PDetector}}
|
|
\index{PDetector@{PDetector}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{PDetector()}{PDetector()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_af27b28f5e58aca93b7815af9791b20a3}
|
|
PDetector\+::\+PDetector (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Constructor.
|
|
|
|
\Hypertarget{classPDetector_acde12ed89e9d57df00cb492493ccd27c}\index{PDetector@{PDetector}!````~PDetector@{\texorpdfstring{$\sim$}{\string~}PDetector}}
|
|
\index{````~PDetector@{\texorpdfstring{$\sim$}{\string~}PDetector}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{\texorpdfstring{$\sim$}{\string~}PDetector()}{\string~PDetector()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_acde12ed89e9d57df00cb492493ccd27c}
|
|
PDetector\+::\texorpdfstring{$\sim$}{\string~}\+PDetector (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Destructor.
|
|
|
|
|
|
|
|
\doxysubsection{Member Function Documentation}
|
|
\Hypertarget{classPDetector_af368fc9d9d616c0550f031bb2f57a088}\index{PDetector@{PDetector}!getAlpha@{getAlpha}}
|
|
\index{getAlpha@{getAlpha}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{getAlpha()}{getAlpha()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_af368fc9d9d616c0550f031bb2f57a088}
|
|
double PDetector\+::get\+Alpha (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the alpha correction factor.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Alpha value.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPDetector_a34b570a8906d55e4677ea6bd800eef1e}\index{PDetector@{PDetector}!getBackwards@{getBackwards}}
|
|
\index{getBackwards@{getBackwards}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{getBackwards()}{getBackwards()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a34b570a8906d55e4677ea6bd800eef1e}
|
|
QVector$<$ int $>$ PDetector\+::get\+Backwards (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the backward detector indices.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Vector of backward detector numbers.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPDetector_ab0a75fbc1bb8701c260640f612f65bf1}\index{PDetector@{PDetector}!getForwards@{getForwards}}
|
|
\index{getForwards@{getForwards}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{getForwards()}{getForwards()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_ab0a75fbc1bb8701c260640f612f65bf1}
|
|
QVector$<$ int $>$ PDetector\+::get\+Forwards (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the forward detector indices.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Vector of forward detector numbers.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPDetector_a259e664dce77fd9d436af196e32153e9}\index{PDetector@{PDetector}!getName@{getName}}
|
|
\index{getName@{getName}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a259e664dce77fd9d436af196e32153e9}
|
|
QString PDetector\+::get\+Name (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the detector name.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Detector name.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPDetector_a88fe9865b84246cabd648c073419cce9}\index{PDetector@{PDetector}!getRelGeomPhase@{getRelGeomPhase}}
|
|
\index{getRelGeomPhase@{getRelGeomPhase}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{getRelGeomPhase()}{getRelGeomPhase()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a88fe9865b84246cabd648c073419cce9}
|
|
double PDetector\+::get\+Rel\+Geom\+Phase (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Returns the relative geometric phase.
|
|
|
|
\begin{DoxyReturn}{Returns}
|
|
Phase angle in degrees.
|
|
\end{DoxyReturn}
|
|
\Hypertarget{classPDetector_a2432390758336671f369148e099a9951}\index{PDetector@{PDetector}!setAlpha@{setAlpha}}
|
|
\index{setAlpha@{setAlpha}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{setAlpha()}{setAlpha()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a2432390758336671f369148e099a9951}
|
|
void PDetector\+::set\+Alpha (\begin{DoxyParamCaption}\item[{double}]{alpha}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the alpha correction factor.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em alpha} & Alpha value for asymmetry correction. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPDetector_aaaa780c5bbca1d01c6f4308aa283a755}\index{PDetector@{PDetector}!setBackwards@{setBackwards}}
|
|
\index{setBackwards@{setBackwards}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{setBackwards()}{setBackwards()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_aaaa780c5bbca1d01c6f4308aa283a755}
|
|
void PDetector\+::set\+Backwards (\begin{DoxyParamCaption}\item[{QVector$<$ int $>$}]{num}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the backward detector indices.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em num} & Vector of physical detector numbers forming the backward group. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPDetector_ac65e570ab8dda8829fd2de9e1e787113}\index{PDetector@{PDetector}!setForwards@{setForwards}}
|
|
\index{setForwards@{setForwards}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{setForwards()}{setForwards()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_ac65e570ab8dda8829fd2de9e1e787113}
|
|
void PDetector\+::set\+Forwards (\begin{DoxyParamCaption}\item[{QVector$<$ int $>$}]{num}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the forward detector indices.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em num} & Vector of physical detector numbers forming the forward group. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPDetector_ab85d7eff86a49479ea34d1f3d68f525b}\index{PDetector@{PDetector}!setName@{setName}}
|
|
\index{setName@{setName}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{setName()}{setName()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_ab85d7eff86a49479ea34d1f3d68f525b}
|
|
void PDetector\+::set\+Name (\begin{DoxyParamCaption}\item[{QString}]{str}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the detector name.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em str} & Detector name (e.\+g., "{}\+Forward"{}, "{}\+Backward"{}, "{}\+Left"{}). \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
\Hypertarget{classPDetector_a0862b4de2233b635326e8485fb652125}\index{PDetector@{PDetector}!setRelGeomPhase@{setRelGeomPhase}}
|
|
\index{setRelGeomPhase@{setRelGeomPhase}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{setRelGeomPhase()}{setRelGeomPhase()}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a0862b4de2233b635326e8485fb652125}
|
|
void PDetector\+::set\+Rel\+Geom\+Phase (\begin{DoxyParamCaption}\item[{double}]{phase}{}\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}
|
|
|
|
|
|
|
|
Sets the relative geometric phase.
|
|
|
|
|
|
\begin{DoxyParams}{Parameters}
|
|
{\em phase} & Phase angle in degrees relative to a reference detector. \\
|
|
\hline
|
|
\end{DoxyParams}
|
|
|
|
|
|
\doxysubsection{Member Data Documentation}
|
|
\Hypertarget{classPDetector_a545738c8045edf1278a3f4dba2650b55}\index{PDetector@{PDetector}!fAlpha@{fAlpha}}
|
|
\index{fAlpha@{fAlpha}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{fAlpha}{fAlpha}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a545738c8045edf1278a3f4dba2650b55}
|
|
double PDetector\+::f\+Alpha\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
alpha correction factor
|
|
|
|
\Hypertarget{classPDetector_aa8bdf5bb990b8cfd9efdbeea304f56f6}\index{PDetector@{PDetector}!fBackward@{fBackward}}
|
|
\index{fBackward@{fBackward}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{fBackward}{fBackward}}
|
|
{\footnotesize\ttfamily \label{classPDetector_aa8bdf5bb990b8cfd9efdbeea304f56f6}
|
|
QVector$<$int$>$ PDetector\+::f\+Backward\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
backward detector indices
|
|
|
|
\Hypertarget{classPDetector_a9a3df488851b88d6c04ada6fb25fa339}\index{PDetector@{PDetector}!fForward@{fForward}}
|
|
\index{fForward@{fForward}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{fForward}{fForward}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a9a3df488851b88d6c04ada6fb25fa339}
|
|
QVector$<$int$>$ PDetector\+::f\+Forward\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
forward detector indices
|
|
|
|
\Hypertarget{classPDetector_abd7fef76d78ff16b539daac63a4e4a8b}\index{PDetector@{PDetector}!fName@{fName}}
|
|
\index{fName@{fName}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{fName}{fName}}
|
|
{\footnotesize\ttfamily \label{classPDetector_abd7fef76d78ff16b539daac63a4e4a8b}
|
|
QString PDetector\+::f\+Name\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
detector name
|
|
|
|
\Hypertarget{classPDetector_a1e83797c531d53101446b0dd0786a3de}\index{PDetector@{PDetector}!fRelGeomPhase@{fRelGeomPhase}}
|
|
\index{fRelGeomPhase@{fRelGeomPhase}!PDetector@{PDetector}}
|
|
\doxysubsubsection{\texorpdfstring{fRelGeomPhase}{fRelGeomPhase}}
|
|
{\footnotesize\ttfamily \label{classPDetector_a1e83797c531d53101446b0dd0786a3de}
|
|
double PDetector\+::f\+Rel\+Geom\+Phase\hspace{0.3cm}{\ttfamily [private]}}
|
|
|
|
|
|
|
|
relative geometric phase in degrees
|
|
|
|
|
|
|
|
The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
|
|
\item
|
|
/workspace/\+LMU/musrfit/src/musredit\+\_\+qt6/musr\+Wiz/\mbox{\hyperlink{PInstrumentDef_8h}{PInstrument\+Def.\+h}}\end{DoxyCompactItemize}
|