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

Annotation of /PamCut/doc/Doxygen/html/classTrkGeomCut.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:08 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: TrkGeomCut 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>TrkGeomCut Class Reference</h1><!-- doxytag: class="TrkGeomCut" --><!-- doxytag: inherits="PamCut" -->The tracker fiducial acceptance cut. This cut checks if the track is inside the fiducial acceptance chosen for the tracker. CUT DEPENDENCIES: TrkPhysSin for object trkTrack.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for TrkGeomCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classTrkGeomCut.png" usemap="#TrkGeomCut_map" border="0" alt=""></center>
35     <map name="TrkGeomCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,81,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classTrkGeomCut-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="classTrkGeomCut.html#fd4f9fc60d3f2b8d71f277b4b2b231fd">TrkGeomCut</a> (const char *cutName, float xTol, float yTol)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#fd4f9fc60d3f2b8d71f277b4b2b231fd"></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="classTrkGeomCut.html#6ec9a866e99b67a1f882d9113c995ccc">~TrkGeomCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#6ec9a866e99b67a1f882d9113c995ccc"></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="classTrkGeomCut.html#4fef0bbfb92036676974671133e1ce5a">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The tracker fiducial acceptance check. <a href="#4fef0bbfb92036676974671133e1ce5a"></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="classTrkGeomCut.html#81c6ed45a6a3bac7b2ccad434bd92af7">_xTol</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="classTrkGeomCut.html#1f5b9ce6bf84d9d5d905dd65661bb2e7">_yTol</a></td></tr>
57    
58     </table>
59     <hr><a name="_details"></a><h2>Detailed Description</h2>
60     The tracker fiducial acceptance cut. This cut checks if the track is inside the fiducial acceptance chosen for the tracker. CUT DEPENDENCIES: TrkPhysSin for object trkTrack.
61     <p>Definition at line <a class="el" href="TrkGeomCut_8h_source.html#l00020">20</a> of file <a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a>.</p>
62     <hr><h2>Constructor &amp; Destructor Documentation</h2>
63     <a class="anchor" name="fd4f9fc60d3f2b8d71f277b4b2b231fd"></a><!-- doxytag: member="TrkGeomCut::TrkGeomCut" ref="fd4f9fc60d3f2b8d71f277b4b2b231fd" args="(const char *cutName, float xTol, float yTol)" -->
64     <div class="memitem">
65     <div class="memproto">
66     <table class="memname">
67     <tr>
68     <td class="memname">TrkGeomCut::TrkGeomCut </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>xTol</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>yTol</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     The parameters are the width of the regions on each side of a view that define the fiducial acceptance region. The detector size is therefore reduce by an amount of xTol (yTol) on each side of the X (Y) view.<p>
98     <dl compact><dt><b>Parameters:</b></dt><dd>
99     <table border="0" cellspacing="2" cellpadding="0">
100     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
101     <tr><td valign="top"></td><td valign="top"><em>xTol</em>&nbsp;</td><td>The fiducial border on X view in cm. </td></tr>
102     <tr><td valign="top"></td><td valign="top"><em>yTol</em>&nbsp;</td><td>The fiducial border on Y view in cm. </td></tr>
103     </table>
104     </dl>
105    
106     <p>Definition at line <a class="el" href="TrkGeomCut_8h_source.html#l00033">33</a> of file <a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a>.</p>
107    
108     </div>
109     </div><p>
110     <a class="anchor" name="6ec9a866e99b67a1f882d9113c995ccc"></a><!-- doxytag: member="TrkGeomCut::~TrkGeomCut" ref="6ec9a866e99b67a1f882d9113c995ccc" args="()" -->
111     <div class="memitem">
112     <div class="memproto">
113     <table class="memname">
114     <tr>
115     <td class="memname">TrkGeomCut::~TrkGeomCut </td>
116     <td>(</td>
117     <td class="paramname"> </td>
118     <td>&nbsp;)&nbsp;</td>
119     <td><code> [inline]</code></td>
120     </tr>
121     </table>
122     </div>
123     <div class="memdoc">
124    
125     <p>
126     Destructor.
127     <p>
128    
129     <p>Definition at line <a class="el" href="TrkGeomCut_8h_source.html#l00037">37</a> of file <a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a>.</p>
130    
131     </div>
132     </div><p>
133     <hr><h2>Member Function Documentation</h2>
134     <a class="anchor" name="4fef0bbfb92036676974671133e1ce5a"></a><!-- doxytag: member="TrkGeomCut::Check" ref="4fef0bbfb92036676974671133e1ce5a" args="(PamLevel2 *event)" -->
135     <div class="memitem">
136     <div class="memproto">
137     <table class="memname">
138     <tr>
139     <td class="memname">int TrkGeomCut::Check </td>
140     <td>(</td>
141     <td class="paramtype">PamLevel2 *&nbsp;</td>
142     <td class="paramname"> <em>event</em> </td>
143     <td>&nbsp;)&nbsp;</td>
144     <td><code> [virtual]</code></td>
145     </tr>
146     </table>
147     </div>
148     <div class="memdoc">
149    
150     <p>
151     The tracker fiducial acceptance check.
152     <p>
153     <dl compact><dt><b>Parameters:</b></dt><dd>
154     <table border="0" cellspacing="2" cellpadding="0">
155     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
156     </table>
157     </dl>
158     <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 track is inside the fiducial acceptance. <p>
159     0 otherwise. </dd></dl>
160    
161     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
162    
163     <p>Definition at line <a class="el" href="TrkGeomCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="TrkGeomCut_8cpp_source.html">TrkGeomCut.cpp</a>.</p>
164    
165     <p>References <a class="el" href="TrkGeomCut_8h_source.html#l00050">_xTol</a>, <a class="el" href="TrkGeomCut_8h_source.html#l00051">_yTol</a>, and <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>.</p>
166    
167     </div>
168     </div><p>
169     <hr><h2>Member Data Documentation</h2>
170     <a class="anchor" name="81c6ed45a6a3bac7b2ccad434bd92af7"></a><!-- doxytag: member="TrkGeomCut::_xTol" ref="81c6ed45a6a3bac7b2ccad434bd92af7" args="" -->
171     <div class="memitem">
172     <div class="memproto">
173     <table class="memname">
174     <tr>
175     <td class="memname">float <a class="el" href="classTrkGeomCut.html#81c6ed45a6a3bac7b2ccad434bd92af7">TrkGeomCut::_xTol</a><code> [private]</code> </td>
176     </tr>
177     </table>
178     </div>
179     <div class="memdoc">
180    
181     <p>
182    
183     <p>Definition at line <a class="el" href="TrkGeomCut_8h_source.html#l00050">50</a> of file <a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a>.</p>
184    
185     <p>Referenced by <a class="el" href="TrkGeomCut_8cpp_source.html#l00012">Check()</a>.</p>
186    
187     </div>
188     </div><p>
189     <a class="anchor" name="1f5b9ce6bf84d9d5d905dd65661bb2e7"></a><!-- doxytag: member="TrkGeomCut::_yTol" ref="1f5b9ce6bf84d9d5d905dd65661bb2e7" args="" -->
190     <div class="memitem">
191     <div class="memproto">
192     <table class="memname">
193     <tr>
194     <td class="memname">float <a class="el" href="classTrkGeomCut.html#1f5b9ce6bf84d9d5d905dd65661bb2e7">TrkGeomCut::_yTol</a><code> [private]</code> </td>
195     </tr>
196     </table>
197     </div>
198     <div class="memdoc">
199    
200     <p>
201    
202     <p>Definition at line <a class="el" href="TrkGeomCut_8h_source.html#l00051">51</a> of file <a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a>.</p>
203    
204     <p>Referenced by <a class="el" href="TrkGeomCut_8cpp_source.html#l00012">Check()</a>.</p>
205    
206     </div>
207     </div><p>
208     <hr>The documentation for this class was generated from the following files:<ul>
209     <li>TrkCuts/TrkGeomCut/<a class="el" href="TrkGeomCut_8h_source.html">TrkGeomCut.h</a><li>TrkCuts/TrkGeomCut/<a class="el" href="TrkGeomCut_8cpp_source.html">TrkGeomCut.cpp</a></ul>
210     </div>
211     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:51 2009 for PamCut by&nbsp;
212     <a href="http://www.doxygen.org/index.html">
213     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
214     </body>
215     </html>
  ViewVC Help
Powered by ViewVC 1.1.23