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

Diff of /PamCut/doc/Doxygen/latex/classCaloGeomCut.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:43:48 2009 UTC
# Line 16  Inheritance diagram for CaloGeomCut::\be Line 16  Inheritance diagram for CaloGeomCut::\be
16  \subsection*{Public Member Functions}  \subsection*{Public Member Functions}
17  \begin{CompactItemize}  \begin{CompactItemize}
18  \item  \item
19  \hyperlink{classCaloGeomCut_2ea81481d3f2a0c58dbdf865b51d91ca}{CaloGeomCut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis, float xTolCaloTrack=0.7, float yTolCaloTrack=0.7)  \hyperlink{classCaloGeomCut_2ea81481d3f2a0c58dbdf865b51d91ca}{CaloGeomCut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, float xTolCaloTrack=0.7, float yTolCaloTrack=0.7)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classCaloGeomCut_fca3678606b1ca4e9c347c4fd620a97d}{$\sim$CaloGeomCut} ()  \hypertarget{classCaloGeomCut_fca3678606b1ca4e9c347c4fd620a97d}{
22    \hyperlink{classCaloGeomCut_fca3678606b1ca4e9c347c4fd620a97d}{$\sim$CaloGeomCut} ()}
23    \label{classCaloGeomCut_fca3678606b1ca4e9c347c4fd620a97d}
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{classCaloGeomCut_ef28e99e442a7ab58fb8250107ac82e9}{Check} (PamLevel2 $\ast$event)  int \hyperlink{classCaloGeomCut_ef28e99e442a7ab58fb8250107ac82e9}{Check} (PamLevel2 $\ast$event)
27  \begin{CompactList}\small\item\em The geometry check using the calorimeter's track. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em The geometry check using the calorimeter's track. \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloGeomCut_c89e7de16721b709f2669893b2b74d9a}{\_\-xCaloAxis}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloGeomCut_79c3f56c8aae2949b2c14288d16a9ef1}{\_\-yCaloAxis}  
 \item  
 float \hyperlink{classCaloGeomCut_83765f6e8982cb5cff48ea41dc420540}{\_\-xTolCaloTrack}  
 \item  
 float \hyperlink{classCaloGeomCut_dbc713c7c193c03c02b481b704a3020d}{\_\-yTolCaloTrack}  
 \end{CompactItemize}  
28    
29    
30  \subsection{Detailed Description}  \subsection{Detailed Description}
31  The geometric cut using the calorimeter's track.  The geometric cut using the calorimeter's track.
32    
33  This cut checks if the track obtained from the calorimeter is inside the fiducial acceptance. 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.  This cut checks if the track obtained from the calorimeter is inside the fiducial acceptance. 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 CaloGeomCut.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{classCaloGeomCut_2ea81481d3f2a0c58dbdf865b51d91ca}{  \hypertarget{classCaloGeomCut_2ea81481d3f2a0c58dbdf865b51d91ca}{
39  \index{CaloGeomCut@{CaloGeomCut}!CaloGeomCut@{CaloGeomCut}}  \index{CaloGeomCut@{CaloGeomCut}!CaloGeomCut@{CaloGeomCut}}
40  \index{CaloGeomCut@{CaloGeomCut}!CaloGeomCut@{CaloGeomCut}}  \index{CaloGeomCut@{CaloGeomCut}!CaloGeomCut@{CaloGeomCut}}
41  \subsubsection[{CaloGeomCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloGeomCut::CaloGeomCut (const char $\ast$ {\em cutName}, \/  {\bf CaloAxis} $\ast$ {\em xCaloAxis}, \/  {\bf CaloAxis} $\ast$ {\em yCaloAxis}, \/  float {\em xTolCaloTrack} = {\tt 0.7}, \/  float {\em yTolCaloTrack} = {\tt 0.7})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  \subsubsection[{CaloGeomCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloGeomCut::CaloGeomCut (const char $\ast$ {\em cutName}, \/  CaloAxis $\ast$ {\em xCaloAxis}, \/  CaloAxis $\ast$ {\em yCaloAxis}, \/  float {\em xTolCaloTrack} = {\tt 0.7}, \/  float {\em yTolCaloTrack} = {\tt 0.7})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
42  \label{classCaloGeomCut_2ea81481d3f2a0c58dbdf865b51d91ca}  \label{classCaloGeomCut_2ea81481d3f2a0c58dbdf865b51d91ca}
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's 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. \item[{\em xTolCaloTrack}]The tolerance for X view which defines the fiducial acceptance. \item[{\em yTolCaloTrack}]The tolerance for Y view which defines the fiducial acceptance. \end{description}  \item[{\em cutName}]The cut's 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. \item[{\em xTolCaloTrack}]The tolerance for X view which defines the fiducial acceptance. \item[{\em yTolCaloTrack}]The tolerance for Y view which defines the fiducial acceptance. \end{description}
53  \end{Desc}  \end{Desc}
54    
55    
 Definition at line 44 of file CaloGeomCut.h.\hypertarget{classCaloGeomCut_fca3678606b1ca4e9c347c4fd620a97d}{  
 \index{CaloGeomCut@{CaloGeomCut}!$\sim$CaloGeomCut@{$\sim$CaloGeomCut}}  
 \index{$\sim$CaloGeomCut@{$\sim$CaloGeomCut}!CaloGeomCut@{CaloGeomCut}}  
 \subsubsection[{$\sim$CaloGeomCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloGeomCut::$\sim$CaloGeomCut ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classCaloGeomCut_fca3678606b1ca4e9c347c4fd620a97d}  
   
   
 Destructor.  
   
   
   
 Definition at line 49 of file CaloGeomCut.h.  
   
56  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
57  \hypertarget{classCaloGeomCut_ef28e99e442a7ab58fb8250107ac82e9}{  \hypertarget{classCaloGeomCut_ef28e99e442a7ab58fb8250107ac82e9}{
58  \index{CaloGeomCut@{CaloGeomCut}!Check@{Check}}  \index{CaloGeomCut@{CaloGeomCut}!Check@{Check}}
# Line 92  The geometry check using the calorimeter Line 69  The geometry check using the calorimeter
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 CaloGeomCut.cpp.  
   
 References \_\-xCaloAxis, \_\-xTolCaloTrack, \_\-yCaloAxis, \_\-yTolCaloTrack, CUTOK, and CaloAxis::par.  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classCaloGeomCut_c89e7de16721b709f2669893b2b74d9a}{  
 \index{CaloGeomCut@{CaloGeomCut}!\_\-xCaloAxis@{\_\-xCaloAxis}}  
 \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloGeomCut@{CaloGeomCut}}  
 \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloGeomCut::\_\-xCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloGeomCut_c89e7de16721b709f2669893b2b74d9a}  
   
   
   
   
 Definition at line 61 of file CaloGeomCut.h.  
   
 Referenced by Check().\hypertarget{classCaloGeomCut_83765f6e8982cb5cff48ea41dc420540}{  
 \index{CaloGeomCut@{CaloGeomCut}!\_\-xTolCaloTrack@{\_\-xTolCaloTrack}}  
 \index{\_\-xTolCaloTrack@{\_\-xTolCaloTrack}!CaloGeomCut@{CaloGeomCut}}  
 \subsubsection[{\_\-xTolCaloTrack}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloGeomCut::\_\-xTolCaloTrack}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloGeomCut_83765f6e8982cb5cff48ea41dc420540}  
   
   
   
   
 Definition at line 62 of file CaloGeomCut.h.  
   
 Referenced by Check().\hypertarget{classCaloGeomCut_79c3f56c8aae2949b2c14288d16a9ef1}{  
 \index{CaloGeomCut@{CaloGeomCut}!\_\-yCaloAxis@{\_\-yCaloAxis}}  
 \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloGeomCut@{CaloGeomCut}}  
 \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloGeomCut::\_\-yCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloGeomCut_79c3f56c8aae2949b2c14288d16a9ef1}  
   
   
   
   
 Definition at line 61 of file CaloGeomCut.h.  
   
 Referenced by Check().\hypertarget{classCaloGeomCut_dbc713c7c193c03c02b481b704a3020d}{  
 \index{CaloGeomCut@{CaloGeomCut}!\_\-yTolCaloTrack@{\_\-yTolCaloTrack}}  
 \index{\_\-yTolCaloTrack@{\_\-yTolCaloTrack}!CaloGeomCut@{CaloGeomCut}}  
 \subsubsection[{\_\-yTolCaloTrack}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloGeomCut::\_\-yTolCaloTrack}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloGeomCut_dbc713c7c193c03c02b481b704a3020d}  
   
   
   
   
 Definition at line 62 of file CaloGeomCut.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/CaloGeomCut/\hyperlink{CaloGeomCut_8h}{CaloGeomCut.h}\item  CaloCuts/CaloGeomCut/\hyperlink{CaloGeomCut_8h}{CaloGeomCut.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