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

Contents of /PamCut/doc/Doxygen/latex/classOBTQualCut.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (show annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:01 2009 UTC (15 years, 10 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 \hypertarget{classOBTQualCut}{
2 \section{OBTQualCut Class Reference}
3 \label{classOBTQualCut}\index{OBTQualCut@{OBTQualCut}}
4 }
5 The On Board Time quality cut.
6
7
8 {\tt \#include $<$OBTQualCut.h$>$}
9
10 Inheritance diagram for OBTQualCut::\begin{figure}[H]
11 \begin{center}
12 \leavevmode
13 \includegraphics[height=2cm]{classOBTQualCut}
14 \end{center}
15 \end{figure}
16 \subsection*{Public Member Functions}
17 \begin{CompactItemize}
18 \item
19 \hyperlink{classOBTQualCut_c12f44c05680f4c0a22377caaced6fb6}{OBTQualCut} (const char $\ast$cutName)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 \hyperlink{classOBTQualCut_7b5c76029db2e876a842dbaa7bbcd036}{$\sim$OBTQualCut} ()
22 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23 int \hyperlink{classOBTQualCut_7731b6f7e6e08ff629550da311952c6a}{Check} (PamLevel2 $\ast$event)
24 \begin{CompactList}\small\item\em The On Board Time quality check. \item\end{CompactList}\end{CompactItemize}
25 \subsection*{Private Attributes}
26 \begin{CompactItemize}
27 \item
28 UInt\_\-t \hyperlink{classOBTQualCut_e18ec7bbce8b3dc88a492bd904f1fdb1}{\_\-previousOBT}
29 \item
30 UInt\_\-t \hyperlink{classOBTQualCut_fdd76a87a2337e0d7f3755e7d8b36107}{\_\-previousRun}
31 \end{CompactItemize}
32
33
34 \subsection{Detailed Description}
35 The On Board Time quality cut.
36
37 This cut rejects events whose OBT is less than that of the previous event. When a new run starts, the previous OBT is set to the current one and the current event (ie., the first event of the run) is discarded.
38
39 Definition at line 28 of file OBTQualCut.h.
40
41 \subsection{Constructor \& Destructor Documentation}
42 \hypertarget{classOBTQualCut_c12f44c05680f4c0a22377caaced6fb6}{
43 \index{OBTQualCut@{OBTQualCut}!OBTQualCut@{OBTQualCut}}
44 \index{OBTQualCut@{OBTQualCut}!OBTQualCut@{OBTQualCut}}
45 \subsubsection[{OBTQualCut}]{\setlength{\rightskip}{0pt plus 5cm}OBTQualCut::OBTQualCut (const char $\ast$ {\em cutName})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
46 \label{classOBTQualCut_c12f44c05680f4c0a22377caaced6fb6}
47
48
49 Constructor.
50
51
52
53 Definition at line 32 of file OBTQualCut.h.\hypertarget{classOBTQualCut_7b5c76029db2e876a842dbaa7bbcd036}{
54 \index{OBTQualCut@{OBTQualCut}!$\sim$OBTQualCut@{$\sim$OBTQualCut}}
55 \index{$\sim$OBTQualCut@{$\sim$OBTQualCut}!OBTQualCut@{OBTQualCut}}
56 \subsubsection[{$\sim$OBTQualCut}]{\setlength{\rightskip}{0pt plus 5cm}OBTQualCut::$\sim$OBTQualCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
57 \label{classOBTQualCut_7b5c76029db2e876a842dbaa7bbcd036}
58
59
60 Destructor.
61
62
63
64 Definition at line 36 of file OBTQualCut.h.
65
66 \subsection{Member Function Documentation}
67 \hypertarget{classOBTQualCut_7731b6f7e6e08ff629550da311952c6a}{
68 \index{OBTQualCut@{OBTQualCut}!Check@{Check}}
69 \index{Check@{Check}!OBTQualCut@{OBTQualCut}}
70 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int OBTQualCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
71 \label{classOBTQualCut_7731b6f7e6e08ff629550da311952c6a}
72
73
74 The On Board Time quality check.
75
76 \begin{Desc}
77 \item[Parameters:]
78 \begin{description}
79 \item[{\em event}]The event to analyze. \end{description}
80 \end{Desc}
81 \begin{Desc}
82 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if OBT $>$ previous OBT.
83
84 \hyperlink{OBTQualCut_8h_1506abf860102f2a2f820c249eb660e5c3de490e92cafcab7fc60b7a87d4ee9d}{OBT\_\-NEWRUN} if the event has been discarded since it is the first of the run
85
86 \hyperlink{OBTQualCut_8h_1506abf860102f2a2f820c249eb660e5fbd1edeb6456b0462058e91cdb4403e5}{OBT\_\-INVALID} if OBT $<$ previous OBT \end{Desc}
87
88
89 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
90
91 Definition at line 12 of file OBTQualCut.cpp.
92
93 References \_\-previousOBT, \_\-previousRun, CUTOK, and OBT\_\-INVALID.
94
95 \subsection{Member Data Documentation}
96 \hypertarget{classOBTQualCut_e18ec7bbce8b3dc88a492bd904f1fdb1}{
97 \index{OBTQualCut@{OBTQualCut}!\_\-previousOBT@{\_\-previousOBT}}
98 \index{\_\-previousOBT@{\_\-previousOBT}!OBTQualCut@{OBTQualCut}}
99 \subsubsection[{\_\-previousOBT}]{\setlength{\rightskip}{0pt plus 5cm}UInt\_\-t {\bf OBTQualCut::\_\-previousOBT}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
100 \label{classOBTQualCut_e18ec7bbce8b3dc88a492bd904f1fdb1}
101
102
103
104
105 Definition at line 49 of file OBTQualCut.h.
106
107 Referenced by Check().\hypertarget{classOBTQualCut_fdd76a87a2337e0d7f3755e7d8b36107}{
108 \index{OBTQualCut@{OBTQualCut}!\_\-previousRun@{\_\-previousRun}}
109 \index{\_\-previousRun@{\_\-previousRun}!OBTQualCut@{OBTQualCut}}
110 \subsubsection[{\_\-previousRun}]{\setlength{\rightskip}{0pt plus 5cm}UInt\_\-t {\bf OBTQualCut::\_\-previousRun}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
111 \label{classOBTQualCut_fdd76a87a2337e0d7f3755e7d8b36107}
112
113
114
115
116 Definition at line 50 of file OBTQualCut.h.
117
118 Referenced by Check().
119
120 The documentation for this class was generated from the following files:\begin{CompactItemize}
121 \item
122 MiscCuts/OBTQualCut/\hyperlink{OBTQualCut_8h}{OBTQualCut.h}\item
123 MiscCuts/OBTQualCut/\hyperlink{OBTQualCut_8cpp}{OBTQualCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23