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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations) (download) (as text)
Fri Sep 25 15:41:49 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: text/html
FILE REMOVED
Removed from repository.

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"><a class="anchor" name="4c7b3319c00ecad7e55b90539b524c53"></a><!-- doxytag: member="LTQualCut::~LTQualCut" ref="4c7b3319c00ecad7e55b90539b524c53" args="()" -->
48 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTQualCut.html#4c7b3319c00ecad7e55b90539b524c53">~LTQualCut</a> ()</td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51 <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>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The live time quality check. <a href="#b38dc0bd6b25f899753b4598c278e6a2"></a><br></td></tr>
54 <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>
55
56 <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>
57 </table>
58 <hr><a name="_details"></a><h2>Detailed Description</h2>
59 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). <hr><h2>Constructor &amp; Destructor Documentation</h2>
60 <a class="anchor" name="c358da9eb502cfe964b682e89e34b5ca"></a><!-- doxytag: member="LTQualCut::LTQualCut" ref="c358da9eb502cfe964b682e89e34b5ca" args="(const char *cutName, float threshold=4500)" -->
61 <div class="memitem">
62 <div class="memproto">
63 <table class="memname">
64 <tr>
65 <td class="memname">LTQualCut::LTQualCut </td>
66 <td>(</td>
67 <td class="paramtype">const char *&nbsp;</td>
68 <td class="paramname"> <em>cutName</em>, </td>
69 </tr>
70 <tr>
71 <td class="paramkey"></td>
72 <td></td>
73 <td class="paramtype">float&nbsp;</td>
74 <td class="paramname"> <em>threshold</em> = <code>4500</code></td><td>&nbsp;</td>
75 </tr>
76 <tr>
77 <td></td>
78 <td>)</td>
79 <td></td><td></td><td><code> [inline]</code></td>
80 </tr>
81 </table>
82 </div>
83 <div class="memdoc">
84
85 <p>
86 Constructor.
87 <p>
88 <dl compact><dt><b>Parameters:</b></dt><dd>
89 <table border="0" cellspacing="2" cellpadding="0">
90 <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
91 <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>
92 </table>
93 </dl>
94
95 </div>
96 </div><p>
97 <hr><h2>Member Function Documentation</h2>
98 <a class="anchor" name="b38dc0bd6b25f899753b4598c278e6a2"></a><!-- doxytag: member="LTQualCut::Check" ref="b38dc0bd6b25f899753b4598c278e6a2" args="(PamLevel2 *event)" -->
99 <div class="memitem">
100 <div class="memproto">
101 <table class="memname">
102 <tr>
103 <td class="memname">int LTQualCut::Check </td>
104 <td>(</td>
105 <td class="paramtype">PamLevel2 *&nbsp;</td>
106 <td class="paramname"> <em>event</em> </td>
107 <td>&nbsp;)&nbsp;</td>
108 <td><code> [virtual]</code></td>
109 </tr>
110 </table>
111 </div>
112 <div class="memdoc">
113
114 <p>
115 The live time quality check.
116 <p>
117 <dl compact><dt><b>Parameters:</b></dt><dd>
118 <table border="0" cellspacing="2" cellpadding="0">
119 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
120 </table>
121 </dl>
122 <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>
123 <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>
124 <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>
125
126 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
127
128 </div>
129 </div><p>
130 <a class="anchor" name="fe8fd76dbc23d11dfa24f2468f78d3d8"></a><!-- doxytag: member="LTQualCut::GetLT" ref="fe8fd76dbc23d11dfa24f2468f78d3d8" args="()" -->
131 <div class="memitem">
132 <div class="memproto">
133 <table class="memname">
134 <tr>
135 <td class="memname">float LTQualCut::GetLT </td>
136 <td>(</td>
137 <td class="paramname"> </td>
138 <td>&nbsp;)&nbsp;</td>
139 <td><code> [inline]</code></td>
140 </tr>
141 </table>
142 </div>
143 <div class="memdoc">
144
145 <p>
146 Returns the live time of the last examined event.
147 <p>
148 <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>
149
150 </div>
151 </div><p>
152 <hr>The documentation for this class was generated from the following files:<ul>
153 <li>MiscCuts/LTQualCut/<a class="el" href="LTQualCut_8h_source.html">LTQualCut.h</a><li>MiscCuts/LTQualCut/<a class="el" href="LTQualCut_8cpp.html">LTQualCut.cpp</a></ul>
154 </div>
155 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:03 2009 for PamCut by&nbsp;
156 <a href="http://www.doxygen.org/index.html">
157 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
158 </body>
159 </html>

  ViewVC Help
Powered by ViewVC 1.1.23