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

Annotation of /PamCut/doc/Doxygen/latex/classGeoFieldCut.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, 9 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{classGeoFieldCut}{
2     \section{GeoFieldCut Class Reference}
3     \label{classGeoFieldCut}\index{GeoFieldCut@{GeoFieldCut}}
4     }
5     The geomagnetic cut.
6    
7    
8     {\tt \#include $<$GeoFieldCut.h$>$}
9    
10     Inheritance diagram for GeoFieldCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classGeoFieldCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classGeoFieldCut_9a4d437393b21f108338da9ae75f82bd}{GeoFieldCut} (const char $\ast$cutName, Float\_\-t bAbs)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classGeoFieldCut_cc00d889002cf63ab42d1fefb41a62a1}{$\sim$GeoFieldCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classGeoFieldCut_edb5a8ed5c91d3f2436fe45e979cc778}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em Apply the geomagnetic cut. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     float \hyperlink{classGeoFieldCut_6cb6be21d9c53c561a20b31aa406ba6f}{\_\-bAbs}
29     \end{CompactItemize}
30    
31    
32     \subsection{Detailed Description}
33     The geomagnetic cut.
34    
35     Definition at line 16 of file GeoFieldCut.h.
36    
37     \subsection{Constructor \& Destructor Documentation}
38     \hypertarget{classGeoFieldCut_9a4d437393b21f108338da9ae75f82bd}{
39     \index{GeoFieldCut@{GeoFieldCut}!GeoFieldCut@{GeoFieldCut}}
40     \index{GeoFieldCut@{GeoFieldCut}!GeoFieldCut@{GeoFieldCut}}
41     \subsubsection[{GeoFieldCut}]{\setlength{\rightskip}{0pt plus 5cm}GeoFieldCut::GeoFieldCut (const char $\ast$ {\em cutName}, \/ Float\_\-t {\em bAbs})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
42     \label{classGeoFieldCut_9a4d437393b21f108338da9ae75f82bd}
43    
44    
45     Constructor.
46    
47     \begin{Desc}
48     \item[Parameters:]
49     \begin{description}
50     \item[{\em cutName}]The cut's name.. \item[{\em bAbs}]The lower threshold value of the geomagnetic field, in gauss. \end{description}
51     \end{Desc}
52    
53    
54     Definition at line 24 of file GeoFieldCut.h.\hypertarget{classGeoFieldCut_cc00d889002cf63ab42d1fefb41a62a1}{
55     \index{GeoFieldCut@{GeoFieldCut}!$\sim$GeoFieldCut@{$\sim$GeoFieldCut}}
56     \index{$\sim$GeoFieldCut@{$\sim$GeoFieldCut}!GeoFieldCut@{GeoFieldCut}}
57     \subsubsection[{$\sim$GeoFieldCut}]{\setlength{\rightskip}{0pt plus 5cm}GeoFieldCut::$\sim$GeoFieldCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
58     \label{classGeoFieldCut_cc00d889002cf63ab42d1fefb41a62a1}
59    
60    
61     Destructor.
62    
63    
64    
65     Definition at line 29 of file GeoFieldCut.h.
66    
67     \subsection{Member Function Documentation}
68     \hypertarget{classGeoFieldCut_edb5a8ed5c91d3f2436fe45e979cc778}{
69     \index{GeoFieldCut@{GeoFieldCut}!Check@{Check}}
70     \index{Check@{Check}!GeoFieldCut@{GeoFieldCut}}
71     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int GeoFieldCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
72     \label{classGeoFieldCut_edb5a8ed5c91d3f2436fe45e979cc778}
73    
74    
75     Apply the geomagnetic cut.
76    
77     This routine rejects the events with $|$B$|$ $<$ bAbs. \begin{Desc}
78     \item[Parameters:]
79     \begin{description}
80     \item[{\em event}]The event to analyze. \end{description}
81     \end{Desc}
82     \begin{Desc}
83     \item[Returns:]CUTOK if $|$B$|$ $>$ bAbs, 0 otherwise. \end{Desc}
84    
85    
86     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
87    
88     Definition at line 12 of file GeoFieldCut.cpp.
89    
90     References \_\-bAbs, and CUTOK.
91    
92     \subsection{Member Data Documentation}
93     \hypertarget{classGeoFieldCut_6cb6be21d9c53c561a20b31aa406ba6f}{
94     \index{GeoFieldCut@{GeoFieldCut}!\_\-bAbs@{\_\-bAbs}}
95     \index{\_\-bAbs@{\_\-bAbs}!GeoFieldCut@{GeoFieldCut}}
96     \subsubsection[{\_\-bAbs}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf GeoFieldCut::\_\-bAbs}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
97     \label{classGeoFieldCut_6cb6be21d9c53c561a20b31aa406ba6f}
98    
99    
100    
101    
102     Definition at line 41 of file GeoFieldCut.h.
103    
104     Referenced by Check().
105    
106     The documentation for this class was generated from the following files:\begin{CompactItemize}
107     \item
108     MiscCuts/GeoFieldCut/\hyperlink{GeoFieldCut_8h}{GeoFieldCut.h}\item
109     MiscCuts/GeoFieldCut/\hyperlink{GeoFieldCut_8cpp}{GeoFieldCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23