/[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.2 - (hide annotations) (download) (as text)
Fri Jun 5 13:15:24 2009 UTC (15 years, 9 months ago) by pam-fi
Branch: MAIN
Changes since 1.1: +4 -52 lines
File MIME type: application/x-tex
Updated.

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 pam-fi 1.2 \hypertarget{classTrkGeomCut_6ec9a866e99b67a1f882d9113c995ccc}{
22     \hyperlink{classTrkGeomCut_6ec9a866e99b67a1f882d9113c995ccc}{$\sim$TrkGeomCut} ()}
23     \label{classTrkGeomCut_6ec9a866e99b67a1f882d9113c995ccc}
24    
25 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26     int \hyperlink{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}{Check} (PamLevel2 $\ast$event)
27     \begin{CompactList}\small\item\em The tracker fiducial acceptance check. \item\end{CompactList}\end{CompactItemize}
28    
29    
30     \subsection{Detailed Description}
31     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.
32    
33     \subsection{Constructor \& Destructor Documentation}
34     \hypertarget{classTrkGeomCut_fd4f9fc60d3f2b8d71f277b4b2b231fd}{
35     \index{TrkGeomCut@{TrkGeomCut}!TrkGeomCut@{TrkGeomCut}}
36     \index{TrkGeomCut@{TrkGeomCut}!TrkGeomCut@{TrkGeomCut}}
37     \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{]}}}}
38     \label{classTrkGeomCut_fd4f9fc60d3f2b8d71f277b4b2b231fd}
39    
40    
41     Constructor.
42    
43     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.
44    
45     \begin{Desc}
46     \item[Parameters:]
47     \begin{description}
48     \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}
49     \end{Desc}
50    
51    
52     \subsection{Member Function Documentation}
53     \hypertarget{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}{
54     \index{TrkGeomCut@{TrkGeomCut}!Check@{Check}}
55     \index{Check@{Check}!TrkGeomCut@{TrkGeomCut}}
56     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int TrkGeomCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
57     \label{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}
58    
59    
60     The tracker fiducial acceptance check.
61    
62     \begin{Desc}
63     \item[Parameters:]
64     \begin{description}
65     \item[{\em event}]The event to analyze. \end{description}
66     \end{Desc}
67     \begin{Desc}
68     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the track is inside the fiducial acceptance.
69    
70     0 otherwise. \end{Desc}
71    
72    
73     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
74    
75     The documentation for this class was generated from the following files:\begin{CompactItemize}
76     \item
77     TrkCuts/TrkGeomCut/\hyperlink{TrkGeomCut_8h}{TrkGeomCut.h}\item
78     TrkCuts/TrkGeomCut/\hyperlink{TrkGeomCut_8cpp}{TrkGeomCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23