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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations) (download) (as text)
Fri Sep 25 15:44:19 2009 UTC (15 years, 5 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: application/x-tex
Error occurred while calculating annotation data.
FILE REMOVED
Removed from repository.

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, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 \hypertarget{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}{
22 \hyperlink{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}{$\sim$CaloCrossCut} ()}
23 \label{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}
24
25 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26 int \hyperlink{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{Check} (PamLevel2 $\ast$event)
27 \begin{CompactList}\small\item\em The calorimeter last plane check. \item\end{CompactList}\end{CompactItemize}
28
29
30 \subsection{Detailed Description}
31 The calorimeter last plane cut.
32
33 Checks if the particle has crossed the last calorimeter plane. The current implementation uses the CaloAxis objects; to save computing time, the class assumes that the track is externally computed for each event and stored in 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 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.
34
35 CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects).
36
37 \subsection{Constructor \& Destructor Documentation}
38 \hypertarget{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}{
39 \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
40 \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
41 \subsubsection[{CaloCrossCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloCrossCut::CaloCrossCut (const char $\ast$ {\em cutName}, \/ CaloAxis $\ast$ {\em xCaloAxis}, \/ CaloAxis $\ast$ {\em yCaloAxis})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
42 \label{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}
43
44
45 Constructor.
46
47 The CaloAxis arguments are pointers to objects which contain the calorimeter track information for current event.
48
49 \begin{Desc}
50 \item[Parameters:]
51 \begin{description}
52 \item[{\em cutName}]The cut name. \item[{\em xCaloAxis}]The pointer to the CaloAxis object for X axis. \item[{\em yCaloAxis}]The pointer to the CaloAxis object for Y axis. \end{description}
53 \end{Desc}
54
55
56 \subsection{Member Function Documentation}
57 \hypertarget{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{
58 \index{CaloCrossCut@{CaloCrossCut}!Check@{Check}}
59 \index{Check@{Check}!CaloCrossCut@{CaloCrossCut}}
60 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloCrossCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
61 \label{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}
62
63
64 The calorimeter last plane check.
65
66 \begin{Desc}
67 \item[Parameters:]
68 \begin{description}
69 \item[{\em event}]The event to analyze. \end{description}
70 \end{Desc}
71 \begin{Desc}
72 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if charge released in plane 22 is greater than 0 (from CaloAxis) for both X and Y
73
74 0 otherwise \end{Desc}
75
76
77 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
78
79 The documentation for this class was generated from the following files:\begin{CompactItemize}
80 \item
81 CaloCuts/CaloCrossCut/\hyperlink{CaloCrossCut_8h}{CaloCrossCut.h}\item
82 CaloCuts/CaloCrossCut/\hyperlink{CaloCrossCut_8cpp}{CaloCrossCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23