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

Contents of /PamCut/doc/Doxygen/html/classTrkRigCut.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (show annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:05 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 <!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: TrkRigCut 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>TrkRigCut Class Reference</h1><!-- doxytag: class="TrkRigCut" --><!-- doxytag: inherits="PamCut" -->The rigidity cut. This cut discards all the events whose rigidity is less than the 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="TrkRigCut_8h_source.html">TrkRigCut.h</a>&gt;</code>
29 <p>
30 <div class="dynheader">
31 Inheritance diagram for TrkRigCut:</div>
32 <div class="dynsection">
33
34 <p><center><img src="classTrkRigCut.png" usemap="#TrkRigCut_map" border="0" alt=""></center>
35 <map name="TrkRigCut_map">
36 <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,67,24">
37 </map>
38 </div>
39
40 <p>
41 <a href="classTrkRigCut-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="classTrkRigCut.html#c783ce6df5436f19bce5c5dcb2338841">TrkRigCut</a> (const char *cutName, float minRigidity)</td></tr>
45
46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#c783ce6df5436f19bce5c5dcb2338841"></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="classTrkRigCut.html#deb60f04e638a15bdfafd4e3d41125b2">~TrkRigCut</a> ()</td></tr>
48
49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#deb60f04e638a15bdfafd4e3d41125b2"></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="classTrkRigCut.html#00ddc4658bff1f28065ccb91d3eb43e6">Check</a> (PamLevel2 *event)</td></tr>
51
52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The rigidity check. <a href="#00ddc4658bff1f28065ccb91d3eb43e6"></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="classTrkRigCut.html#926892b16fd69c7d69a5681c6cafd353">_minRigidity</a></td></tr>
55
56 </table>
57 <hr><a name="_details"></a><h2>Detailed Description</h2>
58 The rigidity cut. This cut discards all the events whose rigidity is less than the 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.
59 <p>Definition at line <a class="el" href="TrkRigCut_8h_source.html#l00019">19</a> of file <a class="el" href="TrkRigCut_8h_source.html">TrkRigCut.h</a>.</p>
60 <hr><h2>Constructor &amp; Destructor Documentation</h2>
61 <a class="anchor" name="c783ce6df5436f19bce5c5dcb2338841"></a><!-- doxytag: member="TrkRigCut::TrkRigCut" ref="c783ce6df5436f19bce5c5dcb2338841" args="(const char *cutName, float minRigidity)" -->
62 <div class="memitem">
63 <div class="memproto">
64 <table class="memname">
65 <tr>
66 <td class="memname">TrkRigCut::TrkRigCut </td>
67 <td>(</td>
68 <td class="paramtype">const char *&nbsp;</td>
69 <td class="paramname"> <em>cutName</em>, </td>
70 </tr>
71 <tr>
72 <td class="paramkey"></td>
73 <td></td>
74 <td class="paramtype">float&nbsp;</td>
75 <td class="paramname"> <em>minRigidity</em></td><td>&nbsp;</td>
76 </tr>
77 <tr>
78 <td></td>
79 <td>)</td>
80 <td></td><td></td><td><code> [inline]</code></td>
81 </tr>
82 </table>
83 </div>
84 <div class="memdoc">
85
86 <p>
87 Constructor.
88 <p>
89 <dl compact><dt><b>Parameters:</b></dt><dd>
90 <table border="0" cellspacing="2" cellpadding="0">
91 <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
92 <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>
93 </table>
94 </dl>
95
96 <p>Definition at line <a class="el" href="TrkRigCut_8h_source.html#l00028">28</a> of file <a class="el" href="TrkRigCut_8h_source.html">TrkRigCut.h</a>.</p>
97
98 </div>
99 </div><p>
100 <a class="anchor" name="deb60f04e638a15bdfafd4e3d41125b2"></a><!-- doxytag: member="TrkRigCut::~TrkRigCut" ref="deb60f04e638a15bdfafd4e3d41125b2" args="()" -->
101 <div class="memitem">
102 <div class="memproto">
103 <table class="memname">
104 <tr>
105 <td class="memname">TrkRigCut::~TrkRigCut </td>
106 <td>(</td>
107 <td class="paramname"> </td>
108 <td>&nbsp;)&nbsp;</td>
109 <td><code> [inline]</code></td>
110 </tr>
111 </table>
112 </div>
113 <div class="memdoc">
114
115 <p>
116 Destructor.
117 <p>
118
119 <p>Definition at line <a class="el" href="TrkRigCut_8h_source.html#l00032">32</a> of file <a class="el" href="TrkRigCut_8h_source.html">TrkRigCut.h</a>.</p>
120
121 </div>
122 </div><p>
123 <hr><h2>Member Function Documentation</h2>
124 <a class="anchor" name="00ddc4658bff1f28065ccb91d3eb43e6"></a><!-- doxytag: member="TrkRigCut::Check" ref="00ddc4658bff1f28065ccb91d3eb43e6" args="(PamLevel2 *event)" -->
125 <div class="memitem">
126 <div class="memproto">
127 <table class="memname">
128 <tr>
129 <td class="memname">int TrkRigCut::Check </td>
130 <td>(</td>
131 <td class="paramtype">PamLevel2 *&nbsp;</td>
132 <td class="paramname"> <em>event</em> </td>
133 <td>&nbsp;)&nbsp;</td>
134 <td><code> [virtual]</code></td>
135 </tr>
136 </table>
137 </div>
138 <div class="memdoc">
139
140 <p>
141 The rigidity check.
142 <p>
143 <dl compact><dt><b>Parameters:</b></dt><dd>
144 <table border="0" cellspacing="2" cellpadding="0">
145 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
146 </table>
147 </dl>
148 <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 greater than the threshold <p>
149 0 otherwise. </dd></dl>
150
151 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
152
153 <p>Definition at line <a class="el" href="TrkRigCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="TrkRigCut_8cpp_source.html">TrkRigCut.cpp</a>.</p>
154
155 <p>References <a class="el" href="TrkRigCut_8h_source.html#l00045">_minRigidity</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
156
157 </div>
158 </div><p>
159 <hr><h2>Member Data Documentation</h2>
160 <a class="anchor" name="926892b16fd69c7d69a5681c6cafd353"></a><!-- doxytag: member="TrkRigCut::_minRigidity" ref="926892b16fd69c7d69a5681c6cafd353" args="" -->
161 <div class="memitem">
162 <div class="memproto">
163 <table class="memname">
164 <tr>
165 <td class="memname">float <a class="el" href="classTrkRigCut.html#926892b16fd69c7d69a5681c6cafd353">TrkRigCut::_minRigidity</a><code> [private]</code> </td>
166 </tr>
167 </table>
168 </div>
169 <div class="memdoc">
170
171 <p>
172
173 <p>Definition at line <a class="el" href="TrkRigCut_8h_source.html#l00045">45</a> of file <a class="el" href="TrkRigCut_8h_source.html">TrkRigCut.h</a>.</p>
174
175 <p>Referenced by <a class="el" href="TrkRigCut_8cpp_source.html#l00012">Check()</a>.</p>
176
177 </div>
178 </div><p>
179 <hr>The documentation for this class was generated from the following files:<ul>
180 <li>TrkCuts/TrkRigCut/<a class="el" href="TrkRigCut_8h_source.html">TrkRigCut.h</a><li>TrkCuts/TrkRigCut/<a class="el" href="TrkRigCut_8cpp_source.html">TrkRigCut.cpp</a></ul>
181 </div>
182 <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:53 2009 for PamCut by&nbsp;
183 <a href="http://www.doxygen.org/index.html">
184 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
185 </body>
186 </html>

  ViewVC Help
Powered by ViewVC 1.1.23