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

Annotation of /PamCut/doc/Doxygen/latex/classEvRateS11Cut.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, 6 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{classEvRateS11Cut}{
2     \section{EvRateS11Cut Class Reference}
3     \label{classEvRateS11Cut}\index{EvRateS11Cut@{EvRateS11Cut}}
4     }
5     Cut on event rate on S11.
6    
7    
8     {\tt \#include $<$EvRateS11Cut.h$>$}
9    
10     Inheritance diagram for EvRateS11Cut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classEvRateS11Cut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classEvRateS11Cut_abfeba82d3f8f0bbf29b253c17324aba}{EvRateS11Cut} (const char $\ast$cutName, float maxRate=1e06, float minRate=0.)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classEvRateS11Cut_19077ac390563b97bb7325e6f9ea783a}{$\sim$EvRateS11Cut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classEvRateS11Cut_196fc98a75f1acc3ddef7dc86b5150a1}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The event rate check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     float \hyperlink{classEvRateS11Cut_2d4e7bebcf80321a3185154e97546a4b}{\_\-maxRate}
29     \item
30     float \hyperlink{classEvRateS11Cut_4cbb71886d25c15196357c4de5e3a5d4}{\_\-minRate}
31     \end{CompactItemize}
32    
33    
34     \subsection{Detailed Description}
35     Cut on event rate on S11.
36    
37     This cut discards those events recorded when the event rate on S11 was outside a certain range.
38    
39     Definition at line 20 of file EvRateS11Cut.h.
40    
41     \subsection{Constructor \& Destructor Documentation}
42     \hypertarget{classEvRateS11Cut_abfeba82d3f8f0bbf29b253c17324aba}{
43     \index{EvRateS11Cut@{EvRateS11Cut}!EvRateS11Cut@{EvRateS11Cut}}
44     \index{EvRateS11Cut@{EvRateS11Cut}!EvRateS11Cut@{EvRateS11Cut}}
45     \subsubsection[{EvRateS11Cut}]{\setlength{\rightskip}{0pt plus 5cm}EvRateS11Cut::EvRateS11Cut (const char $\ast$ {\em cutName}, \/ float {\em maxRate} = {\tt 1e06}, \/ float {\em minRate} = {\tt 0.})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
46     \label{classEvRateS11Cut_abfeba82d3f8f0bbf29b253c17324aba}
47    
48    
49     Constructor.
50    
51     Default values for the rates are chosen to reject none of the events.
52    
53     \begin{Desc}
54     \item[Parameters:]
55     \begin{description}
56     \item[{\em cutName}]The cut's name. \item[{\em maxRate}]The maximum rate. \item[{\em minRate}]The minimum rate. \end{description}
57     \end{Desc}
58    
59    
60     Definition at line 31 of file EvRateS11Cut.h.\hypertarget{classEvRateS11Cut_19077ac390563b97bb7325e6f9ea783a}{
61     \index{EvRateS11Cut@{EvRateS11Cut}!$\sim$EvRateS11Cut@{$\sim$EvRateS11Cut}}
62     \index{$\sim$EvRateS11Cut@{$\sim$EvRateS11Cut}!EvRateS11Cut@{EvRateS11Cut}}
63     \subsubsection[{$\sim$EvRateS11Cut}]{\setlength{\rightskip}{0pt plus 5cm}EvRateS11Cut::$\sim$EvRateS11Cut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
64     \label{classEvRateS11Cut_19077ac390563b97bb7325e6f9ea783a}
65    
66    
67     Destructor.
68    
69    
70    
71     Definition at line 35 of file EvRateS11Cut.h.
72    
73     \subsection{Member Function Documentation}
74     \hypertarget{classEvRateS11Cut_196fc98a75f1acc3ddef7dc86b5150a1}{
75     \index{EvRateS11Cut@{EvRateS11Cut}!Check@{Check}}
76     \index{Check@{Check}!EvRateS11Cut@{EvRateS11Cut}}
77     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int EvRateS11Cut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
78     \label{classEvRateS11Cut_196fc98a75f1acc3ddef7dc86b5150a1}
79    
80    
81     The event rate check.
82    
83     \begin{Desc}
84     \item[Parameters:]
85     \begin{description}
86     \item[{\em event}]The event to analyze. \end{description}
87     \end{Desc}
88     \begin{Desc}
89     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if event rate on S11 is between minRate and maxRate.
90    
91     0 otherwise \end{Desc}
92    
93    
94     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
95    
96     Definition at line 12 of file EvRateS11Cut.cpp.
97    
98     References \_\-maxRate, \_\-minRate, and CUTOK.
99    
100     \subsection{Member Data Documentation}
101     \hypertarget{classEvRateS11Cut_2d4e7bebcf80321a3185154e97546a4b}{
102     \index{EvRateS11Cut@{EvRateS11Cut}!\_\-maxRate@{\_\-maxRate}}
103     \index{\_\-maxRate@{\_\-maxRate}!EvRateS11Cut@{EvRateS11Cut}}
104     \subsubsection[{\_\-maxRate}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf EvRateS11Cut::\_\-maxRate}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
105     \label{classEvRateS11Cut_2d4e7bebcf80321a3185154e97546a4b}
106    
107    
108    
109    
110     Definition at line 47 of file EvRateS11Cut.h.
111    
112     Referenced by Check().\hypertarget{classEvRateS11Cut_4cbb71886d25c15196357c4de5e3a5d4}{
113     \index{EvRateS11Cut@{EvRateS11Cut}!\_\-minRate@{\_\-minRate}}
114     \index{\_\-minRate@{\_\-minRate}!EvRateS11Cut@{EvRateS11Cut}}
115     \subsubsection[{\_\-minRate}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf EvRateS11Cut::\_\-minRate}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
116     \label{classEvRateS11Cut_4cbb71886d25c15196357c4de5e3a5d4}
117    
118    
119    
120    
121     Definition at line 47 of file EvRateS11Cut.h.
122    
123     Referenced by Check().
124    
125     The documentation for this class was generated from the following files:\begin{CompactItemize}
126     \item
127     MiscCuts/EvRateS11Cut/\hyperlink{EvRateS11Cut_8h}{EvRateS11Cut.h}\item
128     MiscCuts/EvRateS11Cut/\hyperlink{EvRateS11Cut_8cpp}{EvRateS11Cut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23