/[PAMELA software]/PamCut/doc/Doxygen/latex/classTrkRigCut.tex
ViewVC logotype

Contents of /PamCut/doc/Doxygen/latex/classTrkRigCut.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations) (download) (as text)
Wed May 27 13:30:01 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: application/x-tex
Initial revision

1 \hypertarget{classTrkRigCut}{
2 \section{TrkRigCut Class Reference}
3 \label{classTrkRigCut}\index{TrkRigCut@{TrkRigCut}}
4 }
5 The rigidity cut. This cut discards all the events whose rigidity is less than the threshold. Here rigidity is defined as p/Z (GV) where Z is the particle charge (WITH SIGN) and p the momentum modulus: therefore rigidity can be positive or negative.
6
7
8 {\tt \#include $<$TrkRigCut.h$>$}
9
10 Inheritance diagram for TrkRigCut::\begin{figure}[H]
11 \begin{center}
12 \leavevmode
13 \includegraphics[height=2cm]{classTrkRigCut}
14 \end{center}
15 \end{figure}
16 \subsection*{Public Member Functions}
17 \begin{CompactItemize}
18 \item
19 \hyperlink{classTrkRigCut_c783ce6df5436f19bce5c5dcb2338841}{TrkRigCut} (const char $\ast$cutName, float minRigidity)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 \hyperlink{classTrkRigCut_deb60f04e638a15bdfafd4e3d41125b2}{$\sim$TrkRigCut} ()
22 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23 int \hyperlink{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}{Check} (PamLevel2 $\ast$event)
24 \begin{CompactList}\small\item\em The rigidity check. \item\end{CompactList}\end{CompactItemize}
25 \subsection*{Private Attributes}
26 \begin{CompactItemize}
27 \item
28 float \hyperlink{classTrkRigCut_926892b16fd69c7d69a5681c6cafd353}{\_\-minRigidity}
29 \end{CompactItemize}
30
31
32 \subsection{Detailed Description}
33 The rigidity cut. This cut discards all the events whose rigidity is less than the threshold. Here rigidity is defined as p/Z (GV) where Z is the particle charge (WITH SIGN) and p the momentum modulus: therefore rigidity can be positive or negative.
34
35 Definition at line 19 of file TrkRigCut.h.
36
37 \subsection{Constructor \& Destructor Documentation}
38 \hypertarget{classTrkRigCut_c783ce6df5436f19bce5c5dcb2338841}{
39 \index{TrkRigCut@{TrkRigCut}!TrkRigCut@{TrkRigCut}}
40 \index{TrkRigCut@{TrkRigCut}!TrkRigCut@{TrkRigCut}}
41 \subsubsection[{TrkRigCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkRigCut::TrkRigCut (const char $\ast$ {\em cutName}, \/ float {\em minRigidity})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
42 \label{classTrkRigCut_c783ce6df5436f19bce5c5dcb2338841}
43
44
45 Constructor.
46
47 \begin{Desc}
48 \item[Parameters:]
49 \begin{description}
50 \item[{\em cutName}]The cut's name. \item[{\em minRigidity}]The minimum rigidity p/Z (in GV) below which an event will be discarded. Can be positive or negative. \end{description}
51 \end{Desc}
52
53
54 Definition at line 28 of file TrkRigCut.h.\hypertarget{classTrkRigCut_deb60f04e638a15bdfafd4e3d41125b2}{
55 \index{TrkRigCut@{TrkRigCut}!$\sim$TrkRigCut@{$\sim$TrkRigCut}}
56 \index{$\sim$TrkRigCut@{$\sim$TrkRigCut}!TrkRigCut@{TrkRigCut}}
57 \subsubsection[{$\sim$TrkRigCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkRigCut::$\sim$TrkRigCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
58 \label{classTrkRigCut_deb60f04e638a15bdfafd4e3d41125b2}
59
60
61 Destructor.
62
63
64
65 Definition at line 32 of file TrkRigCut.h.
66
67 \subsection{Member Function Documentation}
68 \hypertarget{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}{
69 \index{TrkRigCut@{TrkRigCut}!Check@{Check}}
70 \index{Check@{Check}!TrkRigCut@{TrkRigCut}}
71 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int TrkRigCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
72 \label{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}
73
74
75 The rigidity check.
76
77 \begin{Desc}
78 \item[Parameters:]
79 \begin{description}
80 \item[{\em event}]The event to analyze. \end{description}
81 \end{Desc}
82 \begin{Desc}
83 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the rigidity is greater than the threshold
84
85 0 otherwise. \end{Desc}
86
87
88 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
89
90 Definition at line 12 of file TrkRigCut.cpp.
91
92 References \_\-minRigidity, and CUTOK.
93
94 \subsection{Member Data Documentation}
95 \hypertarget{classTrkRigCut_926892b16fd69c7d69a5681c6cafd353}{
96 \index{TrkRigCut@{TrkRigCut}!\_\-minRigidity@{\_\-minRigidity}}
97 \index{\_\-minRigidity@{\_\-minRigidity}!TrkRigCut@{TrkRigCut}}
98 \subsubsection[{\_\-minRigidity}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf TrkRigCut::\_\-minRigidity}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
99 \label{classTrkRigCut_926892b16fd69c7d69a5681c6cafd353}
100
101
102
103
104 Definition at line 45 of file TrkRigCut.h.
105
106 Referenced by Check().
107
108 The documentation for this class was generated from the following files:\begin{CompactItemize}
109 \item
110 TrkCuts/TrkRigCut/\hyperlink{TrkRigCut_8h}{TrkRigCut.h}\item
111 TrkCuts/TrkRigCut/\hyperlink{TrkRigCut_8cpp}{TrkRigCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23