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

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 pam-fi 1.2 \hypertarget{classLTQualCut_4c7b3319c00ecad7e55b90539b524c53}{
22     \hyperlink{classLTQualCut_4c7b3319c00ecad7e55b90539b524c53}{$\sim$LTQualCut} ()}
23     \label{classLTQualCut_4c7b3319c00ecad7e55b90539b524c53}
24    
25 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26     int \hyperlink{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}{Check} (PamLevel2 $\ast$event)
27     \begin{CompactList}\small\item\em The live time quality check. \item\end{CompactList}\item
28     float \hyperlink{classLTQualCut_fe8fd76dbc23d11dfa24f2468f78d3d8}{GetLT} ()
29     \begin{CompactList}\small\item\em Returns the live time of the last examined event. \item\end{CompactList}\end{CompactItemize}
30    
31    
32     \subsection{Detailed Description}
33     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).
34    
35     \subsection{Constructor \& Destructor Documentation}
36     \hypertarget{classLTQualCut_c358da9eb502cfe964b682e89e34b5ca}{
37     \index{LTQualCut@{LTQualCut}!LTQualCut@{LTQualCut}}
38     \index{LTQualCut@{LTQualCut}!LTQualCut@{LTQualCut}}
39     \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{]}}}}
40     \label{classLTQualCut_c358da9eb502cfe964b682e89e34b5ca}
41    
42    
43     Constructor.
44    
45     \begin{Desc}
46     \item[Parameters:]
47     \begin{description}
48     \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}
49     \end{Desc}
50    
51    
52     \subsection{Member Function Documentation}
53     \hypertarget{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}{
54     \index{LTQualCut@{LTQualCut}!Check@{Check}}
55     \index{Check@{Check}!LTQualCut@{LTQualCut}}
56     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int LTQualCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
57     \label{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}
58    
59    
60     The live time quality 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 LT $<$ timeout.
69    
70     \hyperlink{LTQualCut_8h_7d30c7d7f0c700a98b8a05984c842c4fb2905806ac12cf7f821238ebfccd90c4}{LT\_\-INVALID} if LT $>$ timeout.
71    
72     \hyperlink{LTQualCut_8h_7d30c7d7f0c700a98b8a05984c842c4f5a3b012c296a8ace38a9a256d2df3b6c}{LT\_\-NEWRUN} if the event is at the beginning of the run. \end{Desc}
73    
74    
75 pam-fi 1.2 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.\hypertarget{classLTQualCut_fe8fd76dbc23d11dfa24f2468f78d3d8}{
76 pam-fi 1.1 \index{LTQualCut@{LTQualCut}!GetLT@{GetLT}}
77     \index{GetLT@{GetLT}!LTQualCut@{LTQualCut}}
78     \subsubsection[{GetLT}]{\setlength{\rightskip}{0pt plus 5cm}float LTQualCut::GetLT ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
79     \label{classLTQualCut_fe8fd76dbc23d11dfa24f2468f78d3d8}
80    
81    
82     Returns the live time of the last examined event.
83    
84     \begin{Desc}
85     \item[Returns:]The live time of the last examined event in ms (-1 -$>$ first event of the run). \end{Desc}
86    
87    
88     The documentation for this class was generated from the following files:\begin{CompactItemize}
89     \item
90     MiscCuts/LTQualCut/\hyperlink{LTQualCut_8h}{LTQualCut.h}\item
91     MiscCuts/LTQualCut/\hyperlink{LTQualCut_8cpp}{LTQualCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23