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

Diff of /PamCut/doc/Doxygen/latex/classCaloTrackChi2Cut.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:14:57 2009 UTC
# Line 16  Inheritance diagram for CaloTrackChi2Cut Line 16  Inheritance diagram for CaloTrackChi2Cut
16  \subsection*{Public Member Functions}  \subsection*{Public Member Functions}
17  \begin{CompactItemize}  \begin{CompactItemize}
18  \item  \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)  \hyperlink{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}{CaloTrackChi2Cut} (const char $\ast$cutName, CaloAxis $\ast$xCaloAxis, CaloAxis $\ast$yCaloAxis, float maxChi2=0.03, float minChi2=0.005)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}{$\sim$CaloTrackChi2Cut} ()  \hypertarget{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}{
22    \hyperlink{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}{$\sim$CaloTrackChi2Cut} ()}
23    \label{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}
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{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{Check} (PamLevel2 $\ast$event)  int \hyperlink{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{Check} (PamLevel2 $\ast$event)
27  \begin{CompactList}\small\item\em The calorimeter chi2 quality check. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em The calorimeter chi2 quality check. \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloTrackChi2Cut_3eae059e91c7b0a5933236ab4dbcc28d}{\_\-xCaloAxis}  
 \item  
 \hyperlink{classCaloAxis}{CaloAxis} $\ast$ \hyperlink{classCaloTrackChi2Cut_2ea0c86a73873dc5ffec16299a31f9bd}{\_\-yCaloAxis}  
 \item  
 float \hyperlink{classCaloTrackChi2Cut_665b250f9e2d8b8568a7c639ec08d20b}{\_\-maxChi2}  
 \item  
 float \hyperlink{classCaloTrackChi2Cut_19e6c7d61a98be79c6e4328ef1a36447}{\_\-minChi2}  
 \end{CompactItemize}  
28    
29    
30  \subsection{Detailed Description}  \subsection{Detailed Description}
31  The calorimeter track chi2 quality cut.  The calorimeter track chi2 quality cut.
32    
33  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.  This cut performs a check on chi2 of the calorimeter track. 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.
   
 CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the \hyperlink{classCaloAxis}{CaloAxis} objects).  
34    
35  Definition at line 30 of file CaloTrackChi2Cut.h.  CUT DEPENDENCIES: \hyperlink{classCaloTrackCut}{CaloTrackCut} for the existence of the track (it can also provide the CaloAxis objects).
36    
37  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
38  \hypertarget{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}{  \hypertarget{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}{
39  \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
40  \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}
41  \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{]}}}}  \subsubsection[{CaloTrackChi2Cut}]{\setlength{\rightskip}{0pt plus 5cm}CaloTrackChi2Cut::CaloTrackChi2Cut (const char $\ast$ {\em cutName}, \/  CaloAxis $\ast$ {\em xCaloAxis}, \/  CaloAxis $\ast$ {\em yCaloAxis}, \/  float {\em maxChi2} = {\tt 0.03}, \/  float {\em minChi2} = {\tt 0.005})\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}
42  \label{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}  \label{classCaloTrackChi2Cut_1712b4e3701101c9937236e7499d384f}
43    
44    
45  Constructor.  Constructor.
46    
47  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.
48    
49  \begin{Desc}  \begin{Desc}
50  \item[Parameters:]  \item[Parameters:]
51  \begin{description}  \begin{description}
52  \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}  \item[{\em cutName}]The cut name. \item[{\em xCaloAxis}]Pointer to the CaloAxis object for X axis. \item[{\em yCaloAxis}]Pointer to the CaloAxis object for Y axis. \item[{\em maxChi2}]The maximum allowed Chi2. \item[{\em minChi2}]The minimum allowed Chi2. \end{description}
53  \end{Desc}  \end{Desc}
54    
55    
 Definition at line 44 of file CaloTrackChi2Cut.h.\hypertarget{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}{  
 \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!$\sim$CaloTrackChi2Cut@{$\sim$CaloTrackChi2Cut}}  
 \index{$\sim$CaloTrackChi2Cut@{$\sim$CaloTrackChi2Cut}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  
 \subsubsection[{$\sim$CaloTrackChi2Cut}]{\setlength{\rightskip}{0pt plus 5cm}CaloTrackChi2Cut::$\sim$CaloTrackChi2Cut ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classCaloTrackChi2Cut_ffe40e5c6ec00d23fedd58a04470e5bc}  
   
   
 Destructor.  
   
   
   
 Definition at line 48 of file CaloTrackChi2Cut.h.  
   
56  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
57  \hypertarget{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{  \hypertarget{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{
58  \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!Check@{Check}}  \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!Check@{Check}}
# Line 92  The calorimeter chi2 quality check. Line 69  The calorimeter chi2 quality check.
69  \item[{\em event}]The event to analyze. \end{description}  \item[{\em event}]The event to analyze. \end{description}
70  \end{Desc}  \end{Desc}
71  \begin{Desc}  \begin{Desc}
72  \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if Chi2 from \hyperlink{classCaloAxis}{CaloAxis} is strictly greater than minChi2 and strictly lesser than maxChi2.  \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if Chi2 from CaloAxis is strictly greater than minChi2 and strictly lesser than maxChi2.
73    
74  0 otherwise \end{Desc}  0 otherwise \end{Desc}
75    
76    
77  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
78    
 Definition at line 12 of file CaloTrackChi2Cut.cpp.  
   
 References \_\-maxChi2, \_\-minChi2, \_\-xCaloAxis, \_\-yCaloAxis, CUTOK, and CaloAxis::GetChi2().  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classCaloTrackChi2Cut_665b250f9e2d8b8568a7c639ec08d20b}{  
 \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-maxChi2@{\_\-maxChi2}}  
 \index{\_\-maxChi2@{\_\-maxChi2}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  
 \subsubsection[{\_\-maxChi2}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloTrackChi2Cut::\_\-maxChi2}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloTrackChi2Cut_665b250f9e2d8b8568a7c639ec08d20b}  
   
   
   
   
 Definition at line 61 of file CaloTrackChi2Cut.h.  
   
 Referenced by Check().\hypertarget{classCaloTrackChi2Cut_19e6c7d61a98be79c6e4328ef1a36447}{  
 \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-minChi2@{\_\-minChi2}}  
 \index{\_\-minChi2@{\_\-minChi2}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  
 \subsubsection[{\_\-minChi2}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf CaloTrackChi2Cut::\_\-minChi2}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloTrackChi2Cut_19e6c7d61a98be79c6e4328ef1a36447}  
   
   
   
   
 Definition at line 61 of file CaloTrackChi2Cut.h.  
   
 Referenced by Check().\hypertarget{classCaloTrackChi2Cut_3eae059e91c7b0a5933236ab4dbcc28d}{  
 \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-xCaloAxis@{\_\-xCaloAxis}}  
 \index{\_\-xCaloAxis@{\_\-xCaloAxis}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  
 \subsubsection[{\_\-xCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis}$\ast$ {\bf CaloTrackChi2Cut::\_\-xCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloTrackChi2Cut_3eae059e91c7b0a5933236ab4dbcc28d}  
   
   
   
   
 Definition at line 60 of file CaloTrackChi2Cut.h.  
   
 Referenced by Check().\hypertarget{classCaloTrackChi2Cut_2ea0c86a73873dc5ffec16299a31f9bd}{  
 \index{CaloTrackChi2Cut@{CaloTrackChi2Cut}!\_\-yCaloAxis@{\_\-yCaloAxis}}  
 \index{\_\-yCaloAxis@{\_\-yCaloAxis}!CaloTrackChi2Cut@{CaloTrackChi2Cut}}  
 \subsubsection[{\_\-yCaloAxis}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CaloAxis} $\ast$ {\bf CaloTrackChi2Cut::\_\-yCaloAxis}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCaloTrackChi2Cut_2ea0c86a73873dc5ffec16299a31f9bd}  
   
   
   
   
 Definition at line 60 of file CaloTrackChi2Cut.h.  
   
 Referenced by Check().  
   
79  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}
80  \item  \item
81  CaloCuts/CaloTrackChi2Cut/\hyperlink{CaloTrackChi2Cut_8h}{CaloTrackChi2Cut.h}\item  CaloCuts/CaloTrackChi2Cut/\hyperlink{CaloTrackChi2Cut_8h}{CaloTrackChi2Cut.h}\item
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.23