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

Annotation of /PamCut/doc/Doxygen/html/classDataQualCut.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:08 2009 UTC (15 years, 10 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: text/html 
Initial revision
1 pam-fi 1.1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2     <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3     <title>PamCut: DataQualCut Class Reference</title>
4     <link href="tabs.css" rel="stylesheet" type="text/css">
5     <link href="doxygen.css" rel="stylesheet" type="text/css">
6     </head><body>
7     <!-- Generated by Doxygen 1.5.9 -->
8     <div class="navigation" id="top">
9     <div class="tabs">
10     <ul>
11     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12     <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13     <li><a href="files.html"><span>Files</span></a></li>
14     </ul>
15     </div>
16     <div class="tabs">
17     <ul>
18     <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
19     <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20     <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21     </ul>
22     </div>
23     </div>
24     <div class="contents">
25     <h1>DataQualCut Class Reference</h1><!-- doxytag: class="DataQualCut" --><!-- doxytag: inherits="PamCut" -->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.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="DataQualCut_8h_source.html">DataQualCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for DataQualCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classDataQualCut.png" usemap="#DataQualCut_map" border="0" alt=""></center>
35     <map name="DataQualCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,84,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classDataQualCut-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
42     <tr><td></td></tr>
43     <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44     <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataQualCut.html#6fbac99a5b8eac12684bf1e998626424">DataQualCut</a> (const char *cutName, unsigned int cutMask=ALL)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a class="el" href="DataQualCut_8h.html">DataQualCut.h</a>. <a href="#6fbac99a5b8eac12684bf1e998626424"></a><br></td></tr>
47     <tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataQualCut.html#355daf1e01209166cc5799e08b93c80a">~DataQualCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#355daf1e01209166cc5799e08b93c80a"></a><br></td></tr>
50     <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataQualCut.html#38d0e630a49d113ba6f7d7cc44a663e6">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The event and data quality check. <a href="#38d0e630a49d113ba6f7d7cc44a663e6"></a><br></td></tr>
53     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
54     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataQualCut.html#af85b516384facada4cf06256d6e070a">_cutMask</a></td></tr>
55    
56     </table>
57     <hr><a name="_details"></a><h2>Detailed Description</h2>
58     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.
59     <p>Definition at line <a class="el" href="DataQualCut_8h_source.html#l00020">20</a> of file <a class="el" href="DataQualCut_8h_source.html">DataQualCut.h</a>.</p>
60     <hr><h2>Constructor &amp; Destructor Documentation</h2>
61     <a class="anchor" name="6fbac99a5b8eac12684bf1e998626424"></a><!-- doxytag: member="DataQualCut::DataQualCut" ref="6fbac99a5b8eac12684bf1e998626424" args="(const char *cutName, unsigned int cutMask=ALL)" -->
62     <div class="memitem">
63     <div class="memproto">
64     <table class="memname">
65     <tr>
66     <td class="memname">DataQualCut::DataQualCut </td>
67     <td>(</td>
68     <td class="paramtype">const char *&nbsp;</td>
69     <td class="paramname"> <em>cutName</em>, </td>
70     </tr>
71     <tr>
72     <td class="paramkey"></td>
73     <td></td>
74     <td class="paramtype">unsigned int&nbsp;</td>
75     <td class="paramname"> <em>cutMask</em> = <code>ALL</code></td><td>&nbsp;</td>
76     </tr>
77     <tr>
78     <td></td>
79     <td>)</td>
80     <td></td><td></td><td><code> [inline]</code></td>
81     </tr>
82     </table>
83     </div>
84     <div class="memdoc">
85    
86     <p>
87     Constructor. <a class="el" href="DataQualCut_8h.html">DataQualCut.h</a>.
88     <p>
89     <dl compact><dt><b>Parameters:</b></dt><dd>
90     <table border="0" cellspacing="2" cellpadding="0">
91     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
92     <tr><td valign="top"></td><td valign="top"><em>cutMask</em>&nbsp;</td><td>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). </td></tr>
93     </table>
94     </dl>
95    
96     <p>Definition at line <a class="el" href="DataQualCut_8h_source.html#l00032">32</a> of file <a class="el" href="DataQualCut_8h_source.html">DataQualCut.h</a>.</p>
97    
98     </div>
99     </div><p>
100     <a class="anchor" name="355daf1e01209166cc5799e08b93c80a"></a><!-- doxytag: member="DataQualCut::~DataQualCut" ref="355daf1e01209166cc5799e08b93c80a" args="()" -->
101     <div class="memitem">
102     <div class="memproto">
103     <table class="memname">
104     <tr>
105     <td class="memname">DataQualCut::~DataQualCut </td>
106     <td>(</td>
107     <td class="paramname"> </td>
108     <td>&nbsp;)&nbsp;</td>
109     <td><code> [inline]</code></td>
110     </tr>
111     </table>
112     </div>
113     <div class="memdoc">
114    
115     <p>
116     Destructor.
117     <p>
118    
119     <p>Definition at line <a class="el" href="DataQualCut_8h_source.html#l00036">36</a> of file <a class="el" href="DataQualCut_8h_source.html">DataQualCut.h</a>.</p>
120    
121     </div>
122     </div><p>
123     <hr><h2>Member Function Documentation</h2>
124     <a class="anchor" name="38d0e630a49d113ba6f7d7cc44a663e6"></a><!-- doxytag: member="DataQualCut::Check" ref="38d0e630a49d113ba6f7d7cc44a663e6" args="(PamLevel2 *event)" -->
125     <div class="memitem">
126     <div class="memproto">
127     <table class="memname">
128     <tr>
129     <td class="memname">int DataQualCut::Check </td>
130     <td>(</td>
131     <td class="paramtype">PamLevel2 *&nbsp;</td>
132     <td class="paramname"> <em>event</em> </td>
133     <td>&nbsp;)&nbsp;</td>
134     <td><code> [virtual]</code></td>
135     </tr>
136     </table>
137     </div>
138     <div class="memdoc">
139    
140     <p>
141     The event and data quality check.
142     <p>
143     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.<p>
144     <dl compact><dt><b>Parameters:</b></dt><dd>
145     <table border="0" cellspacing="2" cellpadding="0">
146     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
147     </table>
148     </dl>
149     <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="CommonDefs_8h.html#c857f4b76ae431837cbf61fd74863b6c" title="The implementations of PamCut::Check() must return this value if the event satisfy...">CUTOK</a> if all the checked data are present and not corrupted. <p>
150     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3ca35aac3cb4f8be8dfc8c5c471d537511" title="Code for Tracker.">TRK</a> if Tracker data is missing or corrupted. <p>
151     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3c81bd89f7ff2c29f0171c22f7c47c3e9f" title="Code for Calorimeter level2.">CALO</a> if Calo level2 data is missing or corrupted. <p>
152     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3ca7f5c1a17fce9b3e67e6e07a5e4c11b6" title="Code for Calorimeter level1.">CALO_L1</a> if Calo level1 data is missing <p>
153     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3cc18e0fdb830eeb3a7f657a75000744db" title="Code for ToF.">TOF</a> if ToF data is missing or corrupted. <p>
154     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3c3e553562ab1f48e96e9d0640526237b8" title="Code for AntiCoincidence.">AC</a> if AC data is missing or corrupted. <p>
155     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3c55e5ba1b4d86a4bcc4c1789a8f7b75e5" title="Code for Trigger.">TRIG</a> if Trigger data is missing or corrupted. <p>
156     <a class="el" href="CommonDefs_8h.html#0fda80c273d9a34e86f5f4a24f9a7b3cad58394ab5225c7978a38cc22fdbfa35" title="Code for Orbital Info.">ORB</a> if Orbital Info data is missing. </dd></dl>
157    
158     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
159    
160     <p>Definition at line <a class="el" href="DataQualCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="DataQualCut_8cpp_source.html">DataQualCut.cpp</a>.</p>
161    
162     <p>References <a class="el" href="DataQualCut_8h_source.html#l00060">_cutMask</a>, <a class="el" href="CommonDefs_8h_source.html#l00025">AC</a>, <a class="el" href="CommonDefs_8h_source.html#l00023">CALO</a>, <a class="el" href="CommonDefs_8h_source.html#l00029">CALO_L1</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, <a class="el" href="CommonDefs_8h_source.html#l00027">ORB</a>, <a class="el" href="CommonDefs_8h_source.html#l00024">TOF</a>, <a class="el" href="CommonDefs_8h_source.html#l00026">TRIG</a>, and <a class="el" href="CommonDefs_8h_source.html#l00022">TRK</a>.</p>
163    
164     </div>
165     </div><p>
166     <hr><h2>Member Data Documentation</h2>
167     <a class="anchor" name="af85b516384facada4cf06256d6e070a"></a><!-- doxytag: member="DataQualCut::_cutMask" ref="af85b516384facada4cf06256d6e070a" args="" -->
168     <div class="memitem">
169     <div class="memproto">
170     <table class="memname">
171     <tr>
172     <td class="memname">unsigned int <a class="el" href="classDataQualCut.html#af85b516384facada4cf06256d6e070a">DataQualCut::_cutMask</a><code> [private]</code> </td>
173     </tr>
174     </table>
175     </div>
176     <div class="memdoc">
177    
178     <p>
179    
180     <p>Definition at line <a class="el" href="DataQualCut_8h_source.html#l00060">60</a> of file <a class="el" href="DataQualCut_8h_source.html">DataQualCut.h</a>.</p>
181    
182     <p>Referenced by <a class="el" href="DataQualCut_8cpp_source.html#l00012">Check()</a>.</p>
183    
184     </div>
185     </div><p>
186     <hr>The documentation for this class was generated from the following files:<ul>
187     <li>MiscCuts/DataQualCut/<a class="el" href="DataQualCut_8h_source.html">DataQualCut.h</a><li>MiscCuts/DataQualCut/<a class="el" href="DataQualCut_8cpp_source.html">DataQualCut.cpp</a></ul>
188     </div>
189     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:36 2009 for PamCut by&nbsp;
190     <a href="http://www.doxygen.org/index.html">
191     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
192     </body>
193     </html>
  ViewVC Help
Powered by ViewVC 1.1.23