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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1.1.1 by pam-fi, Wed May 27 13:30:02 2009 UTC revision 1.3 by pam-fi, Fri Sep 25 15:44:19 2009 UTC
# Line 16  Inheritance diagram for CaloCrossCut::\b Line 16  Inheritance diagram for CaloCrossCut::\b
16  \subsection*{Public Member Functions}  \subsection*{Public Member Functions}
17  \begin{CompactItemize}  \begin{CompactItemize}
18  \item  \item
19  \hyperlink{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}{CaloCrossCut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis)  \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  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}{$\sim$CaloCrossCut} ()  \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  \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26  int \hyperlink{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{Check} (PamLevel2 $\ast$event)  int \hyperlink{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{Check} (PamLevel2 $\ast$event)
27  \begin{CompactList}\small\item\em The calorimeter last plane check. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em The calorimeter last plane check. \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloCrossCut_6443179bfcb21cef379b8383440eda5c}{\_\-xCaloAxis}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloCrossCut_bf61655ea8330e0c7e4139ab1e3809ec}{\_\-yCaloAxis}  
 \end{CompactItemize}  
28    
29    
30  \subsection{Detailed Description}  \subsection{Detailed Description}
31  The calorimeter last plane cut.  The calorimeter last plane cut.
32    
33  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.  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.
   
 CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the \hyperlink{classCaloAxis}{CaloAxis} objects).  
34    
35  Definition at line 30 of file CaloCrossCut.h.  CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects).
36    
37  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
38  \hypertarget{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}{  \hypertarget{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}{
39  \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}  \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
40  \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}  \index{CaloCrossCut@{CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}
41  \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{]}}}}  \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}  \label{classCaloCrossCut_33b00ac9d115f74bd2aa0c6418a61c0d}
43    
44    
45  Constructor.  Constructor.
46    
47  The \hyperlink{classCaloAxis}{CaloAxis} arguments are pointers to objects which contain the calorimeter track information for current event.  The CaloAxis arguments are pointers to objects which contain the calorimeter track information for current event.
48    
49  \begin{Desc}  \begin{Desc}
50  \item[Parameters:]  \item[Parameters:]
51  \begin{description}  \begin{description}
52  \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}  \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}  \end{Desc}
54    
55    
 Definition at line 42 of file CaloCrossCut.h.\hypertarget{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}{  
 \index{CaloCrossCut@{CaloCrossCut}!$\sim$CaloCrossCut@{$\sim$CaloCrossCut}}  
 \index{$\sim$CaloCrossCut@{$\sim$CaloCrossCut}!CaloCrossCut@{CaloCrossCut}}  
 \subsubsection[{$\sim$CaloCrossCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloCrossCut::$\sim$CaloCrossCut ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classCaloCrossCut_30eff9bbcbcee85132b85fccd78159fe}  
   
   
 Destructor.  
   
   
   
 Definition at line 46 of file CaloCrossCut.h.  
   
56  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
57  \hypertarget{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{  \hypertarget{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{
58  \index{CaloCrossCut@{CaloCrossCut}!Check@{Check}}  \index{CaloCrossCut@{CaloCrossCut}!Check@{Check}}
# Line 88  The calorimeter last plane check. Line 69  The calorimeter last plane check.
69  \item[{\em event}]The event to analyze. \end{description}  \item[{\em event}]The event to analyze. \end{description}
70  \end{Desc}  \end{Desc}
71  \begin{Desc}  \begin{Desc}
72  \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  \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}  0 otherwise \end{Desc}
75    
76    
77  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
78    
 Definition at line 12 of file CaloCrossCut.cpp.  
   
 References \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetQ().  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classCaloCrossCut_6443179bfcb21cef379b8383440eda5c}{  
 \index{CaloCrossCut@{CaloCrossCut}!\_\-xCaloAxis@{\_\-xCaloAxis}}  
 \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloCrossCut@{CaloCrossCut}}  
 \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloCrossCut::\_\-xCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloCrossCut_6443179bfcb21cef379b8383440eda5c}  
   
   
   
   
 Definition at line 58 of file CaloCrossCut.h.  
   
 Referenced by Check().\hypertarget{classCaloCrossCut_bf61655ea8330e0c7e4139ab1e3809ec}{  
 \index{CaloCrossCut@{CaloCrossCut}!\_\-yCaloAxis@{\_\-yCaloAxis}}  
 \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloCrossCut@{CaloCrossCut}}  
 \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloCrossCut::\_\-yCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloCrossCut_bf61655ea8330e0c7e4139ab1e3809ec}  
   
   
   
   
 Definition at line 58 of file CaloCrossCut.h.  
   
 Referenced by Check().  
   
79  The documentation for this class was generated from the following files:\begin{CompactItemize}  The documentation for this class was generated from the following files:\begin{CompactItemize}
80  \item  \item
81  CaloCuts/CaloCrossCut/\hyperlink{CaloCrossCut_8h}{CaloCrossCut.h}\item  CaloCuts/CaloCrossCut/\hyperlink{CaloCrossCut_8h}{CaloCrossCut.h}\item
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.23