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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (show annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:07 2009 UTC (15 years, 10 months ago) by pam-fi
Branch: DEV
CVS Tags: v0r00
Changes since 1.1: +0 -0 lines
File MIME type: text/html
First import

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: EvRateS11Cut 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>EvRateS11Cut Class Reference</h1><!-- doxytag: class="EvRateS11Cut" --><!-- doxytag: inherits="PamCut" -->Cut on event rate on S11.
26 <a href="#_details">More...</a>
27 <p>
28 <code>#include &lt;<a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a>&gt;</code>
29 <p>
30 <div class="dynheader">
31 Inheritance diagram for EvRateS11Cut:</div>
32 <div class="dynsection">
33
34 <p><center><img src="classEvRateS11Cut.png" usemap="#EvRateS11Cut_map" border="0" alt=""></center>
35 <map name="EvRateS11Cut_map">
36 <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,93,24">
37 </map>
38 </div>
39
40 <p>
41 <a href="classEvRateS11Cut-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="classEvRateS11Cut.html#abfeba82d3f8f0bbf29b253c17324aba">EvRateS11Cut</a> (const char *cutName, float maxRate=1e06, float minRate=0.)</td></tr>
45
46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#abfeba82d3f8f0bbf29b253c17324aba"></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="classEvRateS11Cut.html#19077ac390563b97bb7325e6f9ea783a">~EvRateS11Cut</a> ()</td></tr>
48
49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#19077ac390563b97bb7325e6f9ea783a"></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="classEvRateS11Cut.html#196fc98a75f1acc3ddef7dc86b5150a1">Check</a> (PamLevel2 *event)</td></tr>
51
52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The event rate check. <a href="#196fc98a75f1acc3ddef7dc86b5150a1"></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">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEvRateS11Cut.html#2d4e7bebcf80321a3185154e97546a4b">_maxRate</a></td></tr>
55
56 <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classEvRateS11Cut.html#4cbb71886d25c15196357c4de5e3a5d4">_minRate</a></td></tr>
57
58 </table>
59 <hr><a name="_details"></a><h2>Detailed Description</h2>
60 Cut on event rate on S11.
61 <p>
62 This cut discards those events recorded when the event rate on S11 was outside a certain range.
63 <p>Definition at line <a class="el" href="EvRateS11Cut_8h_source.html#l00020">20</a> of file <a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a>.</p>
64 <hr><h2>Constructor &amp; Destructor Documentation</h2>
65 <a class="anchor" name="abfeba82d3f8f0bbf29b253c17324aba"></a><!-- doxytag: member="EvRateS11Cut::EvRateS11Cut" ref="abfeba82d3f8f0bbf29b253c17324aba" args="(const char *cutName, float maxRate=1e06, float minRate=0.)" -->
66 <div class="memitem">
67 <div class="memproto">
68 <table class="memname">
69 <tr>
70 <td class="memname">EvRateS11Cut::EvRateS11Cut </td>
71 <td>(</td>
72 <td class="paramtype">const char *&nbsp;</td>
73 <td class="paramname"> <em>cutName</em>, </td>
74 </tr>
75 <tr>
76 <td class="paramkey"></td>
77 <td></td>
78 <td class="paramtype">float&nbsp;</td>
79 <td class="paramname"> <em>maxRate</em> = <code>1e06</code>, </td>
80 </tr>
81 <tr>
82 <td class="paramkey"></td>
83 <td></td>
84 <td class="paramtype">float&nbsp;</td>
85 <td class="paramname"> <em>minRate</em> = <code>0.</code></td><td>&nbsp;</td>
86 </tr>
87 <tr>
88 <td></td>
89 <td>)</td>
90 <td></td><td></td><td><code> [inline]</code></td>
91 </tr>
92 </table>
93 </div>
94 <div class="memdoc">
95
96 <p>
97 Constructor.
98 <p>
99 Default values for the rates are chosen to reject none of the events.<p>
100 <dl compact><dt><b>Parameters:</b></dt><dd>
101 <table border="0" cellspacing="2" cellpadding="0">
102 <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
103 <tr><td valign="top"></td><td valign="top"><em>maxRate</em>&nbsp;</td><td>The maximum rate. </td></tr>
104 <tr><td valign="top"></td><td valign="top"><em>minRate</em>&nbsp;</td><td>The minimum rate. </td></tr>
105 </table>
106 </dl>
107
108 <p>Definition at line <a class="el" href="EvRateS11Cut_8h_source.html#l00031">31</a> of file <a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a>.</p>
109
110 </div>
111 </div><p>
112 <a class="anchor" name="19077ac390563b97bb7325e6f9ea783a"></a><!-- doxytag: member="EvRateS11Cut::~EvRateS11Cut" ref="19077ac390563b97bb7325e6f9ea783a" args="()" -->
113 <div class="memitem">
114 <div class="memproto">
115 <table class="memname">
116 <tr>
117 <td class="memname">EvRateS11Cut::~EvRateS11Cut </td>
118 <td>(</td>
119 <td class="paramname"> </td>
120 <td>&nbsp;)&nbsp;</td>
121 <td><code> [inline]</code></td>
122 </tr>
123 </table>
124 </div>
125 <div class="memdoc">
126
127 <p>
128 Destructor.
129 <p>
130
131 <p>Definition at line <a class="el" href="EvRateS11Cut_8h_source.html#l00035">35</a> of file <a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a>.</p>
132
133 </div>
134 </div><p>
135 <hr><h2>Member Function Documentation</h2>
136 <a class="anchor" name="196fc98a75f1acc3ddef7dc86b5150a1"></a><!-- doxytag: member="EvRateS11Cut::Check" ref="196fc98a75f1acc3ddef7dc86b5150a1" args="(PamLevel2 *event)" -->
137 <div class="memitem">
138 <div class="memproto">
139 <table class="memname">
140 <tr>
141 <td class="memname">int EvRateS11Cut::Check </td>
142 <td>(</td>
143 <td class="paramtype">PamLevel2 *&nbsp;</td>
144 <td class="paramname"> <em>event</em> </td>
145 <td>&nbsp;)&nbsp;</td>
146 <td><code> [virtual]</code></td>
147 </tr>
148 </table>
149 </div>
150 <div class="memdoc">
151
152 <p>
153 The event rate check.
154 <p>
155 <dl compact><dt><b>Parameters:</b></dt><dd>
156 <table border="0" cellspacing="2" cellpadding="0">
157 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
158 </table>
159 </dl>
160 <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 event rate on S11 is between minRate and maxRate. <p>
161 0 otherwise </dd></dl>
162
163 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
164
165 <p>Definition at line <a class="el" href="EvRateS11Cut_8cpp_source.html#l00012">12</a> of file <a class="el" href="EvRateS11Cut_8cpp_source.html">EvRateS11Cut.cpp</a>.</p>
166
167 <p>References <a class="el" href="EvRateS11Cut_8h_source.html#l00047">_maxRate</a>, <a class="el" href="EvRateS11Cut_8h_source.html#l00047">_minRate</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
168
169 </div>
170 </div><p>
171 <hr><h2>Member Data Documentation</h2>
172 <a class="anchor" name="2d4e7bebcf80321a3185154e97546a4b"></a><!-- doxytag: member="EvRateS11Cut::_maxRate" ref="2d4e7bebcf80321a3185154e97546a4b" args="" -->
173 <div class="memitem">
174 <div class="memproto">
175 <table class="memname">
176 <tr>
177 <td class="memname">float <a class="el" href="classEvRateS11Cut.html#2d4e7bebcf80321a3185154e97546a4b">EvRateS11Cut::_maxRate</a><code> [private]</code> </td>
178 </tr>
179 </table>
180 </div>
181 <div class="memdoc">
182
183 <p>
184
185 <p>Definition at line <a class="el" href="EvRateS11Cut_8h_source.html#l00047">47</a> of file <a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a>.</p>
186
187 <p>Referenced by <a class="el" href="EvRateS11Cut_8cpp_source.html#l00012">Check()</a>.</p>
188
189 </div>
190 </div><p>
191 <a class="anchor" name="4cbb71886d25c15196357c4de5e3a5d4"></a><!-- doxytag: member="EvRateS11Cut::_minRate" ref="4cbb71886d25c15196357c4de5e3a5d4" args="" -->
192 <div class="memitem">
193 <div class="memproto">
194 <table class="memname">
195 <tr>
196 <td class="memname">float <a class="el" href="classEvRateS11Cut.html#4cbb71886d25c15196357c4de5e3a5d4">EvRateS11Cut::_minRate</a><code> [private]</code> </td>
197 </tr>
198 </table>
199 </div>
200 <div class="memdoc">
201
202 <p>
203
204 <p>Definition at line <a class="el" href="EvRateS11Cut_8h_source.html#l00047">47</a> of file <a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a>.</p>
205
206 <p>Referenced by <a class="el" href="EvRateS11Cut_8cpp_source.html#l00012">Check()</a>.</p>
207
208 </div>
209 </div><p>
210 <hr>The documentation for this class was generated from the following files:<ul>
211 <li>MiscCuts/EvRateS11Cut/<a class="el" href="EvRateS11Cut_8h_source.html">EvRateS11Cut.h</a><li>MiscCuts/EvRateS11Cut/<a class="el" href="EvRateS11Cut_8cpp_source.html">EvRateS11Cut.cpp</a></ul>
212 </div>
213 <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:37 2009 for PamCut by&nbsp;
214 <a href="http://www.doxygen.org/index.html">
215 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
216 </body>
217 </html>

  ViewVC Help
Powered by ViewVC 1.1.23