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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:05 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: LTQualCut 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>LTQualCut Class Reference</h1><!-- doxytag: class="LTQualCut" --><!-- doxytag: inherits="PamCut" -->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).
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for LTQualCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classLTQualCut.png" usemap="#LTQualCut_map" border="0" alt=""></center>
35     <map name="LTQualCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,72,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classLTQualCut-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="classLTQualCut.html#c358da9eb502cfe964b682e89e34b5ca">LTQualCut</a> (const char *cutName, float threshold=4500)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#c358da9eb502cfe964b682e89e34b5ca"></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="classLTQualCut.html#4c7b3319c00ecad7e55b90539b524c53">~LTQualCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#4c7b3319c00ecad7e55b90539b524c53"></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="classLTQualCut.html#b38dc0bd6b25f899753b4598c278e6a2">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The live time quality check. <a href="#b38dc0bd6b25f899753b4598c278e6a2"></a><br></td></tr>
53     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTQualCut.html#fe8fd76dbc23d11dfa24f2468f78d3d8">GetLT</a> ()</td></tr>
54    
55     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the live time of the last examined event. <a href="#fe8fd76dbc23d11dfa24f2468f78d3d8"></a><br></td></tr>
56     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
57     <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTQualCut.html#14f95efcc2ab0b4746fd8507cbc76c32">_previousRun</a></td></tr>
58    
59     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTQualCut.html#c69f0d887b77b6dcd493f3e65d1cbae7">_LT</a></td></tr>
60    
61     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTQualCut.html#16d07f171dcecb0a847fe237cc290ff6">_timeout</a></td></tr>
62    
63     </table>
64     <hr><a name="_details"></a><h2>Detailed Description</h2>
65     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).
66     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00024">24</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
67     <hr><h2>Constructor &amp; Destructor Documentation</h2>
68     <a class="anchor" name="c358da9eb502cfe964b682e89e34b5ca"></a><!-- doxytag: member="LTQualCut::LTQualCut" ref="c358da9eb502cfe964b682e89e34b5ca" args="(const char *cutName, float threshold=4500)" -->
69     <div class="memitem">
70     <div class="memproto">
71     <table class="memname">
72     <tr>
73     <td class="memname">LTQualCut::LTQualCut </td>
74     <td>(</td>
75     <td class="paramtype">const char *&nbsp;</td>
76     <td class="paramname"> <em>cutName</em>, </td>
77     </tr>
78     <tr>
79     <td class="paramkey"></td>
80     <td></td>
81     <td class="paramtype">float&nbsp;</td>
82     <td class="paramname"> <em>threshold</em> = <code>4500</code></td><td>&nbsp;</td>
83     </tr>
84     <tr>
85     <td></td>
86     <td>)</td>
87     <td></td><td></td><td><code> [inline]</code></td>
88     </tr>
89     </table>
90     </div>
91     <div class="memdoc">
92    
93     <p>
94     Constructor.
95     <p>
96     <dl compact><dt><b>Parameters:</b></dt><dd>
97     <table border="0" cellspacing="2" cellpadding="0">
98     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
99     <tr><td valign="top"></td><td valign="top"><em>threshold</em>&nbsp;</td><td>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 ~ 4600 ms. Default is 4500 (use of different values must be justified). </td></tr>
100     </table>
101     </dl>
102    
103     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00034">34</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
104    
105     </div>
106     </div><p>
107     <a class="anchor" name="4c7b3319c00ecad7e55b90539b524c53"></a><!-- doxytag: member="LTQualCut::~LTQualCut" ref="4c7b3319c00ecad7e55b90539b524c53" args="()" -->
108     <div class="memitem">
109     <div class="memproto">
110     <table class="memname">
111     <tr>
112     <td class="memname">LTQualCut::~LTQualCut </td>
113     <td>(</td>
114     <td class="paramname"> </td>
115     <td>&nbsp;)&nbsp;</td>
116     <td><code> [inline]</code></td>
117     </tr>
118     </table>
119     </div>
120     <div class="memdoc">
121    
122     <p>
123     Destructor.
124     <p>
125    
126     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00038">38</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
127    
128     </div>
129     </div><p>
130     <hr><h2>Member Function Documentation</h2>
131     <a class="anchor" name="b38dc0bd6b25f899753b4598c278e6a2"></a><!-- doxytag: member="LTQualCut::Check" ref="b38dc0bd6b25f899753b4598c278e6a2" args="(PamLevel2 *event)" -->
132     <div class="memitem">
133     <div class="memproto">
134     <table class="memname">
135     <tr>
136     <td class="memname">int LTQualCut::Check </td>
137     <td>(</td>
138     <td class="paramtype">PamLevel2 *&nbsp;</td>
139     <td class="paramname"> <em>event</em> </td>
140     <td>&nbsp;)&nbsp;</td>
141     <td><code> [virtual]</code></td>
142     </tr>
143     </table>
144     </div>
145     <div class="memdoc">
146    
147     <p>
148     The live time quality check.
149     <p>
150     <dl compact><dt><b>Parameters:</b></dt><dd>
151     <table border="0" cellspacing="2" cellpadding="0">
152     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
153     </table>
154     </dl>
155     <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 LT &lt; timeout. <p>
156     <a class="el" href="LTQualCut_8h.html#7d30c7d7f0c700a98b8a05984c842c4fb2905806ac12cf7f821238ebfccd90c4" title="Discarded because the LT is greater than timeout.">LT_INVALID</a> if LT &gt; timeout. <p>
157     <a class="el" href="LTQualCut_8h.html#7d30c7d7f0c700a98b8a05984c842c4f5a3b012c296a8ace38a9a256d2df3b6c" title="Discarded because it is the first event of the run.">LT_NEWRUN</a> if the event is at the beginning of the run. </dd></dl>
158    
159     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
160    
161     <p>Definition at line <a class="el" href="LTQualCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="LTQualCut_8cpp_source.html">LTQualCut.cpp</a>.</p>
162    
163     <p>References <a class="el" href="LTQualCut_8h_source.html#l00058">_LT</a>, <a class="el" href="LTQualCut_8h_source.html#l00057">_previousRun</a>, <a class="el" href="LTQualCut_8h_source.html#l00059">_timeout</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, <a class="el" href="LTQualCut_8h_source.html#l00018">LT_INVALID</a>, and <a class="el" href="LTQualCut_8h_source.html#l00017">LT_NEWRUN</a>.</p>
164    
165     </div>
166     </div><p>
167     <a class="anchor" name="fe8fd76dbc23d11dfa24f2468f78d3d8"></a><!-- doxytag: member="LTQualCut::GetLT" ref="fe8fd76dbc23d11dfa24f2468f78d3d8" args="()" -->
168     <div class="memitem">
169     <div class="memproto">
170     <table class="memname">
171     <tr>
172     <td class="memname">float LTQualCut::GetLT </td>
173     <td>(</td>
174     <td class="paramname"> </td>
175     <td>&nbsp;)&nbsp;</td>
176     <td><code> [inline]</code></td>
177     </tr>
178     </table>
179     </div>
180     <div class="memdoc">
181    
182     <p>
183     Returns the live time of the last examined event.
184     <p>
185     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The live time of the last examined event in ms (-1 -&gt; first event of the run). </dd></dl>
186    
187     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00054">54</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
188    
189     <p>References <a class="el" href="LTQualCut_8h_source.html#l00058">_LT</a>.</p>
190    
191     </div>
192     </div><p>
193     <hr><h2>Member Data Documentation</h2>
194     <a class="anchor" name="c69f0d887b77b6dcd493f3e65d1cbae7"></a><!-- doxytag: member="LTQualCut::_LT" ref="c69f0d887b77b6dcd493f3e65d1cbae7" args="" -->
195     <div class="memitem">
196     <div class="memproto">
197     <table class="memname">
198     <tr>
199     <td class="memname">float <a class="el" href="classLTQualCut.html#c69f0d887b77b6dcd493f3e65d1cbae7">LTQualCut::_LT</a><code> [private]</code> </td>
200     </tr>
201     </table>
202     </div>
203     <div class="memdoc">
204    
205     <p>
206    
207     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00058">58</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
208    
209     <p>Referenced by <a class="el" href="LTQualCut_8cpp_source.html#l00012">Check()</a>, and <a class="el" href="LTQualCut_8h_source.html#l00054">GetLT()</a>.</p>
210    
211     </div>
212     </div><p>
213     <a class="anchor" name="14f95efcc2ab0b4746fd8507cbc76c32"></a><!-- doxytag: member="LTQualCut::_previousRun" ref="14f95efcc2ab0b4746fd8507cbc76c32" args="" -->
214     <div class="memitem">
215     <div class="memproto">
216     <table class="memname">
217     <tr>
218     <td class="memname">unsigned int <a class="el" href="classLTQualCut.html#14f95efcc2ab0b4746fd8507cbc76c32">LTQualCut::_previousRun</a><code> [private]</code> </td>
219     </tr>
220     </table>
221     </div>
222     <div class="memdoc">
223    
224     <p>
225    
226     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00057">57</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
227    
228     <p>Referenced by <a class="el" href="LTQualCut_8cpp_source.html#l00012">Check()</a>.</p>
229    
230     </div>
231     </div><p>
232     <a class="anchor" name="16d07f171dcecb0a847fe237cc290ff6"></a><!-- doxytag: member="LTQualCut::_timeout" ref="16d07f171dcecb0a847fe237cc290ff6" args="" -->
233     <div class="memitem">
234     <div class="memproto">
235     <table class="memname">
236     <tr>
237     <td class="memname">float <a class="el" href="classLTQualCut.html#16d07f171dcecb0a847fe237cc290ff6">LTQualCut::_timeout</a><code> [private]</code> </td>
238     </tr>
239     </table>
240     </div>
241     <div class="memdoc">
242    
243     <p>
244    
245     <p>Definition at line <a class="el" href="LTQualCut_8h_source.html#l00059">59</a> of file <a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a>.</p>
246    
247     <p>Referenced by <a class="el" href="LTQualCut_8cpp_source.html#l00012">Check()</a>.</p>
248    
249     </div>
250     </div><p>
251     <hr>The documentation for this class was generated from the following files:<ul>
252     <li>MiscCuts/LTQualCut/<a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a><li>MiscCuts/LTQualCut/<a class="el" href="LTQualCut_8cpp_source.html">LTQualCut.cpp</a></ul>
253     </div>
254     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:39 2009 for PamCut by&nbsp;
255     <a href="http://www.doxygen.org/index.html">
256     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
257     </body>
258     </html>
  ViewVC Help
Powered by ViewVC 1.1.23