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

Annotation of /PamCut/doc/Doxygen/latex/classDataQualCut.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, 9 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{classDataQualCut}{
2     \section{DataQualCut Class Reference}
3     \label{classDataQualCut}\index{DataQualCut@{DataQualCut}}
4     }
5     The event and data quality cut. This cut ensures that all the data relative to the various detectors is present in the current event and that it has been correctly read.
6    
7    
8     {\tt \#include $<$DataQualCut.h$>$}
9    
10     Inheritance diagram for DataQualCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classDataQualCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classDataQualCut_6fbac99a5b8eac12684bf1e998626424}{DataQualCut} (const char $\ast$cutName, unsigned int cutMask=ALL)
20     \begin{CompactList}\small\item\em Constructor. \hyperlink{DataQualCut_8h}{DataQualCut.h}. \item\end{CompactList}\item
21     \hyperlink{classDataQualCut_355daf1e01209166cc5799e08b93c80a}{$\sim$DataQualCut} ()
22     \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23     int \hyperlink{classDataQualCut_38d0e630a49d113ba6f7d7cc44a663e6}{Check} (PamLevel2 $\ast$event)
24     \begin{CompactList}\small\item\em The event and data quality check. \item\end{CompactList}\end{CompactItemize}
25     \subsection*{Private Attributes}
26     \begin{CompactItemize}
27     \item
28     unsigned int \hyperlink{classDataQualCut_af85b516384facada4cf06256d6e070a}{\_\-cutMask}
29     \end{CompactItemize}
30    
31    
32     \subsection{Detailed Description}
33     The event and data quality cut. This cut ensures that all the data relative to the various detectors is present in the current event and that it has been correctly read.
34    
35     Definition at line 20 of file DataQualCut.h.
36    
37     \subsection{Constructor \& Destructor Documentation}
38     \hypertarget{classDataQualCut_6fbac99a5b8eac12684bf1e998626424}{
39     \index{DataQualCut@{DataQualCut}!DataQualCut@{DataQualCut}}
40     \index{DataQualCut@{DataQualCut}!DataQualCut@{DataQualCut}}
41     \subsubsection[{DataQualCut}]{\setlength{\rightskip}{0pt plus 5cm}DataQualCut::DataQualCut (const char $\ast$ {\em cutName}, \/ unsigned int {\em cutMask} = {\tt ALL})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
42     \label{classDataQualCut_6fbac99a5b8eac12684bf1e998626424}
43    
44    
45     Constructor. \hyperlink{DataQualCut_8h}{DataQualCut.h}.
46    
47     \begin{Desc}
48     \item[Parameters:]
49     \begin{description}
50     \item[{\em cutName}]The cut's name. \item[{\em cutMask}]An integer whose binary code would provide a mask for the cuts to apply; use a DETECTORCODE or a combination of them to enable the corresponding checks. Default: ALL (meaning all Level 2 detectors except S4 and ND). \end{description}
51     \end{Desc}
52    
53    
54     Definition at line 32 of file DataQualCut.h.\hypertarget{classDataQualCut_355daf1e01209166cc5799e08b93c80a}{
55     \index{DataQualCut@{DataQualCut}!$\sim$DataQualCut@{$\sim$DataQualCut}}
56     \index{$\sim$DataQualCut@{$\sim$DataQualCut}!DataQualCut@{DataQualCut}}
57     \subsubsection[{$\sim$DataQualCut}]{\setlength{\rightskip}{0pt plus 5cm}DataQualCut::$\sim$DataQualCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
58     \label{classDataQualCut_355daf1e01209166cc5799e08b93c80a}
59    
60    
61     Destructor.
62    
63    
64    
65     Definition at line 36 of file DataQualCut.h.
66    
67     \subsection{Member Function Documentation}
68     \hypertarget{classDataQualCut_38d0e630a49d113ba6f7d7cc44a663e6}{
69     \index{DataQualCut@{DataQualCut}!Check@{Check}}
70     \index{Check@{Check}!DataQualCut@{DataQualCut}}
71     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int DataQualCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
72     \label{classDataQualCut_38d0e630a49d113ba6f7d7cc44a663e6}
73    
74    
75     The event and data quality check.
76    
77     This method checks if the pointers to the various detectors level 2 data are present and if the data has been correctly unpacked, in this order: Tracker, Calo, ToF, AC, Trigger, Orbital Info. If it finds missing or corrupted data, it will stop the check and return a code corresponding to the missing/corrupted detector data.
78    
79     \begin{Desc}
80     \item[Parameters:]
81     \begin{description}
82     \item[{\em event}]The event to analyze. \end{description}
83     \end{Desc}
84     \begin{Desc}
85     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if all the checked data are present and not corrupted.
86    
87     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3ca35aac3cb4f8be8dfc8c5c471d537511}{TRK} if Tracker data is missing or corrupted.
88    
89     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3c81bd89f7ff2c29f0171c22f7c47c3e9f}{CALO} if Calo level2 data is missing or corrupted.
90    
91     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3ca7f5c1a17fce9b3e67e6e07a5e4c11b6}{CALO\_\-L1} if Calo level1 data is missing
92    
93     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3cc18e0fdb830eeb3a7f657a75000744db}{TOF} if ToF data is missing or corrupted.
94    
95     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3c3e553562ab1f48e96e9d0640526237b8}{AC} if AC data is missing or corrupted.
96    
97     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3c55e5ba1b4d86a4bcc4c1789a8f7b75e5}{TRIG} if Trigger data is missing or corrupted.
98    
99     \hyperlink{CommonDefs_8h_0fda80c273d9a34e86f5f4a24f9a7b3cad58394ab5225c7978a38cc22fdbfa35}{ORB} if Orbital Info data is missing. \end{Desc}
100    
101    
102     Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
103    
104     Definition at line 12 of file DataQualCut.cpp.
105    
106     References \_\-cutMask, AC, CALO, CALO\_\-L1, CUTOK, ORB, TOF, TRIG, and TRK.
107    
108     \subsection{Member Data Documentation}
109     \hypertarget{classDataQualCut_af85b516384facada4cf06256d6e070a}{
110     \index{DataQualCut@{DataQualCut}!\_\-cutMask@{\_\-cutMask}}
111     \index{\_\-cutMask@{\_\-cutMask}!DataQualCut@{DataQualCut}}
112     \subsubsection[{\_\-cutMask}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int {\bf DataQualCut::\_\-cutMask}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
113     \label{classDataQualCut_af85b516384facada4cf06256d6e070a}
114    
115    
116    
117    
118     Definition at line 60 of file DataQualCut.h.
119    
120     Referenced by Check().
121    
122     The documentation for this class was generated from the following files:\begin{CompactItemize}
123     \item
124     MiscCuts/DataQualCut/\hyperlink{DataQualCut_8h}{DataQualCut.h}\item
125     MiscCuts/DataQualCut/\hyperlink{DataQualCut_8cpp}{DataQualCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23