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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:03 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{classLTQualCut}{
2     \section{LTQualCut Class Reference}
3     \label{classLTQualCut}\index{LTQualCut@{LTQualCut}}
4     }
5     The live-time data quality cut: rejects the first event of each run and events with LT greater than an upper threshold (or with LT smaller than 0).
6    
7    
8     {\tt \#include $<$LTQualCut.h$>$}
9    
10     Inheritance diagram for LTQualCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classLTQualCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classLTQualCut_c358da9eb502cfe964b682e89e34b5ca}{LTQualCut} (const char $\ast$cutName, float threshold=4500)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21     \hyperlink{classLTQualCut_4c7b3319c00ecad7e55b90539b524c53}{$\sim$LTQualCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The live time quality check. \item\end{CompactList}\item
25     float \hyperlink{classLTQualCut_fe8fd76dbc23d11dfa24f2468f78d3d8}{GetLT} ()
26     \begin{CompactList}\small\item\em Returns the live time of the last examined event. \item\end{CompactList}\end{CompactItemize}
27     \subsection*{Private Attributes}
28     \begin{CompactItemize}
29     \item
30     unsigned int \hyperlink{classLTQualCut_14f95efcc2ab0b4746fd8507cbc76c32}{\_\-previousRun}
31     \item
32     float \hyperlink{classLTQualCut_c69f0d887b77b6dcd493f3e65d1cbae7}{\_\-LT}
33     \item
34     float \hyperlink{classLTQualCut_16d07f171dcecb0a847fe237cc290ff6}{\_\-timeout}
35     \end{CompactItemize}
36    
37    
38     \subsection{Detailed Description}
39     The live-time data quality cut: rejects the first event of each run and events with LT greater than an upper threshold (or with LT smaller than 0).
40    
41     Definition at line 24 of file LTQualCut.h.
42    
43     \subsection{Constructor \& Destructor Documentation}
44     \hypertarget{classLTQualCut_c358da9eb502cfe964b682e89e34b5ca}{
45     \index{LTQualCut@{LTQualCut}!LTQualCut@{LTQualCut}}
46     \index{LTQualCut@{LTQualCut}!LTQualCut@{LTQualCut}}
47     \subsubsection[{LTQualCut}]{\setlength{\rightskip}{0pt plus 5cm}LTQualCut::LTQualCut (const char $\ast$ {\em cutName}, \/ float {\em threshold} = {\tt 4500})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
48     \label{classLTQualCut_c358da9eb502cfe964b682e89e34b5ca}
49    
50    
51     Constructor.
52    
53     \begin{Desc}
54     \item[Parameters:]
55     \begin{description}
56     \item[{\em cutName}]The cut's name. \item[{\em threshold}]The live time maximum accepted value in ms. It is the value above which a live time is considered invalid. It must be less than the trigger timeout on IDAQ board, which is $\sim$ 4600 ms. Default is 4500 (use of different values must be justified). \end{description}
57     \end{Desc}
58    
59    
60     Definition at line 34 of file LTQualCut.h.\hypertarget{classLTQualCut_4c7b3319c00ecad7e55b90539b524c53}{
61     \index{LTQualCut@{LTQualCut}!$\sim$LTQualCut@{$\sim$LTQualCut}}
62     \index{$\sim$LTQualCut@{$\sim$LTQualCut}!LTQualCut@{LTQualCut}}
63     \subsubsection[{$\sim$LTQualCut}]{\setlength{\rightskip}{0pt plus 5cm}LTQualCut::$\sim$LTQualCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
64     \label{classLTQualCut_4c7b3319c00ecad7e55b90539b524c53}
65    
66    
67     Destructor.
68    
69    
70    
71     Definition at line 38 of file LTQualCut.h.
72    
73     \subsection{Member Function Documentation}
74     \hypertarget{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}{
75     \index{LTQualCut@{LTQualCut}!Check@{Check}}
76     \index{Check@{Check}!LTQualCut@{LTQualCut}}
77     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int LTQualCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
78     \label{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}
79    
80    
81     The live time quality 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 LT $<$ timeout.
90    
91     \hyperlink{LTQualCut_8h_7d30c7d7f0c700a98b8a05984c842c4fb2905806ac12cf7f821238ebfccd90c4}{LT\_\-INVALID} if LT $>$ timeout.
92    
93     \hyperlink{LTQualCut_8h_7d30c7d7f0c700a98b8a05984c842c4f5a3b012c296a8ace38a9a256d2df3b6c}{LT\_\-NEWRUN} if the event is at the beginning of the run. \end{Desc}
94    
95    
96     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
97    
98     Definition at line 12 of file LTQualCut.cpp.
99    
100     References \_\-LT, \_\-previousRun, \_\-timeout, CUTOK, LT\_\-INVALID, and LT\_\-NEWRUN.\hypertarget{classLTQualCut_fe8fd76dbc23d11dfa24f2468f78d3d8}{
101     \index{LTQualCut@{LTQualCut}!GetLT@{GetLT}}
102     \index{GetLT@{GetLT}!LTQualCut@{LTQualCut}}
103     \subsubsection[{GetLT}]{\setlength{\rightskip}{0pt plus 5cm}float LTQualCut::GetLT ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
104     \label{classLTQualCut_fe8fd76dbc23d11dfa24f2468f78d3d8}
105    
106    
107     Returns the live time of the last examined event.
108    
109     \begin{Desc}
110     \item[Returns:]The live time of the last examined event in ms (-1 -$>$ first event of the run). \end{Desc}
111    
112    
113     Definition at line 54 of file LTQualCut.h.
114    
115     References \_\-LT.
116    
117     \subsection{Member Data Documentation}
118     \hypertarget{classLTQualCut_c69f0d887b77b6dcd493f3e65d1cbae7}{
119     \index{LTQualCut@{LTQualCut}!\_\-LT@{\_\-LT}}
120     \index{\_\-LT@{\_\-LT}!LTQualCut@{LTQualCut}}
121     \subsubsection[{\_\-LT}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf LTQualCut::\_\-LT}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
122     \label{classLTQualCut_c69f0d887b77b6dcd493f3e65d1cbae7}
123    
124    
125    
126    
127     Definition at line 58 of file LTQualCut.h.
128    
129     Referenced by Check(), and GetLT().\hypertarget{classLTQualCut_14f95efcc2ab0b4746fd8507cbc76c32}{
130     \index{LTQualCut@{LTQualCut}!\_\-previousRun@{\_\-previousRun}}
131     \index{\_\-previousRun@{\_\-previousRun}!LTQualCut@{LTQualCut}}
132     \subsubsection[{\_\-previousRun}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf LTQualCut::\_\-previousRun}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
133     \label{classLTQualCut_14f95efcc2ab0b4746fd8507cbc76c32}
134    
135    
136    
137    
138     Definition at line 57 of file LTQualCut.h.
139    
140     Referenced by Check().\hypertarget{classLTQualCut_16d07f171dcecb0a847fe237cc290ff6}{
141     \index{LTQualCut@{LTQualCut}!\_\-timeout@{\_\-timeout}}
142     \index{\_\-timeout@{\_\-timeout}!LTQualCut@{LTQualCut}}
143     \subsubsection[{\_\-timeout}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf LTQualCut::\_\-timeout}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
144     \label{classLTQualCut_16d07f171dcecb0a847fe237cc290ff6}
145    
146    
147    
148    
149     Definition at line 59 of file LTQualCut.h.
150    
151     Referenced by Check().
152    
153     The documentation for this class was generated from the following files:\begin{CompactItemize}
154     \item
155     MiscCuts/LTQualCut/\hyperlink{LTQualCut_8h}{LTQualCut.h}\item
156     MiscCuts/LTQualCut/\hyperlink{LTQualCut_8cpp}{LTQualCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23