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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:01 2009 UTC (15 years, 9 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: application/x-tex
Initial revision

1 pam-fi 1.1 \hypertarget{classTrkGeomCut}{
2     \section{TrkGeomCut Class Reference}
3     \label{classTrkGeomCut}\index{TrkGeomCut@{TrkGeomCut}}
4     }
5     The tracker fiducial acceptance cut. This cut checks if the track is inside the fiducial acceptance chosen for the tracker. CUT DEPENDENCIES: TrkPhysSin for object trkTrack.
6    
7    
8     {\tt \#include $<$TrkGeomCut.h$>$}
9    
10     Inheritance diagram for TrkGeomCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classTrkGeomCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classTrkGeomCut_fd4f9fc60d3f2b8d71f277b4b2b231fd}{TrkGeomCut} (const char $\ast$cutName, float xTol, float yTol)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classTrkGeomCut_6ec9a866e99b67a1f882d9113c995ccc}{$\sim$TrkGeomCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The tracker fiducial acceptance check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     float \hyperlink{classTrkGeomCut_81c6ed45a6a3bac7b2ccad434bd92af7}{\_\-xTol}
29     \item
30     float \hyperlink{classTrkGeomCut_1f5b9ce6bf84d9d5d905dd65661bb2e7}{\_\-yTol}
31     \end{CompactItemize}
32    
33    
34     \subsection{Detailed Description}
35     The tracker fiducial acceptance cut. This cut checks if the track is inside the fiducial acceptance chosen for the tracker. CUT DEPENDENCIES: TrkPhysSin for object trkTrack.
36    
37     Definition at line 20 of file TrkGeomCut.h.
38    
39     \subsection{Constructor \& Destructor Documentation}
40     \hypertarget{classTrkGeomCut_fd4f9fc60d3f2b8d71f277b4b2b231fd}{
41     \index{TrkGeomCut@{TrkGeomCut}!TrkGeomCut@{TrkGeomCut}}
42     \index{TrkGeomCut@{TrkGeomCut}!TrkGeomCut@{TrkGeomCut}}
43     \subsubsection[{TrkGeomCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkGeomCut::TrkGeomCut (const char $\ast$ {\em cutName}, \/ float {\em xTol}, \/ float {\em yTol})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
44     \label{classTrkGeomCut_fd4f9fc60d3f2b8d71f277b4b2b231fd}
45    
46    
47     Constructor.
48    
49     The parameters are the width of the regions on each side of a view that define the fiducial acceptance region. The detector size is therefore reduce by an amount of xTol (yTol) on each side of the X (Y) view.
50    
51     \begin{Desc}
52     \item[Parameters:]
53     \begin{description}
54     \item[{\em cutName}]The cut's name. \item[{\em xTol}]The fiducial border on X view in cm. \item[{\em yTol}]The fiducial border on Y view in cm. \end{description}
55     \end{Desc}
56    
57    
58     Definition at line 33 of file TrkGeomCut.h.\hypertarget{classTrkGeomCut_6ec9a866e99b67a1f882d9113c995ccc}{
59     \index{TrkGeomCut@{TrkGeomCut}!$\sim$TrkGeomCut@{$\sim$TrkGeomCut}}
60     \index{$\sim$TrkGeomCut@{$\sim$TrkGeomCut}!TrkGeomCut@{TrkGeomCut}}
61     \subsubsection[{$\sim$TrkGeomCut}]{\setlength{\rightskip}{0pt plus 5cm}TrkGeomCut::$\sim$TrkGeomCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
62     \label{classTrkGeomCut_6ec9a866e99b67a1f882d9113c995ccc}
63    
64    
65     Destructor.
66    
67    
68    
69     Definition at line 37 of file TrkGeomCut.h.
70    
71     \subsection{Member Function Documentation}
72     \hypertarget{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}{
73     \index{TrkGeomCut@{TrkGeomCut}!Check@{Check}}
74     \index{Check@{Check}!TrkGeomCut@{TrkGeomCut}}
75     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int TrkGeomCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
76     \label{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}
77    
78    
79     The tracker fiducial acceptance check.
80    
81     \begin{Desc}
82     \item[Parameters:]
83     \begin{description}
84     \item[{\em event}]The event to analyze. \end{description}
85     \end{Desc}
86     \begin{Desc}
87     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the track is inside the fiducial acceptance.
88    
89     0 otherwise. \end{Desc}
90    
91    
92     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
93    
94     Definition at line 12 of file TrkGeomCut.cpp.
95    
96     References \_\-xTol, \_\-yTol, and CUTOK.
97    
98     \subsection{Member Data Documentation}
99     \hypertarget{classTrkGeomCut_81c6ed45a6a3bac7b2ccad434bd92af7}{
100     \index{TrkGeomCut@{TrkGeomCut}!\_\-xTol@{\_\-xTol}}
101     \index{\_\-xTol@{\_\-xTol}!TrkGeomCut@{TrkGeomCut}}
102     \subsubsection[{\_\-xTol}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf TrkGeomCut::\_\-xTol}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
103     \label{classTrkGeomCut_81c6ed45a6a3bac7b2ccad434bd92af7}
104    
105    
106    
107    
108     Definition at line 50 of file TrkGeomCut.h.
109    
110     Referenced by Check().\hypertarget{classTrkGeomCut_1f5b9ce6bf84d9d5d905dd65661bb2e7}{
111     \index{TrkGeomCut@{TrkGeomCut}!\_\-yTol@{\_\-yTol}}
112     \index{\_\-yTol@{\_\-yTol}!TrkGeomCut@{TrkGeomCut}}
113     \subsubsection[{\_\-yTol}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf TrkGeomCut::\_\-yTol}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
114     \label{classTrkGeomCut_1f5b9ce6bf84d9d5d905dd65661bb2e7}
115    
116    
117    
118    
119     Definition at line 51 of file TrkGeomCut.h.
120    
121     Referenced by Check().
122    
123     The documentation for this class was generated from the following files:\begin{CompactItemize}
124     \item
125     TrkCuts/TrkGeomCut/\hyperlink{TrkGeomCut_8h}{TrkGeomCut.h}\item
126     TrkCuts/TrkGeomCut/\hyperlink{TrkGeomCut_8cpp}{TrkGeomCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23