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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (hide annotations) (download) (as text)
Fri Sep 25 15:44:27 2009 UTC (15 years, 5 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: application/x-tex
FILE REMOVED
Removed from repository.

1 pam-fi 1.1 \hypertarget{classCaloIonCut}{
2     \section{CaloIonCut Class Reference}
3     \label{classCaloIonCut}\index{CaloIonCut@{CaloIonCut}}
4     }
5     The calorimeter ionization cut.
6    
7    
8     {\tt \#include $<$CaloIonCut.h$>$}
9    
10     Inheritance diagram for CaloIonCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classCaloIonCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19 pam-fi 1.2 \hyperlink{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}{CaloIonCut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, float minRelease=0., float maxRelease=3.)
20 pam-fi 1.1 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 pam-fi 1.2 \hypertarget{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}{
22     \hyperlink{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}{$\sim$CaloIonCut} ()}
23     \label{classCaloIonCut_dbb2f15f8cf67625be67aa7143b52a7e}
24    
25 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26     int \hyperlink{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{Check} (PamLevel2 $\ast$event)
27     \begin{CompactList}\small\item\em The calorimeter ionization check. \item\end{CompactList}\end{CompactItemize}
28    
29    
30     \subsection{Detailed Description}
31     The calorimeter ionization cut.
32    
33 pam-fi 1.2 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.
34 pam-fi 1.1
35 pam-fi 1.2 CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects).
36 pam-fi 1.1
37     \subsection{Constructor \& Destructor Documentation}
38     \hypertarget{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}{
39     \index{CaloIonCut@{CaloIonCut}!CaloIonCut@{CaloIonCut}}
40     \index{CaloIonCut@{CaloIonCut}!CaloIonCut@{CaloIonCut}}
41 pam-fi 1.2 \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 pam-fi 1.1 \label{classCaloIonCut_d6b2ee30eed42510b052ce7276adbb2e}
43    
44    
45     Constructor.
46    
47 pam-fi 1.2 The CaloAxis arguments are objects which contain the calorimeter track information for current event.
48 pam-fi 1.1
49     \begin{Desc}
50     \item[Parameters:]
51     \begin{description}
52 pam-fi 1.2 \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 pam-fi 1.1 \end{Desc}
54    
55    
56     \subsection{Member Function Documentation}
57     \hypertarget{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{
58     \index{CaloIonCut@{CaloIonCut}!Check@{Check}}
59     \index{Check@{Check}!CaloIonCut@{CaloIonCut}}
60     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloIonCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
61     \label{classCaloIonCut_20a353b53560701ba1ba72db42f48083}
62    
63    
64     The calorimeter ionization check.
65    
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 pam-fi 1.2 \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 pam-fi 1.1
74     0 otherwise \end{Desc}
75    
76    
77     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
78    
79     The documentation for this class was generated from the following files:\begin{CompactItemize}
80     \item
81 pam-fi 1.2 CaloCuts/CaloIonCut/CaloIonCut.h\item
82 pam-fi 1.1 CaloCuts/CaloIonCut/\hyperlink{CaloIonCut_8cpp}{CaloIonCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23