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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1.1.1 - (hide 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 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: RigFillCut 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>RigFillCut Class Reference</h1><!-- doxytag: class="RigFillCut" --><!-- doxytag: inherits="PamCut" -->The rigidity vs threshold rigidity histogram filling.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for RigFillCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classRigFillCut.png" usemap="#RigFillCut_map" border="0" alt=""></center>
35     <map name="RigFillCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,66,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classRigFillCut-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="classRigFillCut.html#db50b4fec5f11499db9039baea8a4392">RigFillCut</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="#db50b4fec5f11499db9039baea8a4392"></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="classRigFillCut.html#3e1f3f9df6e8c684060ccd76da9edaad">~RigFillCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#3e1f3f9df6e8c684060ccd76da9edaad"></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="classRigFillCut.html#5441206a7a24f1f5d19dc1a64685fcd4">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The rigidity and cutoff rigidity check. <a href="#5441206a7a24f1f5d19dc1a64685fcd4"></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="classRigFillCut.html#537f1b31f208ebe8f190f254be1fdc6c">OnGood</a> (PamLevel2 *event)</td></tr>
54    
55     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The histogram filling. <a href="#537f1b31f208ebe8f190f254be1fdc6c"></a><br></td></tr>
56     <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; UInt_t &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRigFillCut.html#532f3bb2e39f3c9da3a70e72eae8389d">GetHisto</a> ()</td></tr>
57    
58     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the histogram. <a href="#532f3bb2e39f3c9da3a70e72eae8389d"></a><br></td></tr>
59     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
60     <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="classRigFillCut.html#24c7fece1b02c4222dc2fd9d0d13bcc0">_binning</a></td></tr>
61    
62     <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt; UInt_t &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRigFillCut.html#9c0b18d019325388ab4d99cd304a5909">_histogram</a></td></tr>
63    
64     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRigFillCut.html#5634e95eb75291fd866f995a324a3a0a">_thresholdCoeff</a></td></tr>
65    
66     </table>
67     <hr><a name="_details"></a><h2>Detailed Description</h2>
68     The rigidity vs threshold rigidity histogram filling.
69     <p>
70     This class checks the events and builds a 2D histogram binned in rigidity modulus and threshold rigidity. Each 2D bin will contain the number of events whose rigidity modulus and threshold rigidity (eg., Stoermer cutoff rigidity times a threshold coefficient) lie in that bin. Note that the meaning of this threshold coefficient is the same as in <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a>, so it must have the same value used for <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> (consider using <a class="el" href="classTrkRigGeoCut.html#5b3e2d3037d140ae852bd02975842eb4" title="Returns the threshold coefficient.">TrkRigGeoCut::GetThresholdCoeff()</a> to retrieve its value). Events are discarded only if their rigidity modulus or cutoff rigidity lies outside the histogram bounds.<p>
71     CUT DEPENDECIES: <a class="el" href="classTrkPhSinCut.html" title="The single physical track cut. Only events with a single physical track (selected...">TrkPhSinCut</a> for single physical track, <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> for galactic event.
72     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00037">37</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
73     <hr><h2>Constructor &amp; Destructor Documentation</h2>
74     <a class="anchor" name="db50b4fec5f11499db9039baea8a4392"></a><!-- doxytag: member="RigFillCut::RigFillCut" ref="db50b4fec5f11499db9039baea8a4392" args="(const char *cutName, std::vector&lt; float &gt; binning, float thresholdCoeff)" -->
75     <div class="memitem">
76     <div class="memproto">
77     <table class="memname">
78     <tr>
79     <td class="memname">RigFillCut::RigFillCut </td>
80     <td>(</td>
81     <td class="paramtype">const char *&nbsp;</td>
82     <td class="paramname"> <em>cutName</em>, </td>
83     </tr>
84     <tr>
85     <td class="paramkey"></td>
86     <td></td>
87     <td class="paramtype">std::vector&lt; float &gt;&nbsp;</td>
88     <td class="paramname"> <em>binning</em>, </td>
89     </tr>
90     <tr>
91     <td class="paramkey"></td>
92     <td></td>
93     <td class="paramtype">float&nbsp;</td>
94     <td class="paramname"> <em>thresholdCoeff</em></td><td>&nbsp;</td>
95     </tr>
96     <tr>
97     <td></td>
98     <td>)</td>
99     <td></td><td></td><td><code> [inline]</code></td>
100     </tr>
101     </table>
102     </div>
103     <div class="memdoc">
104    
105     <p>
106     Constructor.
107     <p>
108     The binning vectors must contain both the upper and lower limits, and the elements must be ordered (ie., lowest value in the first element and so on) and positive, so that charge sign will be irrelevant.<p>
109     <dl compact><dt><b>Parameters:</b></dt><dd>
110     <table border="0" cellspacing="2" cellpadding="0">
111     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
112     <tr><td valign="top"></td><td valign="top"><em>binning</em>&nbsp;</td><td>A vector containing the histogram binning in rigidity modulus (X axis) and cutoff rigidity (Y axis). </td></tr>
113     <tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em>&nbsp;</td><td>The threshold rigidity coefficient for the event selection. </td></tr>
114     </table>
115     </dl>
116    
117     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00051">51</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
118    
119     </div>
120     </div><p>
121     <a class="anchor" name="3e1f3f9df6e8c684060ccd76da9edaad"></a><!-- doxytag: member="RigFillCut::~RigFillCut" ref="3e1f3f9df6e8c684060ccd76da9edaad" args="()" -->
122     <div class="memitem">
123     <div class="memproto">
124     <table class="memname">
125     <tr>
126     <td class="memname">RigFillCut::~RigFillCut </td>
127     <td>(</td>
128     <td class="paramname"> </td>
129     <td>&nbsp;)&nbsp;</td>
130     <td><code> [inline]</code></td>
131     </tr>
132     </table>
133     </div>
134     <div class="memdoc">
135    
136     <p>
137     Destructor.
138     <p>
139    
140     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00057">57</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
141    
142     </div>
143     </div><p>
144     <hr><h2>Member Function Documentation</h2>
145     <a class="anchor" name="5441206a7a24f1f5d19dc1a64685fcd4"></a><!-- doxytag: member="RigFillCut::Check" ref="5441206a7a24f1f5d19dc1a64685fcd4" args="(PamLevel2 *event)" -->
146     <div class="memitem">
147     <div class="memproto">
148     <table class="memname">
149     <tr>
150     <td class="memname">int RigFillCut::Check </td>
151     <td>(</td>
152     <td class="paramtype">PamLevel2 *&nbsp;</td>
153     <td class="paramname"> <em>event</em> </td>
154     <td>&nbsp;)&nbsp;</td>
155     <td><code> [virtual]</code></td>
156     </tr>
157     </table>
158     </div>
159     <div class="memdoc">
160    
161     <p>
162     The rigidity and cutoff rigidity check.
163     <p>
164     The event is discarded if its rigidity modulus or threshold rigidity are outside the limits of the binnings. Please note that only absolute rigidity is considered.<p>
165     <dl compact><dt><b>Parameters:</b></dt><dd>
166     <table border="0" cellspacing="2" cellpadding="0">
167     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
168     </table>
169     </dl>
170     <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 both rigidity modulus and threshold rigidity is contained in the histogram limits. <p>
171     0 otherwise. </dd></dl>
172    
173     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
174    
175     <p>Definition at line <a class="el" href="RigFillCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="RigFillCut_8cpp_source.html">RigFillCut.cpp</a>.</p>
176    
177     <p>References <a class="el" href="RigFillCut_8h_source.html#l00092">_binning</a>, <a class="el" href="RigFillCut_8h_source.html#l00094">_thresholdCoeff</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, <a class="el" href="RigFillCut_8h_source.html#l00018">RIGOUT</a>, and <a class="el" href="RigFillCut_8h_source.html#l00019">THRESHRIGOUT</a>.</p>
178    
179     </div>
180     </div><p>
181     <a class="anchor" name="532f3bb2e39f3c9da3a70e72eae8389d"></a><!-- doxytag: member="RigFillCut::GetHisto" ref="532f3bb2e39f3c9da3a70e72eae8389d" args="()" -->
182     <div class="memitem">
183     <div class="memproto">
184     <table class="memname">
185     <tr>
186     <td class="memname"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt;UInt_t&gt;&amp; RigFillCut::GetHisto </td>
187     <td>(</td>
188     <td class="paramname"> </td>
189     <td>&nbsp;)&nbsp;</td>
190     <td><code> [inline]</code></td>
191     </tr>
192     </table>
193     </div>
194     <div class="memdoc">
195    
196     <p>
197     Returns the histogram.
198     <p>
199     This method returns a <a class="el" href="classSimpleMatrix.html" title="A simple matrix class.">SimpleMatrix</a>. Its [i][j] element contain the number of analyzed events whose rigidity modulus falls in the i-th rigidity bin and whose threshold rigidity falls in the j-th rigidity bin.<p>
200     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The rigidity modulus - threshold rigidity 2D histogram </dd></dl>
201    
202     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00086">86</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
203    
204     <p>References <a class="el" href="RigFillCut_8h_source.html#l00093">_histogram</a>.</p>
205    
206     </div>
207     </div><p>
208     <a class="anchor" name="537f1b31f208ebe8f190f254be1fdc6c"></a><!-- doxytag: member="RigFillCut::OnGood" ref="537f1b31f208ebe8f190f254be1fdc6c" args="(PamLevel2 *event)" -->
209     <div class="memitem">
210     <div class="memproto">
211     <table class="memname">
212     <tr>
213     <td class="memname">void RigFillCut::OnGood </td>
214     <td>(</td>
215     <td class="paramtype">PamLevel2 *&nbsp;</td>
216     <td class="paramname"> <em>event</em> </td>
217     <td>&nbsp;)&nbsp;</td>
218     <td><code> [virtual]</code></td>
219     </tr>
220     </table>
221     </div>
222     <div class="memdoc">
223    
224     <p>
225     The histogram filling.
226     <p>
227     The method fills the histogram with the currently selected event.<p>
228     <dl compact><dt><b>Parameters:</b></dt><dd>
229     <table border="0" cellspacing="2" cellpadding="0">
230     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The currently selected event. </td></tr>
231     </table>
232     </dl>
233    
234     <p>Reimplemented from <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985">PamCut</a>.</p>
235    
236     <p>Definition at line <a class="el" href="RigFillCut_8cpp_source.html#l00029">29</a> of file <a class="el" href="RigFillCut_8cpp_source.html">RigFillCut.cpp</a>.</p>
237    
238     <p>References <a class="el" href="RigFillCut_8h_source.html#l00092">_binning</a>, <a class="el" href="RigFillCut_8h_source.html#l00093">_histogram</a>, and <a class="el" href="RigFillCut_8h_source.html#l00094">_thresholdCoeff</a>.</p>
239    
240     </div>
241     </div><p>
242     <hr><h2>Member Data Documentation</h2>
243     <a class="anchor" name="24c7fece1b02c4222dc2fd9d0d13bcc0"></a><!-- doxytag: member="RigFillCut::_binning" ref="24c7fece1b02c4222dc2fd9d0d13bcc0" args="" -->
244     <div class="memitem">
245     <div class="memproto">
246     <table class="memname">
247     <tr>
248     <td class="memname">std::vector&lt;float&gt; <a class="el" href="classRigFillCut.html#24c7fece1b02c4222dc2fd9d0d13bcc0">RigFillCut::_binning</a><code> [private]</code> </td>
249     </tr>
250     </table>
251     </div>
252     <div class="memdoc">
253    
254     <p>
255    
256     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00092">92</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
257    
258     <p>Referenced by <a class="el" href="RigFillCut_8cpp_source.html#l00012">Check()</a>, and <a class="el" href="RigFillCut_8cpp_source.html#l00029">OnGood()</a>.</p>
259    
260     </div>
261     </div><p>
262     <a class="anchor" name="9c0b18d019325388ab4d99cd304a5909"></a><!-- doxytag: member="RigFillCut::_histogram" ref="9c0b18d019325388ab4d99cd304a5909" args="" -->
263     <div class="memitem">
264     <div class="memproto">
265     <table class="memname">
266     <tr>
267     <td class="memname"><a class="el" href="classSimpleMatrix.html">SimpleMatrix</a>&lt;UInt_t&gt; <a class="el" href="classRigFillCut.html#9c0b18d019325388ab4d99cd304a5909">RigFillCut::_histogram</a><code> [private]</code> </td>
268     </tr>
269     </table>
270     </div>
271     <div class="memdoc">
272    
273     <p>
274    
275     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00093">93</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
276    
277     <p>Referenced by <a class="el" href="RigFillCut_8h_source.html#l00086">GetHisto()</a>, and <a class="el" href="RigFillCut_8cpp_source.html#l00029">OnGood()</a>.</p>
278    
279     </div>
280     </div><p>
281     <a class="anchor" name="5634e95eb75291fd866f995a324a3a0a"></a><!-- doxytag: member="RigFillCut::_thresholdCoeff" ref="5634e95eb75291fd866f995a324a3a0a" args="" -->
282     <div class="memitem">
283     <div class="memproto">
284     <table class="memname">
285     <tr>
286     <td class="memname">float <a class="el" href="classRigFillCut.html#5634e95eb75291fd866f995a324a3a0a">RigFillCut::_thresholdCoeff</a><code> [private]</code> </td>
287     </tr>
288     </table>
289     </div>
290     <div class="memdoc">
291    
292     <p>
293    
294     <p>Definition at line <a class="el" href="RigFillCut_8h_source.html#l00094">94</a> of file <a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a>.</p>
295    
296     <p>Referenced by <a class="el" href="RigFillCut_8cpp_source.html#l00012">Check()</a>, and <a class="el" href="RigFillCut_8cpp_source.html#l00029">OnGood()</a>.</p>
297    
298     </div>
299     </div><p>
300     <hr>The documentation for this class was generated from the following files:<ul>
301     <li>TrkCuts/RigFillCut/<a class="el" href="RigFillCut_8h_source.html">RigFillCut.h</a><li>TrkCuts/RigFillCut/<a class="el" href="RigFillCut_8cpp_source.html">RigFillCut.cpp</a></ul>
302     </div>
303     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:42 2009 for PamCut by&nbsp;
304     <a href="http://www.doxygen.org/index.html">
305     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
306     </body>
307     </html>
  ViewVC Help
Powered by ViewVC 1.1.23