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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:06 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: LTGeoFillCut 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>LTGeoFillCut Class Reference</h1><!-- doxytag: class="LTGeoFillCut" --><!-- doxytag: inherits="PamCut" -->The LT histogram filling.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for LTGeoFillCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classLTGeoFillCut.png" usemap="#LTGeoFillCut_map" border="0" alt=""></center>
35     <map name="LTGeoFillCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,85,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classLTGeoFillCut-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="classLTGeoFillCut.html#7711d90396f7c655aa4f1fee9c93f381">LTGeoFillCut</a> (const char *cutName, std::vector&lt; float &gt; binning, float thresholdCoeff)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#7711d90396f7c655aa4f1fee9c93f381"></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="classLTGeoFillCut.html#0c834239f22298ce5684b5c27c34c608">~LTGeoFillCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#0c834239f22298ce5684b5c27c34c608"></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="classLTGeoFillCut.html#aee811750d195e71f676db5e240e7f18">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The threshold rigidity check. <a href="#aee811750d195e71f676db5e240e7f18"></a><br></td></tr>
53     <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#17593f86005dd51a09a637232797c925">OnGood</a> (PamLevel2 *event)</td></tr>
54    
55     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The histogram filling. <a href="#17593f86005dd51a09a637232797c925"></a><br></td></tr>
56     <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; float &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#bf8cddcb826ee9d3f5f763bee0e7c1ee">GetHisto</a> ()</td></tr>
57    
58     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the histogram. <a href="#bf8cddcb826ee9d3f5f763bee0e7c1ee"></a><br></td></tr>
59     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#b055ce6da2265ba3475d77d80cd99247">GetHistoTot</a> ()</td></tr>
60    
61     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the histogram total. <a href="#b055ce6da2265ba3475d77d80cd99247"></a><br></td></tr>
62     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
63     <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#b9e538c8bad153b06275b6a0fe64aab1">_binning</a></td></tr>
64    
65     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#e9aa4e0dfa6c9c0cf5e3a46162c8f2fd">_thresholdCoeff</a></td></tr>
66    
67     <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; float &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#6195a436e7c264565b15c012209dc1d1">_histogram</a></td></tr>
68    
69     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#06f64c9f800563e5ad9c68cac87e302b">_histogram_tot</a></td></tr>
70    
71     </table>
72     <hr><a name="_details"></a><h2>Detailed Description</h2>
73     The LT histogram filling.
74     <p>
75     This cut fills a Live Time (LT) histogram (in seconds) binned in threshold rigidity (in GV), given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient. It discards an event only if its threshold rigidity is outside the limits of the histogram.
76     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00024">24</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
77     <hr><h2>Constructor &amp; Destructor Documentation</h2>
78     <a class="anchor" name="7711d90396f7c655aa4f1fee9c93f381"></a><!-- doxytag: member="LTGeoFillCut::LTGeoFillCut" ref="7711d90396f7c655aa4f1fee9c93f381" args="(const char *cutName, std::vector&lt; float &gt; binning, float thresholdCoeff)" -->
79     <div class="memitem">
80     <div class="memproto">
81     <table class="memname">
82     <tr>
83     <td class="memname">LTGeoFillCut::LTGeoFillCut </td>
84     <td>(</td>
85     <td class="paramtype">const char *&nbsp;</td>
86     <td class="paramname"> <em>cutName</em>, </td>
87     </tr>
88     <tr>
89     <td class="paramkey"></td>
90     <td></td>
91     <td class="paramtype">std::vector&lt; float &gt;&nbsp;</td>
92     <td class="paramname"> <em>binning</em>, </td>
93     </tr>
94     <tr>
95     <td class="paramkey"></td>
96     <td></td>
97     <td class="paramtype">float&nbsp;</td>
98     <td class="paramname"> <em>thresholdCoeff</em></td><td>&nbsp;</td>
99     </tr>
100     <tr>
101     <td></td>
102     <td>)</td>
103     <td></td><td></td><td><code> [inline]</code></td>
104     </tr>
105     </table>
106     </div>
107     <div class="memdoc">
108    
109     <p>
110     Constructor.
111     <p>
112     <dl compact><dt><b>Parameters:</b></dt><dd>
113     <table border="0" cellspacing="2" cellpadding="0">
114     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
115     <tr><td valign="top"></td><td valign="top"><em>binning</em>&nbsp;</td><td>A vector containing the histogram binning in threshold rigidity. Note that it must contain both the upper and lower limits, and that the elements must be ordered (ie., lowest value in the first element and so on). </td></tr>
116     <tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em>&nbsp;</td><td>The threshold rigidity coefficient for the event selection. </td></tr>
117     </table>
118     </dl>
119    
120     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00036">36</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
121    
122     </div>
123     </div><p>
124     <a class="anchor" name="0c834239f22298ce5684b5c27c34c608"></a><!-- doxytag: member="LTGeoFillCut::~LTGeoFillCut" ref="0c834239f22298ce5684b5c27c34c608" args="()" -->
125     <div class="memitem">
126     <div class="memproto">
127     <table class="memname">
128     <tr>
129     <td class="memname">LTGeoFillCut::~LTGeoFillCut </td>
130     <td>(</td>
131     <td class="paramname"> </td>
132     <td>&nbsp;)&nbsp;</td>
133     <td><code> [inline]</code></td>
134     </tr>
135     </table>
136     </div>
137     <div class="memdoc">
138    
139     <p>
140     Destructor.
141     <p>
142    
143     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00041">41</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
144    
145     </div>
146     </div><p>
147     <hr><h2>Member Function Documentation</h2>
148     <a class="anchor" name="aee811750d195e71f676db5e240e7f18"></a><!-- doxytag: member="LTGeoFillCut::Check" ref="aee811750d195e71f676db5e240e7f18" args="(PamLevel2 *event)" -->
149     <div class="memitem">
150     <div class="memproto">
151     <table class="memname">
152     <tr>
153     <td class="memname">int LTGeoFillCut::Check </td>
154     <td>(</td>
155     <td class="paramtype">PamLevel2 *&nbsp;</td>
156     <td class="paramname"> <em>event</em> </td>
157     <td>&nbsp;)&nbsp;</td>
158     <td><code> [virtual]</code></td>
159     </tr>
160     </table>
161     </div>
162     <div class="memdoc">
163    
164     <p>
165     The threshold rigidity check.
166     <p>
167     The event is discarded if its threshold rigidity is less than the lower histogram limit or higher than the upper limit.<p>
168     <dl compact><dt><b>Parameters:</b></dt><dd>
169     <table border="0" cellspacing="2" cellpadding="0">
170     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
171     </table>
172     </dl>
173     <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 the threshold rigidity is contained in the histogram limits. <p>
174     0 otherwise. </dd></dl>
175    
176     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
177    
178     <p>Definition at line <a class="el" href="LTGeoFillCut_8cpp_source.html#l00013">13</a> of file <a class="el" href="LTGeoFillCut_8cpp_source.html">LTGeoFillCut.cpp</a>.</p>
179    
180     <p>References <a class="el" href="LTGeoFillCut_8h_source.html#l00088">_binning</a>, <a class="el" href="LTGeoFillCut_8h_source.html#l00089">_thresholdCoeff</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
181    
182     </div>
183     </div><p>
184     <a class="anchor" name="bf8cddcb826ee9d3f5f763bee0e7c1ee"></a><!-- doxytag: member="LTGeoFillCut::GetHisto" ref="bf8cddcb826ee9d3f5f763bee0e7c1ee" args="()" -->
185     <div class="memitem">
186     <div class="memproto">
187     <table class="memname">
188     <tr>
189     <td class="memname">std::vector&lt;float&gt;&amp; LTGeoFillCut::GetHisto </td>
190     <td>(</td>
191     <td class="paramname"> </td>
192     <td>&nbsp;)&nbsp;</td>
193     <td><code> [inline]</code></td>
194     </tr>
195     </table>
196     </div>
197     <div class="memdoc">
198    
199     <p>
200     Returns the histogram.
201     <p>
202     This method returns a vector filled with the LT (in seconds) corresponding to each threshold rigidity bin (in GV) defined in the binning argument of the constructor. Element 0 is the total LT for events whose threshold rigidity lies in the lowest bin and so on.<p>
203     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The LT histogram binned in threshold rigidity. </dd></dl>
204    
205     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00072">72</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
206    
207     <p>References <a class="el" href="LTGeoFillCut_8h_source.html#l00091">_histogram</a>.</p>
208    
209     </div>
210     </div><p>
211     <a class="anchor" name="b055ce6da2265ba3475d77d80cd99247"></a><!-- doxytag: member="LTGeoFillCut::GetHistoTot" ref="b055ce6da2265ba3475d77d80cd99247" args="()" -->
212     <div class="memitem">
213     <div class="memproto">
214     <table class="memname">
215     <tr>
216     <td class="memname">float LTGeoFillCut::GetHistoTot </td>
217     <td>(</td>
218     <td class="paramname"> </td>
219     <td>&nbsp;)&nbsp;</td>
220     <td><code> [inline]</code></td>
221     </tr>
222     </table>
223     </div>
224     <div class="memdoc">
225    
226     <p>
227     Returns the histogram total.
228     <p>
229     This method returns the LT (in seconds) summed over all threshold rigidity bins (in GV) defined in the binning argument of the constructor.<p>
230     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The LT histogram total. </dd></dl>
231    
232     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00082">82</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
233    
234     <p>References <a class="el" href="LTGeoFillCut_8h_source.html#l00092">_histogram_tot</a>.</p>
235    
236     </div>
237     </div><p>
238     <a class="anchor" name="17593f86005dd51a09a637232797c925"></a><!-- doxytag: member="LTGeoFillCut::OnGood" ref="17593f86005dd51a09a637232797c925" args="(PamLevel2 *event)" -->
239     <div class="memitem">
240     <div class="memproto">
241     <table class="memname">
242     <tr>
243     <td class="memname">void LTGeoFillCut::OnGood </td>
244     <td>(</td>
245     <td class="paramtype">PamLevel2 *&nbsp;</td>
246     <td class="paramname"> <em>event</em> </td>
247     <td>&nbsp;)&nbsp;</td>
248     <td><code> [virtual]</code></td>
249     </tr>
250     </table>
251     </div>
252     <div class="memdoc">
253    
254     <p>
255     The histogram filling.
256     <p>
257     The method fills the LT histogram (in seconds) with the currently selected event.<p>
258     <dl compact><dt><b>Parameters:</b></dt><dd>
259     <table border="0" cellspacing="2" cellpadding="0">
260     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The currently selected event. </td></tr>
261     </table>
262     </dl>
263    
264     <p>Reimplemented from <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985">PamCut</a>.</p>
265    
266     <p>Definition at line <a class="el" href="LTGeoFillCut_8cpp_source.html#l00026">26</a> of file <a class="el" href="LTGeoFillCut_8cpp_source.html">LTGeoFillCut.cpp</a>.</p>
267    
268     <p>References <a class="el" href="LTGeoFillCut_8h_source.html#l00088">_binning</a>, <a class="el" href="LTGeoFillCut_8h_source.html#l00091">_histogram</a>, <a class="el" href="LTGeoFillCut_8h_source.html#l00092">_histogram_tot</a>, and <a class="el" href="LTGeoFillCut_8h_source.html#l00089">_thresholdCoeff</a>.</p>
269    
270     </div>
271     </div><p>
272     <hr><h2>Member Data Documentation</h2>
273     <a class="anchor" name="b9e538c8bad153b06275b6a0fe64aab1"></a><!-- doxytag: member="LTGeoFillCut::_binning" ref="b9e538c8bad153b06275b6a0fe64aab1" args="" -->
274     <div class="memitem">
275     <div class="memproto">
276     <table class="memname">
277     <tr>
278     <td class="memname">std::vector&lt;float&gt; <a class="el" href="classLTGeoFillCut.html#b9e538c8bad153b06275b6a0fe64aab1">LTGeoFillCut::_binning</a><code> [private]</code> </td>
279     </tr>
280     </table>
281     </div>
282     <div class="memdoc">
283    
284     <p>
285    
286     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00088">88</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
287    
288     <p>Referenced by <a class="el" href="LTGeoFillCut_8cpp_source.html#l00013">Check()</a>, and <a class="el" href="LTGeoFillCut_8cpp_source.html#l00026">OnGood()</a>.</p>
289    
290     </div>
291     </div><p>
292     <a class="anchor" name="6195a436e7c264565b15c012209dc1d1"></a><!-- doxytag: member="LTGeoFillCut::_histogram" ref="6195a436e7c264565b15c012209dc1d1" args="" -->
293     <div class="memitem">
294     <div class="memproto">
295     <table class="memname">
296     <tr>
297     <td class="memname">std::vector&lt;float&gt; <a class="el" href="classLTGeoFillCut.html#6195a436e7c264565b15c012209dc1d1">LTGeoFillCut::_histogram</a><code> [private]</code> </td>
298     </tr>
299     </table>
300     </div>
301     <div class="memdoc">
302    
303     <p>
304    
305     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00091">91</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
306    
307     <p>Referenced by <a class="el" href="LTGeoFillCut_8h_source.html#l00072">GetHisto()</a>, and <a class="el" href="LTGeoFillCut_8cpp_source.html#l00026">OnGood()</a>.</p>
308    
309     </div>
310     </div><p>
311     <a class="anchor" name="06f64c9f800563e5ad9c68cac87e302b"></a><!-- doxytag: member="LTGeoFillCut::_histogram_tot" ref="06f64c9f800563e5ad9c68cac87e302b" args="" -->
312     <div class="memitem">
313     <div class="memproto">
314     <table class="memname">
315     <tr>
316     <td class="memname">float <a class="el" href="classLTGeoFillCut.html#06f64c9f800563e5ad9c68cac87e302b">LTGeoFillCut::_histogram_tot</a><code> [private]</code> </td>
317     </tr>
318     </table>
319     </div>
320     <div class="memdoc">
321    
322     <p>
323    
324     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00092">92</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
325    
326     <p>Referenced by <a class="el" href="LTGeoFillCut_8h_source.html#l00082">GetHistoTot()</a>, and <a class="el" href="LTGeoFillCut_8cpp_source.html#l00026">OnGood()</a>.</p>
327    
328     </div>
329     </div><p>
330     <a class="anchor" name="e9aa4e0dfa6c9c0cf5e3a46162c8f2fd"></a><!-- doxytag: member="LTGeoFillCut::_thresholdCoeff" ref="e9aa4e0dfa6c9c0cf5e3a46162c8f2fd" args="" -->
331     <div class="memitem">
332     <div class="memproto">
333     <table class="memname">
334     <tr>
335     <td class="memname">float <a class="el" href="classLTGeoFillCut.html#e9aa4e0dfa6c9c0cf5e3a46162c8f2fd">LTGeoFillCut::_thresholdCoeff</a><code> [private]</code> </td>
336     </tr>
337     </table>
338     </div>
339     <div class="memdoc">
340    
341     <p>
342    
343     <p>Definition at line <a class="el" href="LTGeoFillCut_8h_source.html#l00089">89</a> of file <a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a>.</p>
344    
345     <p>Referenced by <a class="el" href="LTGeoFillCut_8cpp_source.html#l00013">Check()</a>, and <a class="el" href="LTGeoFillCut_8cpp_source.html#l00026">OnGood()</a>.</p>
346    
347     </div>
348     </div><p>
349     <hr>The documentation for this class was generated from the following files:<ul>
350     <li>MiscCuts/LTGeoFillCut/<a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a><li>MiscCuts/LTGeoFillCut/<a class="el" href="LTGeoFillCut_8cpp_source.html">LTGeoFillCut.cpp</a></ul>
351     </div>
352     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:39 2009 for PamCut by&nbsp;
353     <a href="http://www.doxygen.org/index.html">
354     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
355     </body>
356     </html>
  ViewVC Help
Powered by ViewVC 1.1.23