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

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

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

revision 1.1 by pam-fi, Wed May 27 13:30:02 2009 UTC revision 1.2 by pam-fi, Fri Jun 5 13:15:01 2009 UTC
# Line 2  Line 2 
2  \section{CaloNHitCut Class Reference}  \section{CaloNHitCut Class Reference}
3  \label{classCaloNHitCut}\index{CaloNHitCut@{CaloNHitCut}}  \label{classCaloNHitCut}\index{CaloNHitCut@{CaloNHitCut}}
4  }  }
5  The number of hits cut for the calorimeter. An event survives this selection if the number of hit planes in the calorimeter is greater than some value. 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.    The number of hits cut for the calorimeter. An event survives this selection if the number of hit planes in the calorimeter is greater than some value. 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.  
6    
7    
8  {\tt \#include $<$CaloNHitCut.h$>$}  {\tt \#include $<$CaloNHitCut.h$>$}
# Line 16  Inheritance diagram for CaloNHitCut::\be Line 16  Inheritance diagram for CaloNHitCut::\be
16  \subsection*{Public Member Functions}  \subsection*{Public Member Functions}
17  \begin{CompactItemize}  \begin{CompactItemize}
18  \item  \item
19  \hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis, int nMinHit=10)  \hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, int nMinHit=10)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{$\sim$CaloNHitCut} ()  \hypertarget{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{
22    \hyperlink{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{$\sim$CaloNHitCut} ()}
23    \label{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}
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{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{Check} (PamLevel2 $\ast$event)  int \hyperlink{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{Check} (PamLevel2 $\ast$event)
27  \begin{CompactList}\small\item\em The number of hit planes check. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em The number of hit planes check. \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloNHitCut_30652791bd9af9d61c5a156fc85f922a}{\_\-xCaloAxis}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloNHitCut_a2561d175842814d056ffbd99b50ea6e}{\_\-yCaloAxis}  
 \item  
 int \hyperlink{classCaloNHitCut_4a261716ce5e71159d2da6414a819a9a}{\_\-nMinHit}  
 \end{CompactItemize}  
28    
29    
30  \subsection{Detailed Description}  \subsection{Detailed Description}
31  The number of hits cut for the calorimeter. An event survives this selection if the number of hit planes in the calorimeter is greater than some value. 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.  The number of hits cut for the calorimeter. An event survives this selection if the number of hit planes in the calorimeter is greater than some value. 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.
32    
33  CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the \hyperlink{classCaloAxis}{CaloAxis} objects).  CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects).
   
 Definition at line 29 of file CaloNHitCut.h.  
34    
35  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
36  \hypertarget{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{  \hypertarget{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{
37  \index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}  \index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
38  \index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}  \index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
39  \subsubsection[{CaloNHitCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloNHitCut::CaloNHitCut (const char $\ast$ {\em cutName}, \/  {\bf CaloAxis} $\ast$ {\em xCaloAxis}, \/  {\bf CaloAxis} $\ast$ {\em yCaloAxis}, \/  int {\em nMinHit} = {\tt 10})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  \subsubsection[{CaloNHitCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloNHitCut::CaloNHitCut (const char $\ast$ {\em cutName}, \/  CaloAxis $\ast$ {\em xCaloAxis}, \/  CaloAxis $\ast$ {\em yCaloAxis}, \/  int {\em nMinHit} = {\tt 10})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
40  \label{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}  \label{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}
41    
42    
43  Constructor.  Constructor.
44    
45  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.
46    
47  \begin{Desc}  \begin{Desc}
48  \item[Parameters:]  \item[Parameters:]
49  \begin{description}  \begin{description}
50  \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. \item[{\em nMinHit}]The minimum number of hits. \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. \item[{\em nMinHit}]The minimum number of hits. \end{description}
51  \end{Desc}  \end{Desc}
52    
53    
 Definition at line 43 of file CaloNHitCut.h.\hypertarget{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{  
 \index{CaloNHitCut@{CaloNHitCut}!$\sim$CaloNHitCut@{$\sim$CaloNHitCut}}  
 \index{$\sim$CaloNHitCut@{$\sim$CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}  
 \subsubsection[{$\sim$CaloNHitCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloNHitCut::$\sim$CaloNHitCut ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}  
   
   
 Destructor.  
   
   
   
 Definition at line 47 of file CaloNHitCut.h.  
   
54  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
55  \hypertarget{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{  \hypertarget{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{
56  \index{CaloNHitCut@{CaloNHitCut}!Check@{Check}}  \index{CaloNHitCut@{CaloNHitCut}!Check@{Check}}
# Line 82  Definition at line 47 of file CaloNHitCu Line 61  Definition at line 47 of file CaloNHitCu
61    
62  The number of hit planes check.  The number of hit planes check.
63    
64  The check is done by looking if there is a charge release near the track, using the \hyperlink{classCaloAxis}{CaloAxis} class. If a charge greater than 0 is found by invoking \hyperlink{classCaloAxis_fa2726b36147a39e2c64d4808aa435e3}{CaloAxis::GetQ} for at least nMinHit planes (both for X and Y) the condition is fulfilled.  The check is done by looking if there is a charge release near the track, using the CaloAxis class. If a charge greater than 0 is found by invoking CaloAxis::GetQ for at least nMinHit planes (both for X and Y) the condition is fulfilled.
65    
66  \begin{Desc}  \begin{Desc}
67  \item[Parameters:]  \item[Parameters:]
# Line 99  The check is done by looking if there is Line 78  The check is done by looking if there is
78    
79  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
80    
 Definition at line 12 of file CaloNHitCut.cpp.  
   
 References \_\-nMinHit, \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetQ().  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classCaloNHitCut_4a261716ce5e71159d2da6414a819a9a}{  
 \index{CaloNHitCut@{CaloNHitCut}!\_\-nMinHit@{\_\-nMinHit}}  
 \index{\_\-nMinHit@{\_\-nMinHit}!CaloNHitCut@{CaloNHitCut}}  
 \subsubsection[{\_\-nMinHit}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CaloNHitCut::\_\-nMinHit}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloNHitCut_4a261716ce5e71159d2da6414a819a9a}  
   
   
   
   
 Definition at line 65 of file CaloNHitCut.h.  
   
 Referenced by Check().\hypertarget{classCaloNHitCut_30652791bd9af9d61c5a156fc85f922a}{  
 \index{CaloNHitCut@{CaloNHitCut}!\_\-xCaloAxis@{\_\-xCaloAxis}}  
 \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloNHitCut@{CaloNHitCut}}  
 \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloNHitCut::\_\-xCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloNHitCut_30652791bd9af9d61c5a156fc85f922a}  
   
   
   
   
 Definition at line 64 of file CaloNHitCut.h.  
   
 Referenced by Check().\hypertarget{classCaloNHitCut_a2561d175842814d056ffbd99b50ea6e}{  
 \index{CaloNHitCut@{CaloNHitCut}!\_\-yCaloAxis@{\_\-yCaloAxis}}  
 \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloNHitCut@{CaloNHitCut}}  
 \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloNHitCut::\_\-yCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloNHitCut_a2561d175842814d056ffbd99b50ea6e}  
   
   
   
   
 Definition at line 64 of file CaloNHitCut.h.  
   
 Referenced by Check().  
   
81  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}
82  \item  \item
83  CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8h}{CaloNHitCut.h}\item  CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8h}{CaloNHitCut.h}\item
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.23