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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:05 2009 UTC (16 years, 4 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: TrkRigRangeCut 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>TrkRigRangeCut Class Reference</h1><!-- doxytag: class="TrkRigRangeCut" --><!-- doxytag: inherits="PamCut" -->The rigidity range cut. This cut discards all the events whose rigidity is less than the minimum threshold or greater than the maximum threshold. Here rigidity is defined as p/Z (GV) where Z is the particle charge (WITH SIGN) and p the momentum modulus: therefore rigidity can be positive or negative.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for TrkRigRangeCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classTrkRigRangeCut.png" usemap="#TrkRigRangeCut_map" border="0" alt=""></center>
35     <map name="TrkRigRangeCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,103,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classTrkRigRangeCut-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="classTrkRigRangeCut.html#b00a7225e40d22cdcb3f33056cc731c1">TrkRigRangeCut</a> (const char *cutName, float minRigidity, float maxRigidity)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#b00a7225e40d22cdcb3f33056cc731c1"></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="classTrkRigRangeCut.html#86792521a0fe0c65c00aa02645990e75">~TrkRigRangeCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#86792521a0fe0c65c00aa02645990e75"></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="classTrkRigRangeCut.html#ebebf52705ab17ef48ab12ec6d599c37">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The rigidity check. <a href="#ebebf52705ab17ef48ab12ec6d599c37"></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="classTrkRigRangeCut.html#25d0d2c960e4c9ba0c2c705a8a32aca6">_minRigidity</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="classTrkRigRangeCut.html#5e38ee633a9972a050d2c34a5aaba223">_maxRigidity</a></td></tr>
57    
58     </table>
59     <hr><a name="_details"></a><h2>Detailed Description</h2>
60     The rigidity range cut. This cut discards all the events whose rigidity is less than the minimum threshold or greater than the maximum threshold. Here rigidity is defined as p/Z (GV) where Z is the particle charge (WITH SIGN) and p the momentum modulus: therefore rigidity can be positive or negative.
61     <p>Definition at line <a class="el" href="TrkRigRangeCut_8h_source.html#l00019">19</a> of file <a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a>.</p>
62     <hr><h2>Constructor &amp; Destructor Documentation</h2>
63     <a class="anchor" name="b00a7225e40d22cdcb3f33056cc731c1"></a><!-- doxytag: member="TrkRigRangeCut::TrkRigRangeCut" ref="b00a7225e40d22cdcb3f33056cc731c1" args="(const char *cutName, float minRigidity, float maxRigidity)" -->
64     <div class="memitem">
65     <div class="memproto">
66     <table class="memname">
67     <tr>
68     <td class="memname">TrkRigRangeCut::TrkRigRangeCut </td>
69     <td>(</td>
70     <td class="paramtype">const char *&nbsp;</td>
71     <td class="paramname"> <em>cutName</em>, </td>
72     </tr>
73     <tr>
74     <td class="paramkey"></td>
75     <td></td>
76     <td class="paramtype">float&nbsp;</td>
77     <td class="paramname"> <em>minRigidity</em>, </td>
78     </tr>
79     <tr>
80     <td class="paramkey"></td>
81     <td></td>
82     <td class="paramtype">float&nbsp;</td>
83     <td class="paramname"> <em>maxRigidity</em></td><td>&nbsp;</td>
84     </tr>
85     <tr>
86     <td></td>
87     <td>)</td>
88     <td></td><td></td><td><code> [inline]</code></td>
89     </tr>
90     </table>
91     </div>
92     <div class="memdoc">
93    
94     <p>
95     Constructor.
96     <p>
97     <dl compact><dt><b>Parameters:</b></dt><dd>
98     <table border="0" cellspacing="2" cellpadding="0">
99     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
100     <tr><td valign="top"></td><td valign="top"><em>minRigidity</em>&nbsp;</td><td>The minimum rigidity p/Z (in GV) below which an event will be discarded. Can be positive or negative. </td></tr>
101     <tr><td valign="top"></td><td valign="top"><em>maxRigidity</em>&nbsp;</td><td>The maximum rigidity p/Z (in GV) above which an event will be discarded. Can be positive or negative. </td></tr>
102     </table>
103     </dl>
104    
105     <p>Definition at line <a class="el" href="TrkRigRangeCut_8h_source.html#l00030">30</a> of file <a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a>.</p>
106    
107     </div>
108     </div><p>
109     <a class="anchor" name="86792521a0fe0c65c00aa02645990e75"></a><!-- doxytag: member="TrkRigRangeCut::~TrkRigRangeCut" ref="86792521a0fe0c65c00aa02645990e75" args="()" -->
110     <div class="memitem">
111     <div class="memproto">
112     <table class="memname">
113     <tr>
114     <td class="memname">TrkRigRangeCut::~TrkRigRangeCut </td>
115     <td>(</td>
116     <td class="paramname"> </td>
117     <td>&nbsp;)&nbsp;</td>
118     <td><code> [inline]</code></td>
119     </tr>
120     </table>
121     </div>
122     <div class="memdoc">
123    
124     <p>
125     Destructor.
126     <p>
127    
128     <p>Definition at line <a class="el" href="TrkRigRangeCut_8h_source.html#l00034">34</a> of file <a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a>.</p>
129    
130     </div>
131     </div><p>
132     <hr><h2>Member Function Documentation</h2>
133     <a class="anchor" name="ebebf52705ab17ef48ab12ec6d599c37"></a><!-- doxytag: member="TrkRigRangeCut::Check" ref="ebebf52705ab17ef48ab12ec6d599c37" args="(PamLevel2 *event)" -->
134     <div class="memitem">
135     <div class="memproto">
136     <table class="memname">
137     <tr>
138     <td class="memname">int TrkRigRangeCut::Check </td>
139     <td>(</td>
140     <td class="paramtype">PamLevel2 *&nbsp;</td>
141     <td class="paramname"> <em>event</em> </td>
142     <td>&nbsp;)&nbsp;</td>
143     <td><code> [virtual]</code></td>
144     </tr>
145     </table>
146     </div>
147     <div class="memdoc">
148    
149     <p>
150     The rigidity check.
151     <p>
152     <dl compact><dt><b>Parameters:</b></dt><dd>
153     <table border="0" cellspacing="2" cellpadding="0">
154     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
155     </table>
156     </dl>
157     <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 is outside the range <p>
158     0 otherwise. </dd></dl>
159    
160     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
161    
162     <p>Definition at line <a class="el" href="TrkRigRangeCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="TrkRigRangeCut_8cpp_source.html">TrkRigRangeCut.cpp</a>.</p>
163    
164     <p>References <a class="el" href="TrkRigRangeCut_8h_source.html#l00048">_maxRigidity</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
165    
166     </div>
167     </div><p>
168     <hr><h2>Member Data Documentation</h2>
169     <a class="anchor" name="5e38ee633a9972a050d2c34a5aaba223"></a><!-- doxytag: member="TrkRigRangeCut::_maxRigidity" ref="5e38ee633a9972a050d2c34a5aaba223" args="" -->
170     <div class="memitem">
171     <div class="memproto">
172     <table class="memname">
173     <tr>
174     <td class="memname">float <a class="el" href="classTrkRigRangeCut.html#5e38ee633a9972a050d2c34a5aaba223">TrkRigRangeCut::_maxRigidity</a><code> [private]</code> </td>
175     </tr>
176     </table>
177     </div>
178     <div class="memdoc">
179    
180     <p>
181    
182     <p>Definition at line <a class="el" href="TrkRigRangeCut_8h_source.html#l00048">48</a> of file <a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a>.</p>
183    
184     <p>Referenced by <a class="el" href="TrkRigRangeCut_8cpp_source.html#l00012">Check()</a>.</p>
185    
186     </div>
187     </div><p>
188     <a class="anchor" name="25d0d2c960e4c9ba0c2c705a8a32aca6"></a><!-- doxytag: member="TrkRigRangeCut::_minRigidity" ref="25d0d2c960e4c9ba0c2c705a8a32aca6" args="" -->
189     <div class="memitem">
190     <div class="memproto">
191     <table class="memname">
192     <tr>
193     <td class="memname">float <a class="el" href="classTrkRigRangeCut.html#25d0d2c960e4c9ba0c2c705a8a32aca6">TrkRigRangeCut::_minRigidity</a><code> [private]</code> </td>
194     </tr>
195     </table>
196     </div>
197     <div class="memdoc">
198    
199     <p>
200    
201     <p>Definition at line <a class="el" href="TrkRigRangeCut_8h_source.html#l00047">47</a> of file <a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a>.</p>
202    
203     </div>
204     </div><p>
205     <hr>The documentation for this class was generated from the following files:<ul>
206     <li>TrkCuts/TrkRigRangeCut/<a class="el" href="TrkRigRangeCut_8h_source.html">TrkRigRangeCut.h</a><li>TrkCuts/TrkRigRangeCut/<a class="el" href="TrkRigRangeCut_8cpp_source.html">TrkRigRangeCut.cpp</a></ul>
207     </div>
208     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:54 2009 for PamCut by&nbsp;
209     <a href="http://www.doxygen.org/index.html">
210     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
211     </body>
212     </html>
  ViewVC Help
Powered by ViewVC 1.1.23