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: OBTQualCut 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 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 List</span></a></li> |
19 |
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
20 |
<li><a href="functions.html"><span>Class Members</span></a></li> |
21 |
</ul> |
22 |
</div> |
23 |
</div> |
24 |
<div class="contents"> |
25 |
<h1>OBTQualCut Class Reference</h1><!-- doxytag: class="OBTQualCut" --><!-- doxytag: inherits="PamCut" -->The On Board Time quality cut. |
26 |
<a href="#_details">More...</a> |
27 |
<p> |
28 |
<code>#include <<a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a>></code> |
29 |
<p> |
30 |
<div class="dynheader"> |
31 |
Inheritance diagram for OBTQualCut:</div> |
32 |
<div class="dynsection"> |
33 |
|
34 |
<p><center><img src="classOBTQualCut.png" usemap="#OBTQualCut_map" border="0" alt=""></center> |
35 |
<map name="OBTQualCut_map"> |
36 |
<area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,83,24"> |
37 |
</map> |
38 |
</div> |
39 |
|
40 |
<p> |
41 |
<a href="classOBTQualCut-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOBTQualCut.html#c12f44c05680f4c0a22377caaced6fb6">OBTQualCut</a> (const char *cutName)</td></tr> |
45 |
|
46 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#c12f44c05680f4c0a22377caaced6fb6"></a><br></td></tr> |
47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOBTQualCut.html#7b5c76029db2e876a842dbaa7bbcd036">~OBTQualCut</a> ()</td></tr> |
48 |
|
49 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#7b5c76029db2e876a842dbaa7bbcd036"></a><br></td></tr> |
50 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOBTQualCut.html#7731b6f7e6e08ff629550da311952c6a">Check</a> (PamLevel2 *event)</td></tr> |
51 |
|
52 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">The On Board Time quality check. <a href="#7731b6f7e6e08ff629550da311952c6a"></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">UInt_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOBTQualCut.html#e18ec7bbce8b3dc88a492bd904f1fdb1">_previousOBT</a></td></tr> |
55 |
|
56 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">UInt_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classOBTQualCut.html#fdd76a87a2337e0d7f3755e7d8b36107">_previousRun</a></td></tr> |
57 |
|
58 |
</table> |
59 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
60 |
The On Board Time quality cut. |
61 |
<p> |
62 |
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. |
63 |
<p>Definition at line <a class="el" href="OBTQualCut_8h_source.html#l00028">28</a> of file <a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a>.</p> |
64 |
<hr><h2>Constructor & Destructor Documentation</h2> |
65 |
<a class="anchor" name="c12f44c05680f4c0a22377caaced6fb6"></a><!-- doxytag: member="OBTQualCut::OBTQualCut" ref="c12f44c05680f4c0a22377caaced6fb6" args="(const char *cutName)" --> |
66 |
<div class="memitem"> |
67 |
<div class="memproto"> |
68 |
<table class="memname"> |
69 |
<tr> |
70 |
<td class="memname">OBTQualCut::OBTQualCut </td> |
71 |
<td>(</td> |
72 |
<td class="paramtype">const char * </td> |
73 |
<td class="paramname"> <em>cutName</em> </td> |
74 |
<td> ) </td> |
75 |
<td><code> [inline]</code></td> |
76 |
</tr> |
77 |
</table> |
78 |
</div> |
79 |
<div class="memdoc"> |
80 |
|
81 |
<p> |
82 |
Constructor. |
83 |
<p> |
84 |
|
85 |
<p>Definition at line <a class="el" href="OBTQualCut_8h_source.html#l00032">32</a> of file <a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a>.</p> |
86 |
|
87 |
</div> |
88 |
</div><p> |
89 |
<a class="anchor" name="7b5c76029db2e876a842dbaa7bbcd036"></a><!-- doxytag: member="OBTQualCut::~OBTQualCut" ref="7b5c76029db2e876a842dbaa7bbcd036" args="()" --> |
90 |
<div class="memitem"> |
91 |
<div class="memproto"> |
92 |
<table class="memname"> |
93 |
<tr> |
94 |
<td class="memname">OBTQualCut::~OBTQualCut </td> |
95 |
<td>(</td> |
96 |
<td class="paramname"> </td> |
97 |
<td> ) </td> |
98 |
<td><code> [inline]</code></td> |
99 |
</tr> |
100 |
</table> |
101 |
</div> |
102 |
<div class="memdoc"> |
103 |
|
104 |
<p> |
105 |
Destructor. |
106 |
<p> |
107 |
|
108 |
<p>Definition at line <a class="el" href="OBTQualCut_8h_source.html#l00036">36</a> of file <a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a>.</p> |
109 |
|
110 |
</div> |
111 |
</div><p> |
112 |
<hr><h2>Member Function Documentation</h2> |
113 |
<a class="anchor" name="7731b6f7e6e08ff629550da311952c6a"></a><!-- doxytag: member="OBTQualCut::Check" ref="7731b6f7e6e08ff629550da311952c6a" args="(PamLevel2 *event)" --> |
114 |
<div class="memitem"> |
115 |
<div class="memproto"> |
116 |
<table class="memname"> |
117 |
<tr> |
118 |
<td class="memname">int OBTQualCut::Check </td> |
119 |
<td>(</td> |
120 |
<td class="paramtype">PamLevel2 * </td> |
121 |
<td class="paramname"> <em>event</em> </td> |
122 |
<td> ) </td> |
123 |
<td><code> [virtual]</code></td> |
124 |
</tr> |
125 |
</table> |
126 |
</div> |
127 |
<div class="memdoc"> |
128 |
|
129 |
<p> |
130 |
The On Board Time quality check. |
131 |
<p> |
132 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
133 |
<table border="0" cellspacing="2" cellpadding="0"> |
134 |
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The event to analyze. </td></tr> |
135 |
</table> |
136 |
</dl> |
137 |
<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 OBT > previous OBT. <p> |
138 |
<a class="el" href="OBTQualCut_8h.html#1506abf860102f2a2f820c249eb660e5c3de490e92cafcab7fc60b7a87d4ee9d" title="Discarded because it is the first event of the run.">OBT_NEWRUN</a> if the event has been discarded since it is the first of the run <p> |
139 |
<a class="el" href="OBTQualCut_8h.html#1506abf860102f2a2f820c249eb660e5fbd1edeb6456b0462058e91cdb4403e5" title="Discarded because the OBT is not valid.">OBT_INVALID</a> if OBT < previous OBT </dd></dl> |
140 |
|
141 |
<p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p> |
142 |
|
143 |
<p>Definition at line <a class="el" href="OBTQualCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="OBTQualCut_8cpp_source.html">OBTQualCut.cpp</a>.</p> |
144 |
|
145 |
<p>References <a class="el" href="OBTQualCut_8h_source.html#l00049">_previousOBT</a>, <a class="el" href="OBTQualCut_8h_source.html#l00050">_previousRun</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, and <a class="el" href="OBTQualCut_8h_source.html#l00018">OBT_INVALID</a>.</p> |
146 |
|
147 |
</div> |
148 |
</div><p> |
149 |
<hr><h2>Member Data Documentation</h2> |
150 |
<a class="anchor" name="e18ec7bbce8b3dc88a492bd904f1fdb1"></a><!-- doxytag: member="OBTQualCut::_previousOBT" ref="e18ec7bbce8b3dc88a492bd904f1fdb1" args="" --> |
151 |
<div class="memitem"> |
152 |
<div class="memproto"> |
153 |
<table class="memname"> |
154 |
<tr> |
155 |
<td class="memname">UInt_t <a class="el" href="classOBTQualCut.html#e18ec7bbce8b3dc88a492bd904f1fdb1">OBTQualCut::_previousOBT</a><code> [private]</code> </td> |
156 |
</tr> |
157 |
</table> |
158 |
</div> |
159 |
<div class="memdoc"> |
160 |
|
161 |
<p> |
162 |
|
163 |
<p>Definition at line <a class="el" href="OBTQualCut_8h_source.html#l00049">49</a> of file <a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a>.</p> |
164 |
|
165 |
<p>Referenced by <a class="el" href="OBTQualCut_8cpp_source.html#l00012">Check()</a>.</p> |
166 |
|
167 |
</div> |
168 |
</div><p> |
169 |
<a class="anchor" name="fdd76a87a2337e0d7f3755e7d8b36107"></a><!-- doxytag: member="OBTQualCut::_previousRun" ref="fdd76a87a2337e0d7f3755e7d8b36107" args="" --> |
170 |
<div class="memitem"> |
171 |
<div class="memproto"> |
172 |
<table class="memname"> |
173 |
<tr> |
174 |
<td class="memname">UInt_t <a class="el" href="classOBTQualCut.html#fdd76a87a2337e0d7f3755e7d8b36107">OBTQualCut::_previousRun</a><code> [private]</code> </td> |
175 |
</tr> |
176 |
</table> |
177 |
</div> |
178 |
<div class="memdoc"> |
179 |
|
180 |
<p> |
181 |
|
182 |
<p>Definition at line <a class="el" href="OBTQualCut_8h_source.html#l00050">50</a> of file <a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a>.</p> |
183 |
|
184 |
<p>Referenced by <a class="el" href="OBTQualCut_8cpp_source.html#l00012">Check()</a>.</p> |
185 |
|
186 |
</div> |
187 |
</div><p> |
188 |
<hr>The documentation for this class was generated from the following files:<ul> |
189 |
<li>MiscCuts/OBTQualCut/<a class="el" href="OBTQualCut_8h_source.html">OBTQualCut.h</a><li>MiscCuts/OBTQualCut/<a class="el" href="OBTQualCut_8cpp_source.html">OBTQualCut.cpp</a></ul> |
190 |
</div> |
191 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:40 2009 for PamCut by |
192 |
<a href="http://www.doxygen.org/index.html"> |
193 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> |
194 |
</body> |
195 |
</html> |