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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations) (download) (as text)
Fri Jun 5 13:15:18 2009 UTC (15 years, 8 months ago) by pam-fi
Branch: MAIN
Changes since 1.1: +5 -44 lines
File MIME type: application/x-tex
Updated.

1 pam-fi 1.1 \hypertarget{classTrkSigmaDeflCut}{
2     \section{TrkSigmaDeflCut Class Reference}
3     \label{classTrkSigmaDeflCut}\index{TrkSigmaDeflCut@{TrkSigmaDeflCut}}
4     }
5     The cut on TRK sigma\_\-deflection.
6    
7    
8     {\tt \#include $<$TrkSigmaDeflCut.h$>$}
9    
10     Inheritance diagram for TrkSigmaDeflCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classTrkSigmaDeflCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classTrkSigmaDeflCut_8d0bd06c73adaf6667a94b949e48b784}{TrkSigmaDeflCut} (const char $\ast$cutName, std::vector$<$ float $>$ binning)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classTrkSigmaDeflCut_65009efe9c13284d2ac599f931bb1cd7}{TrkSigmaDeflCut} (const char $\ast$cutName, const char $\ast$rigBinListFileName)
22     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
23 pam-fi 1.2 \hypertarget{classTrkSigmaDeflCut_00bf0a4998f081e3cf567bb3d37f5993}{
24     \hyperlink{classTrkSigmaDeflCut_00bf0a4998f081e3cf567bb3d37f5993}{$\sim$TrkSigmaDeflCut} ()}
25     \label{classTrkSigmaDeflCut_00bf0a4998f081e3cf567bb3d37f5993}
26    
27 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
28     int \hyperlink{classTrkSigmaDeflCut_8af1e1457f8c5d33b70aa75816188e72}{Check} (PamLevel2 $\ast$event)
29     \begin{CompactList}\small\item\em The sigma\_\-deflection check. \item\end{CompactList}\end{CompactItemize}
30    
31    
32     \subsection{Detailed Description}
33     The cut on TRK sigma\_\-deflection.
34    
35     This cut discards an event if its sigma\_\-deflection (defined as sqrt(coval\mbox{[}4\mbox{]}\mbox{[}4\mbox{]}), in GV$^\wedge$-1) is not less than the minimum deflection for the bin which contains the event deflection modulus (deflection of the first TRK track).
36    
37     \subsection{Constructor \& Destructor Documentation}
38     \hypertarget{classTrkSigmaDeflCut_8d0bd06c73adaf6667a94b949e48b784}{
39     \index{TrkSigmaDeflCut@{TrkSigmaDeflCut}!TrkSigmaDeflCut@{TrkSigmaDeflCut}}
40     \index{TrkSigmaDeflCut@{TrkSigmaDeflCut}!TrkSigmaDeflCut@{TrkSigmaDeflCut}}
41     \subsubsection[{TrkSigmaDeflCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkSigmaDeflCut::TrkSigmaDeflCut (const char $\ast$ {\em cutName}, \/ std::vector$<$ float $>$ {\em binning})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
42     \label{classTrkSigmaDeflCut_8d0bd06c73adaf6667a94b949e48b784}
43    
44    
45     Constructor.
46    
47     \begin{Desc}
48     \item[Parameters:]
49     \begin{description}
50     \item[{\em cutName}]The cut's name. \item[{\em binning}]A vector containing the histogram binning in rigidity. Note that it must contain both the upper and lower limits, and that the elements must be ordered (ie., lowest rigidity value in the first element and so on). \end{description}
51     \end{Desc}
52 pam-fi 1.2 \hypertarget{classTrkSigmaDeflCut_65009efe9c13284d2ac599f931bb1cd7}{
53 pam-fi 1.1 \index{TrkSigmaDeflCut@{TrkSigmaDeflCut}!TrkSigmaDeflCut@{TrkSigmaDeflCut}}
54     \index{TrkSigmaDeflCut@{TrkSigmaDeflCut}!TrkSigmaDeflCut@{TrkSigmaDeflCut}}
55     \subsubsection[{TrkSigmaDeflCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkSigmaDeflCut::TrkSigmaDeflCut (const char $\ast$ {\em cutName}, \/ const char $\ast$ {\em rigBinListFileName})}}
56     \label{classTrkSigmaDeflCut_65009efe9c13284d2ac599f931bb1cd7}
57    
58    
59     Constructor.
60    
61     \begin{Desc}
62     \item[Parameters:]
63     \begin{description}
64     \item[{\em cutName}]The cut's name. \item[{\em rigBinListFileName}]A text file containing the histogram binning. Note that it must contain both the upper and lower limits, and that the elements must be ordered (ie., lowest rigidity value in the first element and so on). \end{description}
65     \end{Desc}
66    
67    
68     \subsection{Member Function Documentation}
69     \hypertarget{classTrkSigmaDeflCut_8af1e1457f8c5d33b70aa75816188e72}{
70     \index{TrkSigmaDeflCut@{TrkSigmaDeflCut}!Check@{Check}}
71     \index{Check@{Check}!TrkSigmaDeflCut@{TrkSigmaDeflCut}}
72     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int TrkSigmaDeflCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
73     \label{classTrkSigmaDeflCut_8af1e1457f8c5d33b70aa75816188e72}
74    
75    
76     The sigma\_\-deflection check.
77    
78     The event is discarded if its deflection is less than the lower histogram limit or higher than the upper limit. The event is also discarded if its sigma\_\-deflection is not less than the minimum deflection for the bin which contains the event deflection modulus.
79    
80     \begin{Desc}
81     \item[Parameters:]
82     \begin{description}
83     \item[{\em event}]The event to analyze. \end{description}
84     \end{Desc}
85     \begin{Desc}
86     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the sigma\_\-deflection condition is satisfied.
87    
88     0 otherwise. \end{Desc}
89    
90    
91     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
92    
93     The documentation for this class was generated from the following files:\begin{CompactItemize}
94     \item
95     TrkCuts/TrkSigmaDeflCut/\hyperlink{TrkSigmaDeflCut_8h}{TrkSigmaDeflCut.h}\item
96     TrkCuts/TrkSigmaDeflCut/\hyperlink{TrkSigmaDeflCut_8cpp}{TrkSigmaDeflCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23