/[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.2 - (show annotations) (download) (as text)
Fri Jun 5 13:15:06 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
Changes since 1.1: +4 -39 lines
File MIME type: application/x-tex
Updated.

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 \hypertarget{classTrkRigCut_deb60f04e638a15bdfafd4e3d41125b2}{
22 \hyperlink{classTrkRigCut_deb60f04e638a15bdfafd4e3d41125b2}{$\sim$TrkRigCut} ()}
23 \label{classTrkRigCut_deb60f04e638a15bdfafd4e3d41125b2}
24
25 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26 int \hyperlink{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}{Check} (PamLevel2 $\ast$event)
27 \begin{CompactList}\small\item\em The rigidity check. \item\end{CompactList}\end{CompactItemize}
28
29
30 \subsection{Detailed Description}
31 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.
32
33 \subsection{Constructor \& Destructor Documentation}
34 \hypertarget{classTrkRigCut_c783ce6df5436f19bce5c5dcb2338841}{
35 \index{TrkRigCut@{TrkRigCut}!TrkRigCut@{TrkRigCut}}
36 \index{TrkRigCut@{TrkRigCut}!TrkRigCut@{TrkRigCut}}
37 \subsubsection[{TrkRigCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkRigCut::TrkRigCut (const char $\ast$ {\em cutName}, \/ float {\em minRigidity})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
38 \label{classTrkRigCut_c783ce6df5436f19bce5c5dcb2338841}
39
40
41 Constructor.
42
43 \begin{Desc}
44 \item[Parameters:]
45 \begin{description}
46 \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}
47 \end{Desc}
48
49
50 \subsection{Member Function Documentation}
51 \hypertarget{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}{
52 \index{TrkRigCut@{TrkRigCut}!Check@{Check}}
53 \index{Check@{Check}!TrkRigCut@{TrkRigCut}}
54 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int TrkRigCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
55 \label{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}
56
57
58 The rigidity check.
59
60 \begin{Desc}
61 \item[Parameters:]
62 \begin{description}
63 \item[{\em event}]The event to analyze. \end{description}
64 \end{Desc}
65 \begin{Desc}
66 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the rigidity is greater than the threshold
67
68 0 otherwise. \end{Desc}
69
70
71 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
72
73 The documentation for this class was generated from the following files:\begin{CompactItemize}
74 \item
75 TrkCuts/TrkRigCut/\hyperlink{TrkRigCut_8h}{TrkRigCut.h}\item
76 TrkCuts/TrkRigCut/\hyperlink{TrkRigCut_8cpp}{TrkRigCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23