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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:04 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: TrkRigGeoCut 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>TrkRigGeoCut Class Reference</h1><!-- doxytag: class="TrkRigGeoCut" --><!-- doxytag: inherits="PamCut" -->The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for TrkRigGeoCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classTrkRigGeoCut.png" usemap="#TrkRigGeoCut_map" border="0" alt=""></center>
35     <map name="TrkRigGeoCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,90,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classTrkRigGeoCut-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="classTrkRigGeoCut.html#00e54e0aade802c1c44fcfde47e905d6">TrkRigGeoCut</a> (const char *cutName, float thresholdCoeff)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#00e54e0aade802c1c44fcfde47e905d6"></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="classTrkRigGeoCut.html#074e6ecf968a39447bc868a79da213c7">~TrkRigGeoCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#074e6ecf968a39447bc868a79da213c7"></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="classTrkRigGeoCut.html#d334792be6ca66d01d75bb2f86a57382">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The rigidity check. <a href="#d334792be6ca66d01d75bb2f86a57382"></a><br></td></tr>
53     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#5b3e2d3037d140ae852bd02975842eb4">GetThresholdCoeff</a> ()</td></tr>
54    
55     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the threshold coefficient. <a href="#5b3e2d3037d140ae852bd02975842eb4"></a><br></td></tr>
56     <tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
57     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classTrkRigGeoCut.html#e9361bca574d1dfefd9b3beabc7aa268">_thresholdCoeff</a></td></tr>
58    
59     </table>
60     <hr><a name="_details"></a><h2>Detailed Description</h2>
61     The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is less than a threshold rigidity, given by the geomagnetic cutoff rigidity (the Stoermer cutoff) for that event multiplied by a threshold coefficient.
62     <p>
63     CUT DEPENDENCIES: TrkPhSin (since <a class="el" href="classTrkRigGeoCut.html" title="The geomagnetic rigidity cut. This cut discards an event whose rigidity modulus is...">TrkRigGeoCut</a> assumes the existence of a single physical track)
64     <p>Definition at line <a class="el" href="TrkRigGeoCut_8h_source.html#l00023">23</a> of file <a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>.</p>
65     <hr><h2>Constructor &amp; Destructor Documentation</h2>
66     <a class="anchor" name="00e54e0aade802c1c44fcfde47e905d6"></a><!-- doxytag: member="TrkRigGeoCut::TrkRigGeoCut" ref="00e54e0aade802c1c44fcfde47e905d6" args="(const char *cutName, float thresholdCoeff)" -->
67     <div class="memitem">
68     <div class="memproto">
69     <table class="memname">
70     <tr>
71     <td class="memname">TrkRigGeoCut::TrkRigGeoCut </td>
72     <td>(</td>
73     <td class="paramtype">const char *&nbsp;</td>
74     <td class="paramname"> <em>cutName</em>, </td>
75     </tr>
76     <tr>
77     <td class="paramkey"></td>
78     <td></td>
79     <td class="paramtype">float&nbsp;</td>
80     <td class="paramname"> <em>thresholdCoeff</em></td><td>&nbsp;</td>
81     </tr>
82     <tr>
83     <td></td>
84     <td>)</td>
85     <td></td><td></td><td><code> [inline]</code></td>
86     </tr>
87     </table>
88     </div>
89     <div class="memdoc">
90    
91     <p>
92     Constructor.
93     <p>
94     <dl compact><dt><b>Parameters:</b></dt><dd>
95     <table border="0" cellspacing="2" cellpadding="0">
96     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
97     <tr><td valign="top"></td><td valign="top"><em>thresholdCoeff</em>&nbsp;</td><td>The threshold rigidity coefficient. </td></tr>
98     </table>
99     </dl>
100    
101     <p>Definition at line <a class="el" href="TrkRigGeoCut_8h_source.html#l00031">31</a> of file <a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>.</p>
102    
103     </div>
104     </div><p>
105     <a class="anchor" name="074e6ecf968a39447bc868a79da213c7"></a><!-- doxytag: member="TrkRigGeoCut::~TrkRigGeoCut" ref="074e6ecf968a39447bc868a79da213c7" args="()" -->
106     <div class="memitem">
107     <div class="memproto">
108     <table class="memname">
109     <tr>
110     <td class="memname">TrkRigGeoCut::~TrkRigGeoCut </td>
111     <td>(</td>
112     <td class="paramname"> </td>
113     <td>&nbsp;)&nbsp;</td>
114     <td><code> [inline]</code></td>
115     </tr>
116     </table>
117     </div>
118     <div class="memdoc">
119    
120     <p>
121     Destructor.
122     <p>
123    
124     <p>Definition at line <a class="el" href="TrkRigGeoCut_8h_source.html#l00035">35</a> of file <a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>.</p>
125    
126     </div>
127     </div><p>
128     <hr><h2>Member Function Documentation</h2>
129     <a class="anchor" name="d334792be6ca66d01d75bb2f86a57382"></a><!-- doxytag: member="TrkRigGeoCut::Check" ref="d334792be6ca66d01d75bb2f86a57382" args="(PamLevel2 *event)" -->
130     <div class="memitem">
131     <div class="memproto">
132     <table class="memname">
133     <tr>
134     <td class="memname">int TrkRigGeoCut::Check </td>
135     <td>(</td>
136     <td class="paramtype">PamLevel2 *&nbsp;</td>
137     <td class="paramname"> <em>event</em> </td>
138     <td>&nbsp;)&nbsp;</td>
139     <td><code> [virtual]</code></td>
140     </tr>
141     </table>
142     </div>
143     <div class="memdoc">
144    
145     <p>
146     The rigidity check.
147     <p>
148     <dl compact><dt><b>Parameters:</b></dt><dd>
149     <table border="0" cellspacing="2" cellpadding="0">
150     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
151     </table>
152     </dl>
153     <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 rigidity modulus is greater than the geomagnetic cutoff rigidity times the threshold coefficient. <p>
154     0 otherwise. </dd></dl>
155    
156     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
157    
158     <p>Definition at line <a class="el" href="TrkRigGeoCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="TrkRigGeoCut_8cpp_source.html">TrkRigGeoCut.cpp</a>.</p>
159    
160     <p>References <a class="el" href="TrkRigGeoCut_8h_source.html#l00054">_thresholdCoeff</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
161    
162     </div>
163     </div><p>
164     <a class="anchor" name="5b3e2d3037d140ae852bd02975842eb4"></a><!-- doxytag: member="TrkRigGeoCut::GetThresholdCoeff" ref="5b3e2d3037d140ae852bd02975842eb4" args="()" -->
165     <div class="memitem">
166     <div class="memproto">
167     <table class="memname">
168     <tr>
169     <td class="memname">float TrkRigGeoCut::GetThresholdCoeff </td>
170     <td>(</td>
171     <td class="paramname"> </td>
172     <td>&nbsp;)&nbsp;</td>
173     <td><code> [inline]</code></td>
174     </tr>
175     </table>
176     </div>
177     <div class="memdoc">
178    
179     <p>
180     Returns the threshold coefficient.
181     <p>
182    
183     <p>Definition at line <a class="el" href="TrkRigGeoCut_8h_source.html#l00048">48</a> of file <a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>.</p>
184    
185     <p>References <a class="el" href="TrkRigGeoCut_8h_source.html#l00054">_thresholdCoeff</a>.</p>
186    
187     </div>
188     </div><p>
189     <hr><h2>Member Data Documentation</h2>
190     <a class="anchor" name="e9361bca574d1dfefd9b3beabc7aa268"></a><!-- doxytag: member="TrkRigGeoCut::_thresholdCoeff" ref="e9361bca574d1dfefd9b3beabc7aa268" args="" -->
191     <div class="memitem">
192     <div class="memproto">
193     <table class="memname">
194     <tr>
195     <td class="memname">float <a class="el" href="classTrkRigGeoCut.html#e9361bca574d1dfefd9b3beabc7aa268">TrkRigGeoCut::_thresholdCoeff</a><code> [private]</code> </td>
196     </tr>
197     </table>
198     </div>
199     <div class="memdoc">
200    
201     <p>
202    
203     <p>Definition at line <a class="el" href="TrkRigGeoCut_8h_source.html#l00054">54</a> of file <a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a>.</p>
204    
205     <p>Referenced by <a class="el" href="TrkRigGeoCut_8cpp_source.html#l00012">Check()</a>, and <a class="el" href="TrkRigGeoCut_8h_source.html#l00048">GetThresholdCoeff()</a>.</p>
206    
207     </div>
208     </div><p>
209     <hr>The documentation for this class was generated from the following files:<ul>
210     <li>TrkCuts/TrkRigGeoCut/<a class="el" href="TrkRigGeoCut_8h_source.html">TrkRigGeoCut.h</a><li>TrkCuts/TrkRigGeoCut/<a class="el" href="TrkRigGeoCut_8cpp_source.html">TrkRigGeoCut.cpp</a></ul>
211     </div>
212     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:54 2009 for PamCut by&nbsp;
213     <a href="http://www.doxygen.org/index.html">
214     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
215     </body>
216     </html>

  ViewVC Help
Powered by ViewVC 1.1.23