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

Annotation of /PamCut/doc/Doxygen/latex/classCaloCrossCut.tex

Parent Directory Parent Directory | Revision Log Revision Log


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

1 pam-fi 1.1 \hypertarget{classCaloCrossCut}{
2     \section{CaloCrossCut Class Reference}
3     \label{classCaloCrossCut}\index{CaloCrossCut@{CaloCrossCut}}
4     }
5     The calorimeter last plane cut.
6    
7    
8     {\tt \#include $<$CaloCrossCut.h$>$}
9    
10     Inheritance diagram for CaloCrossCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classCaloCrossCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}{CaloCrossCut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}{$\sim$CaloCrossCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The calorimeter last plane check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloCrossCut_6443179bfcb21cef379b8383440eda5c}{\_\-xCaloAxis}
29     \item
30     \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloCrossCut_bf61655ea8330e0c7e4139ab1e3809ec}{\_\-yCaloAxis}
31     \end{CompactItemize}
32    
33    
34     \subsection{Detailed Description}
35     The calorimeter last plane cut.
36    
37     Checks if the particle has crossed the last calorimeter plane. The current implementation uses the \hyperlink{classCaloAxis}{CaloAxis} objects; to save computing time, the class assumes that the track is externally computed for each event and stored in \hyperlink{classCaloAxis}{CaloAxis} objects; pointers to these objects are passed as arguments to the constructor. The Check method will then ignore the PamLevel2 $\ast$event and assume that the current content of the \hyperlink{classCaloAxis}{CaloAxis} objects are relative to the current event. It is an user's task to ensure that these assumptions are fulfilled every time Check or ApplyCut are called.
38    
39     CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the \hyperlink{classCaloAxis}{CaloAxis} objects).
40    
41     Definition at line 30 of file CaloCrossCut.h.
42    
43     \subsection{Constructor \& Destructor Documentation}
44     \hypertarget{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}{
45     \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
46     \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
47     \subsubsection[{CaloCrossCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloCrossCut::CaloCrossCut (const char $\ast$ {\em cutName}, \/ {\bf CaloAxis} $\ast$ {\em xCaloAxis}, \/ {\bf CaloAxis} $\ast$ {\em yCaloAxis})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
48     \label{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}
49    
50    
51     Constructor.
52    
53     The \hyperlink{classCaloAxis}{CaloAxis} arguments are pointers to objects which contain the calorimeter track information for current event.
54    
55     \begin{Desc}
56     \item[Parameters:]
57     \begin{description}
58     \item[{\em cutName}]The cut name. \item[{\em xCaloAxis}]The pointer to the \hyperlink{classCaloAxis}{CaloAxis} object for X axis. \item[{\em yCaloAxis}]The pointer to the \hyperlink{classCaloAxis}{CaloAxis} object for Y axis. \end{description}
59     \end{Desc}
60    
61    
62     Definition at line 42 of file CaloCrossCut.h.\hypertarget{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}{
63     \index{CaloCrossCut@{CaloCrossCut}!$\sim$CaloCrossCut@{$\sim$CaloCrossCut}}
64     \index{$\sim$CaloCrossCut@{$\sim$CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
65     \subsubsection[{$\sim$CaloCrossCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloCrossCut::$\sim$CaloCrossCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
66     \label{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}
67    
68    
69     Destructor.
70    
71    
72    
73     Definition at line 46 of file CaloCrossCut.h.
74    
75     \subsection{Member Function Documentation}
76     \hypertarget{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{
77     \index{CaloCrossCut@{CaloCrossCut}!Check@{Check}}
78     \index{Check@{Check}!CaloCrossCut@{CaloCrossCut}}
79     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloCrossCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
80     \label{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}
81    
82    
83     The calorimeter last plane check.
84    
85     \begin{Desc}
86     \item[Parameters:]
87     \begin{description}
88     \item[{\em event}]The event to analyze. \end{description}
89     \end{Desc}
90     \begin{Desc}
91     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if charge released in plane 22 is greater than 0 (from \hyperlink{classCaloAxis}{CaloAxis}) for both X and Y
92    
93     0 otherwise \end{Desc}
94    
95    
96     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
97    
98     Definition at line 12 of file CaloCrossCut.cpp.
99    
100     References \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetQ().
101    
102     \subsection{Member Data Documentation}
103     \hypertarget{classCaloCrossCut_6443179bfcb21cef379b8383440eda5c}{
104     \index{CaloCrossCut@{CaloCrossCut}!\_\-xCaloAxis@{\_\-xCaloAxis}}
105     \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloCrossCut@{CaloCrossCut}}
106     \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloCrossCut::\_\-xCaloAxis}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
107     \label{classCaloCrossCut_6443179bfcb21cef379b8383440eda5c}
108    
109    
110    
111    
112     Definition at line 58 of file CaloCrossCut.h.
113    
114     Referenced by Check().\hypertarget{classCaloCrossCut_bf61655ea8330e0c7e4139ab1e3809ec}{
115     \index{CaloCrossCut@{CaloCrossCut}!\_\-yCaloAxis@{\_\-yCaloAxis}}
116     \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloCrossCut@{CaloCrossCut}}
117     \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloCrossCut::\_\-yCaloAxis}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
118     \label{classCaloCrossCut_bf61655ea8330e0c7e4139ab1e3809ec}
119    
120    
121    
122    
123     Definition at line 58 of file CaloCrossCut.h.
124    
125     Referenced by Check().
126    
127     The documentation for this class was generated from the following files:\begin{CompactItemize}
128     \item
129     CaloCuts/CaloCrossCut/\hyperlink{CaloCrossCut_8h}{CaloCrossCut.h}\item
130     CaloCuts/CaloCrossCut/\hyperlink{CaloCrossCut_8cpp}{CaloCrossCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23