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

Diff of /PamCut/doc/Doxygen/latex/classCaloIonCut.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:27 2009 UTC
# Line 16  Inheritance diagram for CaloIonCut::\beg Line 16  Inheritance diagram for CaloIonCut::\beg
16  \subsection*{Public Member Functions}  \subsection*{Public Member Functions}
17  \begin{CompactItemize}  \begin{CompactItemize}
18  \item  \item
19  \hyperlink{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}{CaloIonCut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis, float minRelease=0., float maxRelease=3.)  \hyperlink{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}{CaloIonCut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, float minRelease=0., float maxRelease=3.)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}{$\sim$CaloIonCut} ()  \hypertarget{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}{
22    \hyperlink{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}{$\sim$CaloIonCut} ()}
23    \label{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}
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{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{Check} (PamLevel2 $\ast$event)  int \hyperlink{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{Check} (PamLevel2 $\ast$event)
27  \begin{CompactList}\small\item\em The calorimeter ionization check. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em The calorimeter ionization check. \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloIonCut_d5fefbe29b26f0c8d299aaa8d95f70c5}{\_\-xCaloAxis}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloIonCut_f26eab85609cbd18cf6579c9fe79dd08}{\_\-yCaloAxis}  
 \item  
 float \hyperlink{classCaloIonCut_9e0be06d5e079c5ea249ba7cc4fe203b}{\_\-minRelease}  
 \item  
 float \hyperlink{classCaloIonCut_4c1f2201a07e1bf6f72df1b958721677}{\_\-maxRelease}  
 \end{CompactItemize}  
28    
29    
30  \subsection{Detailed Description}  \subsection{Detailed Description}
31  The calorimeter ionization cut.  The calorimeter ionization cut.
32    
33  Checks the energy release on the first 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 the energy release on the first 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 CaloIonCut.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{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}{  \hypertarget{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}{
39  \index{CaloIonCut@{CaloIonCut}!CaloIonCut@{CaloIonCut}}  \index{CaloIonCut@{CaloIonCut}!CaloIonCut@{CaloIonCut}}
40  \index{CaloIonCut@{CaloIonCut}!CaloIonCut@{CaloIonCut}}  \index{CaloIonCut@{CaloIonCut}!CaloIonCut@{CaloIonCut}}
41  \subsubsection[{CaloIonCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloIonCut::CaloIonCut (const char $\ast$ {\em cutName}, \/  {\bf CaloAxis} $\ast$ {\em xCaloAxis}, \/  {\bf CaloAxis} $\ast$ {\em yCaloAxis}, \/  float {\em minRelease} = {\tt 0.}, \/  float {\em maxRelease} = {\tt 3.})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  \subsubsection[{CaloIonCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloIonCut::CaloIonCut (const char $\ast$ {\em cutName}, \/  CaloAxis $\ast$ {\em xCaloAxis}, \/  CaloAxis $\ast$ {\em yCaloAxis}, \/  float {\em minRelease} = {\tt 0.}, \/  float {\em maxRelease} = {\tt 3.})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
42  \label{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}  \label{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}
43    
44    
45  Constructor.  Constructor.
46    
47  The \hyperlink{classCaloAxis}{CaloAxis} arguments are objects which contain the calorimeter track information for current event.  The CaloAxis arguments are 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 maxRelease}]The maximum mean ionization (in MIP) in the tracker planes above which an event is discarded. Default: 3. \item[{\em minRelease}]The minimum mean ionization (in MIP) in the tracker planes below which an event is discarded. Default: 0. \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 maxRelease}]The maximum mean ionization (in MIP) in the tracker planes above which an event is discarded. Default: 3. \item[{\em minRelease}]The minimum mean ionization (in MIP) in the tracker planes below which an event is discarded. Default: 0. \end{description}
53  \end{Desc}  \end{Desc}
54    
55    
 Definition at line 44 of file CaloIonCut.h.\hypertarget{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}{  
 \index{CaloIonCut@{CaloIonCut}!$\sim$CaloIonCut@{$\sim$CaloIonCut}}  
 \index{$\sim$CaloIonCut@{$\sim$CaloIonCut}!CaloIonCut@{CaloIonCut}}  
 \subsubsection[{$\sim$CaloIonCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloIonCut::$\sim$CaloIonCut ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}  
   
   
 Destructor.  
   
   
   
 Definition at line 49 of file CaloIonCut.h.  
   
56  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
57  \hypertarget{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{  \hypertarget{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{
58  \index{CaloIonCut@{CaloIonCut}!Check@{Check}}  \index{CaloIonCut@{CaloIonCut}!Check@{Check}}
# Line 92  The calorimeter ionization check. Line 69  The calorimeter ionization 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 0 (from \hyperlink{classCaloAxis}{CaloAxis}) is greater than minRelease and lesser than maxRelease, for both X and Y  \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if charge released in plane 0 (from CaloAxis) is greater than minRelease and lesser than maxRelease, 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 CaloIonCut.cpp.  
   
 References \_\-maxRelease, \_\-minRelease, \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetQ().  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classCaloIonCut_4c1f2201a07e1bf6f72df1b958721677}{  
 \index{CaloIonCut@{CaloIonCut}!\_\-maxRelease@{\_\-maxRelease}}  
 \index{\_\-maxRelease@{\_\-maxRelease}!CaloIonCut@{CaloIonCut}}  
 \subsubsection[{\_\-maxRelease}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloIonCut::\_\-maxRelease}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloIonCut_4c1f2201a07e1bf6f72df1b958721677}  
   
   
   
   
 Definition at line 62 of file CaloIonCut.h.  
   
 Referenced by Check().\hypertarget{classCaloIonCut_9e0be06d5e079c5ea249ba7cc4fe203b}{  
 \index{CaloIonCut@{CaloIonCut}!\_\-minRelease@{\_\-minRelease}}  
 \index{\_\-minRelease@{\_\-minRelease}!CaloIonCut@{CaloIonCut}}  
 \subsubsection[{\_\-minRelease}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloIonCut::\_\-minRelease}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloIonCut_9e0be06d5e079c5ea249ba7cc4fe203b}  
   
   
   
   
 Definition at line 62 of file CaloIonCut.h.  
   
 Referenced by Check().\hypertarget{classCaloIonCut_d5fefbe29b26f0c8d299aaa8d95f70c5}{  
 \index{CaloIonCut@{CaloIonCut}!\_\-xCaloAxis@{\_\-xCaloAxis}}  
 \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloIonCut@{CaloIonCut}}  
 \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloIonCut::\_\-xCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloIonCut_d5fefbe29b26f0c8d299aaa8d95f70c5}  
   
   
   
   
 Definition at line 61 of file CaloIonCut.h.  
   
 Referenced by Check().\hypertarget{classCaloIonCut_f26eab85609cbd18cf6579c9fe79dd08}{  
 \index{CaloIonCut@{CaloIonCut}!\_\-yCaloAxis@{\_\-yCaloAxis}}  
 \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloIonCut@{CaloIonCut}}  
 \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloIonCut::\_\-yCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloIonCut_f26eab85609cbd18cf6579c9fe79dd08}  
   
   
   
   
 Definition at line 61 of file CaloIonCut.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/CaloIonCut/\hyperlink{CaloIonCut_8h}{CaloIonCut.h}\item  CaloCuts/CaloIonCut/CaloIonCut.h\item
82  CaloCuts/CaloIonCut/\hyperlink{CaloIonCut_8cpp}{CaloIonCut.cpp}\end{CompactItemize}  CaloCuts/CaloIonCut/\hyperlink{CaloIonCut_8cpp}{CaloIonCut.cpp}\end{CompactItemize}
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.23