Doxygen/latex/classCaloNHitCut.tex

\hypertarget{classCaloNHitCut}{
\section{CaloNHitCut Class Reference}
\label{classCaloNHitCut}\index{CaloNHitCut@{CaloNHitCut}}
}
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.  


{\tt \#include $<$CaloNHitCut.h$>$}

Inheritance diagram for CaloNHitCut::\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2cm]{classCaloNHitCut}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
\hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, int nMinHit=10)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
\hypertarget{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{
\hyperlink{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{$\sim$CaloNHitCut} ()}
\label{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}

\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
int \hyperlink{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{Check} (PamLevel2 $\ast$event)
\begin{CompactList}\small\item\em The number of hit planes check. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
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. 

CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects). 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{
\index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
\index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
\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{]}}}}
\label{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}


Constructor. 

The CaloAxis arguments are pointers to objects which contain the calorimeter track information for current event.

\begin{Desc}
\item[Parameters:]
\begin{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}
\end{Desc}


\subsection{Member Function Documentation}
\hypertarget{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{
\index{CaloNHitCut@{CaloNHitCut}!Check@{Check}}
\index{Check@{Check}!CaloNHitCut@{CaloNHitCut}}
\subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloNHitCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
\label{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}


The number of hit planes check. 

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.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em event}]The event to analyze. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the track hits at least nMinHit planes both in X and Y. 

0 otherwise. \end{Desc}
\begin{Desc}
\item[See also:]\hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut::CaloNHitCut} \end{Desc}


Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8h}{CaloNHitCut.h}\item 
CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8cpp}{CaloNHitCut.cpp}\end{CompactItemize}
1	pam-fi	1.1	\hypertarget{classCaloNHitCut}{
2			\section{CaloNHitCut Class Reference}
3			\label{classCaloNHitCut}\index{CaloNHitCut@{CaloNHitCut}}
4			}
5	pam-fi	1.2	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	pam-fi	1.1
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	pam-fi	1.2	\hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, int nMinHit=10)
20	pam-fi	1.1	\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21	pam-fi	1.2	\hypertarget{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{
22			\hyperlink{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}{$\sim$CaloNHitCut} ()}
23			\label{classCaloNHitCut_97d9858496d6c3f8a47aa2c60d844065}
24
25	pam-fi	1.1	\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26			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}
28
29
30			\subsection{Detailed Description}
31	pam-fi	1.2	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	pam-fi	1.1
33	pam-fi	1.2	CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects).
34	pam-fi	1.1
35			\subsection{Constructor \& Destructor Documentation}
36			\hypertarget{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{
37			\index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
38			\index{CaloNHitCut@{CaloNHitCut}!CaloNHitCut@{CaloNHitCut}}
39	pam-fi	1.2	\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	pam-fi	1.1	\label{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}
41
42
43			Constructor.
44
45	pam-fi	1.2	The CaloAxis arguments are pointers to objects which contain the calorimeter track information for current event.
46	pam-fi	1.1
47			\begin{Desc}
48			\item[Parameters:]
49			\begin{description}
50	pam-fi	1.2	\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	pam-fi	1.1	\end{Desc}
52
53
54			\subsection{Member Function Documentation}
55			\hypertarget{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{
56			\index{CaloNHitCut@{CaloNHitCut}!Check@{Check}}
57			\index{Check@{Check}!CaloNHitCut@{CaloNHitCut}}
58			\subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloNHitCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
59			\label{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}
60
61
62			The number of hit planes check.
63
64	pam-fi	1.2	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	pam-fi	1.1
66			\begin{Desc}
67			\item[Parameters:]
68			\begin{description}
69			\item[{\em event}]The event to analyze. \end{description}
70			\end{Desc}
71			\begin{Desc}
72			\item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the track hits at least nMinHit planes both in X and Y.
73
74			0 otherwise. \end{Desc}
75			\begin{Desc}
76			\item[See also:]\hyperlink{classCaloNHitCut_220d9db8d015f09a97bb7a222f059cd2}{CaloNHitCut::CaloNHitCut} \end{Desc}
77
78
79			Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
80
81			The documentation for this class was generated from the following files:\begin{CompactItemize}
82			\item
83			CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8h}{CaloNHitCut.h}\item
84			CaloCuts/CaloNHitCut/\hyperlink{CaloNHitCut_8cpp}{CaloNHitCut.cpp}\end{CompactItemize}