| 1 |
\hypertarget{classTrkRigGeoCut}{ |
| 2 |
\section{TrkRigGeoCut Class Reference} |
| 3 |
\label{classTrkRigGeoCut}\index{TrkRigGeoCut@{TrkRigGeoCut}} |
| 4 |
} |
| 5 |
The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient. |
| 6 |
|
| 7 |
|
| 8 |
{\tt \#include $<$TrkRigGeoCut.h$>$} |
| 9 |
|
| 10 |
Inheritance diagram for TrkRigGeoCut::\begin{figure}[H] |
| 11 |
\begin{center} |
| 12 |
\leavevmode |
| 13 |
\includegraphics[height=2cm]{classTrkRigGeoCut} |
| 14 |
\end{center} |
| 15 |
\end{figure} |
| 16 |
\subsection*{Public Member Functions} |
| 17 |
\begin{CompactItemize} |
| 18 |
\item |
| 19 |
\hyperlink{classTrkRigGeoCut_00e54e0aade802c1c44fcfde47e905d6}{TrkRigGeoCut} (const char $\ast$cutName, float thresholdCoeff) |
| 20 |
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item |
| 21 |
\hyperlink{classTrkRigGeoCut_074e6ecf968a39447bc868a79da213c7}{$\sim$TrkRigGeoCut} () |
| 22 |
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item |
| 23 |
int \hyperlink{classTrkRigGeoCut_d334792be6ca66d01d75bb2f86a57382}{Check} (PamLevel2 $\ast$event) |
| 24 |
\begin{CompactList}\small\item\em The rigidity check. \item\end{CompactList}\item |
| 25 |
float \hyperlink{classTrkRigGeoCut_5b3e2d3037d140ae852bd02975842eb4}{GetThresholdCoeff} () |
| 26 |
\begin{CompactList}\small\item\em Returns the threshold coefficient. \item\end{CompactList}\end{CompactItemize} |
| 27 |
\subsection*{Private Attributes} |
| 28 |
\begin{CompactItemize} |
| 29 |
\item |
| 30 |
float \hyperlink{classTrkRigGeoCut_e9361bca574d1dfefd9b3beabc7aa268}{\_\-thresholdCoeff} |
| 31 |
\end{CompactItemize} |
| 32 |
|
| 33 |
|
| 34 |
\subsection{Detailed Description} |
| 35 |
The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient. |
| 36 |
|
| 37 |
CUT DEPENDENCIES: TrkPhSin (since \hyperlink{classTrkRigGeoCut}{TrkRigGeoCut} assumes the existence of a single physical track) |
| 38 |
|
| 39 |
Definition at line 23 of file TrkRigGeoCut.h. |
| 40 |
|
| 41 |
\subsection{Constructor \& Destructor Documentation} |
| 42 |
\hypertarget{classTrkRigGeoCut_00e54e0aade802c1c44fcfde47e905d6}{ |
| 43 |
\index{TrkRigGeoCut@{TrkRigGeoCut}!TrkRigGeoCut@{TrkRigGeoCut}} |
| 44 |
\index{TrkRigGeoCut@{TrkRigGeoCut}!TrkRigGeoCut@{TrkRigGeoCut}} |
| 45 |
\subsubsection[{TrkRigGeoCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkRigGeoCut::TrkRigGeoCut (const char $\ast$ {\em cutName}, \/ float {\em thresholdCoeff})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 46 |
\label{classTrkRigGeoCut_00e54e0aade802c1c44fcfde47e905d6} |
| 47 |
|
| 48 |
|
| 49 |
Constructor. |
| 50 |
|
| 51 |
\begin{Desc} |
| 52 |
\item[Parameters:] |
| 53 |
\begin{description} |
| 54 |
\item[{\em cutName}]The cut's name. \item[{\em thresholdCoeff}]The threshold rigidity coefficient. \end{description} |
| 55 |
\end{Desc} |
| 56 |
|
| 57 |
|
| 58 |
Definition at line 31 of file TrkRigGeoCut.h.\hypertarget{classTrkRigGeoCut_074e6ecf968a39447bc868a79da213c7}{ |
| 59 |
\index{TrkRigGeoCut@{TrkRigGeoCut}!$\sim$TrkRigGeoCut@{$\sim$TrkRigGeoCut}} |
| 60 |
\index{$\sim$TrkRigGeoCut@{$\sim$TrkRigGeoCut}!TrkRigGeoCut@{TrkRigGeoCut}} |
| 61 |
\subsubsection[{$\sim$TrkRigGeoCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkRigGeoCut::$\sim$TrkRigGeoCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 62 |
\label{classTrkRigGeoCut_074e6ecf968a39447bc868a79da213c7} |
| 63 |
|
| 64 |
|
| 65 |
Destructor. |
| 66 |
|
| 67 |
|
| 68 |
|
| 69 |
Definition at line 35 of file TrkRigGeoCut.h. |
| 70 |
|
| 71 |
\subsection{Member Function Documentation} |
| 72 |
\hypertarget{classTrkRigGeoCut_d334792be6ca66d01d75bb2f86a57382}{ |
| 73 |
\index{TrkRigGeoCut@{TrkRigGeoCut}!Check@{Check}} |
| 74 |
\index{Check@{Check}!TrkRigGeoCut@{TrkRigGeoCut}} |
| 75 |
\subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int TrkRigGeoCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 76 |
\label{classTrkRigGeoCut_d334792be6ca66d01d75bb2f86a57382} |
| 77 |
|
| 78 |
|
| 79 |
The rigidity check. |
| 80 |
|
| 81 |
\begin{Desc} |
| 82 |
\item[Parameters:] |
| 83 |
\begin{description} |
| 84 |
\item[{\em event}]The event to analyze. \end{description} |
| 85 |
\end{Desc} |
| 86 |
\begin{Desc} |
| 87 |
\item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the rigidity modulus is greater than the geomagnetic cutoff rigidity times the threshold coefficient. |
| 88 |
|
| 89 |
0 otherwise. \end{Desc} |
| 90 |
|
| 91 |
|
| 92 |
Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}. |
| 93 |
|
| 94 |
Definition at line 12 of file TrkRigGeoCut.cpp. |
| 95 |
|
| 96 |
References \_\-thresholdCoeff, and CUTOK.\hypertarget{classTrkRigGeoCut_5b3e2d3037d140ae852bd02975842eb4}{ |
| 97 |
\index{TrkRigGeoCut@{TrkRigGeoCut}!GetThresholdCoeff@{GetThresholdCoeff}} |
| 98 |
\index{GetThresholdCoeff@{GetThresholdCoeff}!TrkRigGeoCut@{TrkRigGeoCut}} |
| 99 |
\subsubsection[{GetThresholdCoeff}]{\setlength{\rightskip}{0pt plus 5cm}float TrkRigGeoCut::GetThresholdCoeff ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}} |
| 100 |
\label{classTrkRigGeoCut_5b3e2d3037d140ae852bd02975842eb4} |
| 101 |
|
| 102 |
|
| 103 |
Returns the threshold coefficient. |
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
Definition at line 48 of file TrkRigGeoCut.h. |
| 108 |
|
| 109 |
References \_\-thresholdCoeff. |
| 110 |
|
| 111 |
\subsection{Member Data Documentation} |
| 112 |
\hypertarget{classTrkRigGeoCut_e9361bca574d1dfefd9b3beabc7aa268}{ |
| 113 |
\index{TrkRigGeoCut@{TrkRigGeoCut}!\_\-thresholdCoeff@{\_\-thresholdCoeff}} |
| 114 |
\index{\_\-thresholdCoeff@{\_\-thresholdCoeff}!TrkRigGeoCut@{TrkRigGeoCut}} |
| 115 |
\subsubsection[{\_\-thresholdCoeff}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf TrkRigGeoCut::\_\-thresholdCoeff}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}} |
| 116 |
\label{classTrkRigGeoCut_e9361bca574d1dfefd9b3beabc7aa268} |
| 117 |
|
| 118 |
|
| 119 |
|
| 120 |
|
| 121 |
Definition at line 54 of file TrkRigGeoCut.h. |
| 122 |
|
| 123 |
Referenced by Check(), and GetThresholdCoeff(). |
| 124 |
|
| 125 |
The documentation for this class was generated from the following files:\begin{CompactItemize} |
| 126 |
\item |
| 127 |
TrkCuts/TrkRigGeoCut/\hyperlink{TrkRigGeoCut_8h}{TrkRigGeoCut.h}\item |
| 128 |
TrkCuts/TrkRigGeoCut/\hyperlink{TrkRigGeoCut_8cpp}{TrkRigGeoCut.cpp}\end{CompactItemize} |
Parent Directory
| 
Revision Log