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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (hide annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:02 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: DEV
CVS Tags: v0r00
Changes since 1.1: +0 -0 lines
File MIME type: application/x-tex
First import

1 pam-fi 1.1 \hypertarget{classCaloNHitCut}{
2     \section{CaloNHitCut Class Reference}
3     \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.
6    
7    
8     {\tt \#include $<$CaloNHitCut.h$>$}
9    
10     Inheritance diagram for CaloNHitCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classCaloNHitCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis, int nMinHit=10)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{$\sim$CaloNHitCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The number of hit planes check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloNHitCut_30652791bd9af9d61c5a156fc85f922a}{\_\-xCaloAxis}
29     \item
30     \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloNHitCut_a2561d175842814d056ffbd99b50ea6e}{\_\-yCaloAxis}
31     \item
32     int \hyperlink{classCaloNHitCut_4a261716ce5e71159d2da6414a819a9a}{\_\-nMinHit}
33     \end{CompactItemize}
34    
35    
36     \subsection{Detailed Description}
37     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.
38    
39     CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the \hyperlink{classCaloAxis}{CaloAxis} objects).
40    
41     Definition at line 29 of file CaloNHitCut.h.
42    
43     \subsection{Constructor \& Destructor Documentation}
44     \hypertarget{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{
45     \index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
46     \index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
47     \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{]}}}}
48     \label{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}
49    
50    
51     Constructor.
52    
53     The \hyperlink{classCaloAxis}{CaloAxis} arguments are pointers to objects which contain the calorimeter track information for current event.
54    
55     \begin{Desc}
56     \item[Parameters:]
57     \begin{description}
58     \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}
59     \end{Desc}
60    
61    
62     Definition at line 43 of file CaloNHitCut.h.\hypertarget{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{
63     \index{CaloNHitCut@{CaloNHitCut}!$\sim$CaloNHitCut@{$\sim$CaloNHitCut}}
64     \index{$\sim$CaloNHitCut@{$\sim$CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
65     \subsubsection[{$\sim$CaloNHitCut}]{\setlength{\rightskip}{0pt plus 5cm}CaloNHitCut::$\sim$CaloNHitCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
66     \label{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}
67    
68    
69     Destructor.
70    
71    
72    
73     Definition at line 47 of file CaloNHitCut.h.
74    
75     \subsection{Member Function Documentation}
76     \hypertarget{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{
77     \index{CaloNHitCut@{CaloNHitCut}!Check@{Check}}
78     \index{Check@{Check}!CaloNHitCut@{CaloNHitCut}}
79     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloNHitCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
80     \label{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}
81    
82    
83     The number of hit planes check.
84    
85     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.
86    
87     \begin{Desc}
88     \item[Parameters:]
89     \begin{description}
90     \item[{\em event}]The event to analyze. \end{description}
91     \end{Desc}
92     \begin{Desc}
93     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the track hits at least nMinHit planes both in X and Y.
94    
95     0 otherwise. \end{Desc}
96     \begin{Desc}
97     \item[See also:]\hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut::CaloNHitCut} \end{Desc}
98    
99    
100     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
101    
102     Definition at line 12 of file CaloNHitCut.cpp.
103    
104     References \_\-nMinHit, \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetQ().
105    
106     \subsection{Member Data Documentation}
107     \hypertarget{classCaloNHitCut_4a261716ce5e71159d2da6414a819a9a}{
108     \index{CaloNHitCut@{CaloNHitCut}!\_\-nMinHit@{\_\-nMinHit}}
109     \index{\_\-nMinHit@{\_\-nMinHit}!CaloNHitCut@{CaloNHitCut}}
110     \subsubsection[{\_\-nMinHit}]{\setlength{\rightskip}{0pt plus 5cm}int {\bf CaloNHitCut::\_\-nMinHit}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
111     \label{classCaloNHitCut_4a261716ce5e71159d2da6414a819a9a}
112    
113    
114    
115    
116     Definition at line 65 of file CaloNHitCut.h.
117    
118     Referenced by Check().\hypertarget{classCaloNHitCut_30652791bd9af9d61c5a156fc85f922a}{
119     \index{CaloNHitCut@{CaloNHitCut}!\_\-xCaloAxis@{\_\-xCaloAxis}}
120     \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloNHitCut@{CaloNHitCut}}
121     \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloNHitCut::\_\-xCaloAxis}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
122     \label{classCaloNHitCut_30652791bd9af9d61c5a156fc85f922a}
123    
124    
125    
126    
127     Definition at line 64 of file CaloNHitCut.h.
128    
129     Referenced by Check().\hypertarget{classCaloNHitCut_a2561d175842814d056ffbd99b50ea6e}{
130     \index{CaloNHitCut@{CaloNHitCut}!\_\-yCaloAxis@{\_\-yCaloAxis}}
131     \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloNHitCut@{CaloNHitCut}}
132     \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloNHitCut::\_\-yCaloAxis}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
133     \label{classCaloNHitCut_a2561d175842814d056ffbd99b50ea6e}
134    
135    
136    
137    
138     Definition at line 64 of file CaloNHitCut.h.
139    
140     Referenced by Check().
141    
142     The documentation for this class was generated from the following files:\begin{CompactItemize}
143     \item
144     CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8h}{CaloNHitCut.h}\item
145     CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8cpp}{CaloNHitCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23