/[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.3 - (hide annotations) (download) (as text)
Fri Sep 25 15:41:36 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 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 pam-fi 1.2 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0c834239f22298ce5684b5c27c34c608"></a><!-- doxytag: member="LTGeoFillCut::~LTGeoFillCut" ref="0c834239f22298ce5684b5c27c34c608" args="()" -->
48     &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classLTGeoFillCut.html#0c834239f22298ce5684b5c27c34c608">~LTGeoFillCut</a> ()</td></tr>
49 pam-fi 1.1
50 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51 pam-fi 1.1 <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>
52    
53     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The threshold rigidity check. <a href="#aee811750d195e71f676db5e240e7f18"></a><br></td></tr>
54     <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>
55    
56     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The histogram filling. <a href="#17593f86005dd51a09a637232797c925"></a><br></td></tr>
57     <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>
58    
59     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the histogram. <a href="#bf8cddcb826ee9d3f5f763bee0e7c1ee"></a><br></td></tr>
60     <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>
61    
62     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the histogram total. <a href="#b055ce6da2265ba3475d77d80cd99247"></a><br></td></tr>
63     </table>
64     <hr><a name="_details"></a><h2>Detailed Description</h2>
65     The LT histogram filling.
66     <p>
67 pam-fi 1.2 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. <hr><h2>Constructor &amp; Destructor Documentation</h2>
68 pam-fi 1.1 <a class="anchor" name="7711d90396f7c655aa4f1fee9c93f381"></a><!-- doxytag: member="LTGeoFillCut::LTGeoFillCut" ref="7711d90396f7c655aa4f1fee9c93f381" args="(const char *cutName, std::vector&lt; float &gt; binning, float thresholdCoeff)" -->
69     <div class="memitem">
70     <div class="memproto">
71     <table class="memname">
72     <tr>
73     <td class="memname">LTGeoFillCut::LTGeoFillCut </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">std::vector&lt; float &gt;&nbsp;</td>
82     <td class="paramname"> <em>binning</em>, </td>
83     </tr>
84     <tr>
85     <td class="paramkey"></td>
86     <td></td>
87     <td class="paramtype">float&nbsp;</td>
88     <td class="paramname"> <em>thresholdCoeff</em></td><td>&nbsp;</td>
89     </tr>
90     <tr>
91     <td></td>
92     <td>)</td>
93     <td></td><td></td><td><code> [inline]</code></td>
94     </tr>
95     </table>
96     </div>
97     <div class="memdoc">
98    
99     <p>
100     Constructor.
101     <p>
102     <dl compact><dt><b>Parameters:</b></dt><dd>
103     <table border="0" cellspacing="2" cellpadding="0">
104     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
105     <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>
106     <tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em>&nbsp;</td><td>The threshold rigidity coefficient for the event selection. </td></tr>
107     </table>
108     </dl>
109    
110     </div>
111     </div><p>
112     <hr><h2>Member Function Documentation</h2>
113     <a class="anchor" name="aee811750d195e71f676db5e240e7f18"></a><!-- doxytag: member="LTGeoFillCut::Check" ref="aee811750d195e71f676db5e240e7f18" args="(PamLevel2 *event)" -->
114     <div class="memitem">
115     <div class="memproto">
116     <table class="memname">
117     <tr>
118     <td class="memname">int LTGeoFillCut::Check </td>
119     <td>(</td>
120     <td class="paramtype">PamLevel2 *&nbsp;</td>
121     <td class="paramname"> <em>event</em> </td>
122     <td>&nbsp;)&nbsp;</td>
123     <td><code> [virtual]</code></td>
124     </tr>
125     </table>
126     </div>
127     <div class="memdoc">
128    
129     <p>
130     The threshold rigidity check.
131     <p>
132     The event is discarded if its threshold rigidity is less than the lower histogram limit or higher than the upper limit.<p>
133     <dl compact><dt><b>Parameters:</b></dt><dd>
134     <table border="0" cellspacing="2" cellpadding="0">
135     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
136     </table>
137     </dl>
138     <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>
139     0 otherwise. </dd></dl>
140    
141     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
142    
143     </div>
144     </div><p>
145     <a class="anchor" name="bf8cddcb826ee9d3f5f763bee0e7c1ee"></a><!-- doxytag: member="LTGeoFillCut::GetHisto" ref="bf8cddcb826ee9d3f5f763bee0e7c1ee" args="()" -->
146     <div class="memitem">
147     <div class="memproto">
148     <table class="memname">
149     <tr>
150     <td class="memname">std::vector&lt;float&gt;&amp; LTGeoFillCut::GetHisto </td>
151     <td>(</td>
152     <td class="paramname"> </td>
153     <td>&nbsp;)&nbsp;</td>
154     <td><code> [inline]</code></td>
155     </tr>
156     </table>
157     </div>
158     <div class="memdoc">
159    
160     <p>
161     Returns the histogram.
162     <p>
163     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>
164     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The LT histogram binned in threshold rigidity. </dd></dl>
165    
166     </div>
167     </div><p>
168     <a class="anchor" name="b055ce6da2265ba3475d77d80cd99247"></a><!-- doxytag: member="LTGeoFillCut::GetHistoTot" ref="b055ce6da2265ba3475d77d80cd99247" args="()" -->
169     <div class="memitem">
170     <div class="memproto">
171     <table class="memname">
172     <tr>
173     <td class="memname">float LTGeoFillCut::GetHistoTot </td>
174     <td>(</td>
175     <td class="paramname"> </td>
176     <td>&nbsp;)&nbsp;</td>
177     <td><code> [inline]</code></td>
178     </tr>
179     </table>
180     </div>
181     <div class="memdoc">
182    
183     <p>
184     Returns the histogram total.
185     <p>
186     This method returns the LT (in seconds) summed over all threshold rigidity bins (in GV) defined in the binning argument of the constructor.<p>
187     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The LT histogram total. </dd></dl>
188    
189     </div>
190     </div><p>
191     <a class="anchor" name="17593f86005dd51a09a637232797c925"></a><!-- doxytag: member="LTGeoFillCut::OnGood" ref="17593f86005dd51a09a637232797c925" args="(PamLevel2 *event)" -->
192     <div class="memitem">
193     <div class="memproto">
194     <table class="memname">
195     <tr>
196     <td class="memname">void LTGeoFillCut::OnGood </td>
197     <td>(</td>
198     <td class="paramtype">PamLevel2 *&nbsp;</td>
199     <td class="paramname"> <em>event</em> </td>
200     <td>&nbsp;)&nbsp;</td>
201     <td><code> [virtual]</code></td>
202     </tr>
203     </table>
204     </div>
205     <div class="memdoc">
206    
207     <p>
208     The histogram filling.
209     <p>
210     The method fills the LT histogram (in seconds) with the currently selected event.<p>
211     <dl compact><dt><b>Parameters:</b></dt><dd>
212     <table border="0" cellspacing="2" cellpadding="0">
213     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The currently selected event. </td></tr>
214     </table>
215     </dl>
216    
217     <p>Reimplemented from <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985">PamCut</a>.</p>
218    
219     </div>
220     </div><p>
221     <hr>The documentation for this class was generated from the following files:<ul>
222 pam-fi 1.2 <li>MiscCuts/LTGeoFillCut/<a class="el" href="LTGeoFillCut_8h_source.html">LTGeoFillCut.h</a><li>MiscCuts/LTGeoFillCut/<a class="el" href="LTGeoFillCut_8cpp.html">LTGeoFillCut.cpp</a></ul>
223 pam-fi 1.1 </div>
224 pam-fi 1.2 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:03 2009 for PamCut by&nbsp;
225 pam-fi 1.1 <a href="http://www.doxygen.org/index.html">
226     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
227     </body>
228     </html>
  ViewVC Help
Powered by ViewVC 1.1.23