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

Annotation of /PamCut/doc/Doxygen/latex/classCaloTrackChi2Cut.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, 10 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{classCaloTrackChi2Cut}{
2     \section{CaloTrackChi2Cut Class Reference}
3     \label{classCaloTrackChi2Cut}\index{CaloTrackChi2Cut@{CaloTrackChi2Cut}}
4     }
5     The calorimeter track chi2 quality cut.
6    
7    
8     {\tt \#include $<$CaloTrackChi2Cut.h$>$}
9    
10     Inheritance diagram for CaloTrackChi2Cut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classCaloTrackChi2Cut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}{CaloTrackChi2Cut} (const char $\ast$cutName, \hyperlink{classCaloAxis}{CaloAxis} $\ast$xCaloAxis, \hyperlink{classCaloAxis}{CaloAxis} $\ast$yCaloAxis, float maxChi2=0.03, float minChi2=0.005)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}{$\sim$CaloTrackChi2Cut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The calorimeter chi2 quality check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloTrackChi2Cut_3eae059e91c7b0a5933236ab4dbcc28d}{\_\-xCaloAxis}
29     \item
30     \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloTrackChi2Cut_2ea0c86a73873dc5ffec16299a31f9bd}{\_\-yCaloAxis}
31     \item
32     float \hyperlink{classCaloTrackChi2Cut_665b250f9e2d8b8568a7c639ec08d20b}{\_\-maxChi2}
33     \item
34     float \hyperlink{classCaloTrackChi2Cut_19e6c7d61a98be79c6e4328ef1a36447}{\_\-minChi2}
35     \end{CompactItemize}
36    
37    
38     \subsection{Detailed Description}
39     The calorimeter track chi2 quality cut.
40    
41     This cut performs a check on chi2 of the calorimeter track. 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.
42    
43     CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the \hyperlink{classCaloAxis}{CaloAxis} objects).
44    
45     Definition at line 30 of file CaloTrackChi2Cut.h.
46    
47     \subsection{Constructor \& Destructor Documentation}
48     \hypertarget{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}{
49     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
50     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
51     \subsubsection[{CaloTrackChi2Cut}]{\setlength{\rightskip}{0pt plus 5cm}CaloTrackChi2Cut::CaloTrackChi2Cut (const char $\ast$ {\em cutName}, \/ {\bf CaloAxis} $\ast$ {\em xCaloAxis}, \/ {\bf CaloAxis} $\ast$ {\em yCaloAxis}, \/ float {\em maxChi2} = {\tt 0.03}, \/ float {\em minChi2} = {\tt 0.005})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
52     \label{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}
53    
54    
55     Constructor.
56    
57     The \hyperlink{classCaloAxis}{CaloAxis} arguments are pointers to objects which contain the calorimeter track information for current event.
58    
59     \begin{Desc}
60     \item[Parameters:]
61     \begin{description}
62     \item[{\em cutName}]The cut name. \item[{\em xCaloAxis}]Pointer to the \hyperlink{classCaloAxis}{CaloAxis} object for X axis. \item[{\em yCaloAxis}]Pointer to the \hyperlink{classCaloAxis}{CaloAxis} object for Y axis. \item[{\em maxChi2}]The maximum allowed Chi2. \item[{\em minChi2}]The minimum allowed Chi2. \end{description}
63     \end{Desc}
64    
65    
66     Definition at line 44 of file CaloTrackChi2Cut.h.\hypertarget{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}{
67     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!$\sim$CaloTrackChi2Cut@{$\sim$CaloTrackChi2Cut}}
68     \index{$\sim$CaloTrackChi2Cut@{$\sim$CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
69     \subsubsection[{$\sim$CaloTrackChi2Cut}]{\setlength{\rightskip}{0pt plus 5cm}CaloTrackChi2Cut::$\sim$CaloTrackChi2Cut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
70     \label{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}
71    
72    
73     Destructor.
74    
75    
76    
77     Definition at line 48 of file CaloTrackChi2Cut.h.
78    
79     \subsection{Member Function Documentation}
80     \hypertarget{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{
81     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!Check@{Check}}
82     \index{Check@{Check}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
83     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int CaloTrackChi2Cut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
84     \label{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}
85    
86    
87     The calorimeter chi2 quality check.
88    
89     \begin{Desc}
90     \item[Parameters:]
91     \begin{description}
92     \item[{\em event}]The event to analyze. \end{description}
93     \end{Desc}
94     \begin{Desc}
95     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if Chi2 from \hyperlink{classCaloAxis}{CaloAxis} is strictly greater than minChi2 and strictly lesser than maxChi2.
96    
97     0 otherwise \end{Desc}
98    
99    
100     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
101    
102     Definition at line 12 of file CaloTrackChi2Cut.cpp.
103    
104     References \_\-maxChi2, \_\-minChi2, \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetChi2().
105    
106     \subsection{Member Data Documentation}
107     \hypertarget{classCaloTrackChi2Cut_665b250f9e2d8b8568a7c639ec08d20b}{
108     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-maxChi2@{\_\-maxChi2}}
109     \index{\_\-maxChi2@{\_\-maxChi2}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
110     \subsubsection[{\_\-maxChi2}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloTrackChi2Cut::\_\-maxChi2}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
111     \label{classCaloTrackChi2Cut_665b250f9e2d8b8568a7c639ec08d20b}
112    
113    
114    
115    
116     Definition at line 61 of file CaloTrackChi2Cut.h.
117    
118     Referenced by Check().\hypertarget{classCaloTrackChi2Cut_19e6c7d61a98be79c6e4328ef1a36447}{
119     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-minChi2@{\_\-minChi2}}
120     \index{\_\-minChi2@{\_\-minChi2}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
121     \subsubsection[{\_\-minChi2}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloTrackChi2Cut::\_\-minChi2}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
122     \label{classCaloTrackChi2Cut_19e6c7d61a98be79c6e4328ef1a36447}
123    
124    
125    
126    
127     Definition at line 61 of file CaloTrackChi2Cut.h.
128    
129     Referenced by Check().\hypertarget{classCaloTrackChi2Cut_3eae059e91c7b0a5933236ab4dbcc28d}{
130     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-xCaloAxis@{\_\-xCaloAxis}}
131     \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
132     \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloTrackChi2Cut::\_\-xCaloAxis}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
133     \label{classCaloTrackChi2Cut_3eae059e91c7b0a5933236ab4dbcc28d}
134    
135    
136    
137    
138     Definition at line 60 of file CaloTrackChi2Cut.h.
139    
140     Referenced by Check().\hypertarget{classCaloTrackChi2Cut_2ea0c86a73873dc5ffec16299a31f9bd}{
141     \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-yCaloAxis@{\_\-yCaloAxis}}
142     \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
143     \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloTrackChi2Cut::\_\-yCaloAxis}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
144     \label{classCaloTrackChi2Cut_2ea0c86a73873dc5ffec16299a31f9bd}
145    
146    
147    
148    
149     Definition at line 60 of file CaloTrackChi2Cut.h.
150    
151     Referenced by Check().
152    
153     The documentation for this class was generated from the following files:\begin{CompactItemize}
154     \item
155     CaloCuts/CaloTrackChi2Cut/\hyperlink{CaloTrackChi2Cut_8h}{CaloTrackChi2Cut.h}\item
156     CaloCuts/CaloTrackChi2Cut/\hyperlink{CaloTrackChi2Cut_8cpp}{CaloTrackChi2Cut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23