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

Contents of /PamCut/doc/Doxygen/html/classCaloNHitCut.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
Error occurred while calculating annotation data. 
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: CaloNHitCut 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>CaloNHitCut Class Reference</h1><!-- doxytag: class="CaloNHitCut" --><!-- doxytag: inherits="PamCut" -->The number of hits cut for the calorimeter. An event survives this selection if the number of hit planes in the calorimeter is greater than some value. To save computing time, the class assumes that the track is externally computed for each event and stored in <a class="el" href="classCaloAxis.html">CaloAxis</a> objects; pointers to these objects are passed as arguments to the constructor. The Check method will then ignore the PamLevel2 *event and assume that the current content of the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects are relative to the current event. It is an user's task to ensure that these assumptions are fulfilled every time Check or ApplyCut are called.
26 <a href="#_details">More...</a>
27 <p>
28 <code>#include &lt;<a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>&gt;</code>
29 <p>
30 <div class="dynheader">
31 Inheritance diagram for CaloNHitCut:</div>
32 <div class="dynsection">
33
34 <p><center><img src="classCaloNHitCut.png" usemap="#CaloNHitCut_map" border="0" alt=""></center>
35 <map name="CaloNHitCut_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="classCaloNHitCut-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="classCaloNHitCut.html#220d9db8d015f09a97bb7a222f059cd2">CaloNHitCut</a> (const char *cutName, <a class="el" href="classCaloAxis.html">CaloAxis</a> *xCaloAxis, <a class="el" href="classCaloAxis.html">CaloAxis</a> *yCaloAxis, int nMinHit=10)</td></tr>
45
46 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#220d9db8d015f09a97bb7a222f059cd2"></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="classCaloNHitCut.html#97d9858496d6c3f8a47aa2c60d844065">~CaloNHitCut</a> ()</td></tr>
48
49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#97d9858496d6c3f8a47aa2c60d844065"></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="classCaloNHitCut.html#54aae0d5514f7bda15297b9cfdceee68">Check</a> (PamLevel2 *event)</td></tr>
51
52 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of hit planes check. <a href="#54aae0d5514f7bda15297b9cfdceee68"></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"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloNHitCut.html#30652791bd9af9d61c5a156fc85f922a">_xCaloAxis</a></td></tr>
55
56 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloNHitCut.html#a2561d175842814d056ffbd99b50ea6e">_yCaloAxis</a></td></tr>
57
58 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloNHitCut.html#4a261716ce5e71159d2da6414a819a9a">_nMinHit</a></td></tr>
59
60 </table>
61 <hr><a name="_details"></a><h2>Detailed Description</h2>
62 The number of hits cut for the calorimeter. An event survives this selection if the number of hit planes in the calorimeter is greater than some value. To save computing time, the class assumes that the track is externally computed for each event and stored in <a class="el" href="classCaloAxis.html">CaloAxis</a> objects; pointers to these objects are passed as arguments to the constructor. The Check method will then ignore the PamLevel2 *event and assume that the current content of the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects are relative to the current event. It is an user's task to ensure that these assumptions are fulfilled every time Check or ApplyCut are called.
63 <p>
64 CUT DEPENDENCIES: <a class="el" href="classCaloTrackCut.html" title="The calorimeter track cut. Checks for the existence of a track in the calorimeter...">CaloTrackCut</a> for the existence of the track (it can also provide the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects).
65 <p>Definition at line <a class="el" href="CaloNHitCut_8h_source.html#l00029">29</a> of file <a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>.</p>
66 <hr><h2>Constructor &amp; Destructor Documentation</h2>
67 <a class="anchor" name="220d9db8d015f09a97bb7a222f059cd2"></a><!-- doxytag: member="CaloNHitCut::CaloNHitCut" ref="220d9db8d015f09a97bb7a222f059cd2" args="(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, int nMinHit=10)" -->
68 <div class="memitem">
69 <div class="memproto">
70 <table class="memname">
71 <tr>
72 <td class="memname">CaloNHitCut::CaloNHitCut </td>
73 <td>(</td>
74 <td class="paramtype">const char *&nbsp;</td>
75 <td class="paramname"> <em>cutName</em>, </td>
76 </tr>
77 <tr>
78 <td class="paramkey"></td>
79 <td></td>
80 <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>
81 <td class="paramname"> <em>xCaloAxis</em>, </td>
82 </tr>
83 <tr>
84 <td class="paramkey"></td>
85 <td></td>
86 <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>
87 <td class="paramname"> <em>yCaloAxis</em>, </td>
88 </tr>
89 <tr>
90 <td class="paramkey"></td>
91 <td></td>
92 <td class="paramtype">int&nbsp;</td>
93 <td class="paramname"> <em>nMinHit</em> = <code>10</code></td><td>&nbsp;</td>
94 </tr>
95 <tr>
96 <td></td>
97 <td>)</td>
98 <td></td><td></td><td><code> [inline]</code></td>
99 </tr>
100 </table>
101 </div>
102 <div class="memdoc">
103
104 <p>
105 Constructor.
106 <p>
107 The <a class="el" href="classCaloAxis.html">CaloAxis</a> arguments are pointers to objects which contain the calorimeter track information for current event.<p>
108 <dl compact><dt><b>Parameters:</b></dt><dd>
109 <table border="0" cellspacing="2" cellpadding="0">
110 <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut name. </td></tr>
111 <tr><td valign="top"></td><td valign="top"><em>xCaloAxis</em>&nbsp;</td><td>The pointer to the <a class="el" href="classCaloAxis.html">CaloAxis</a> object for X axis. </td></tr>
112 <tr><td valign="top"></td><td valign="top"><em>yCaloAxis</em>&nbsp;</td><td>The pointer to the <a class="el" href="classCaloAxis.html">CaloAxis</a> object for Y axis. </td></tr>
113 <tr><td valign="top"></td><td valign="top"><em>nMinHit</em>&nbsp;</td><td>The minimum number of hits. </td></tr>
114 </table>
115 </dl>
116
117 <p>Definition at line <a class="el" href="CaloNHitCut_8h_source.html#l00043">43</a> of file <a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>.</p>
118
119 </div>
120 </div><p>
121 <a class="anchor" name="97d9858496d6c3f8a47aa2c60d844065"></a><!-- doxytag: member="CaloNHitCut::~CaloNHitCut" ref="97d9858496d6c3f8a47aa2c60d844065" args="()" -->
122 <div class="memitem">
123 <div class="memproto">
124 <table class="memname">
125 <tr>
126 <td class="memname">CaloNHitCut::~CaloNHitCut </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="CaloNHitCut_8h_source.html#l00047">47</a> of file <a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>.</p>
141
142 </div>
143 </div><p>
144 <hr><h2>Member Function Documentation</h2>
145 <a class="anchor" name="54aae0d5514f7bda15297b9cfdceee68"></a><!-- doxytag: member="CaloNHitCut::Check" ref="54aae0d5514f7bda15297b9cfdceee68" args="(PamLevel2 *event)" -->
146 <div class="memitem">
147 <div class="memproto">
148 <table class="memname">
149 <tr>
150 <td class="memname">int CaloNHitCut::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 number of hit planes check.
163 <p>
164 The check is done by looking if there is a charge release near the track, using the <a class="el" href="classCaloAxis.html">CaloAxis</a> class. If a charge greater than 0 is found by invoking <a class="el" href="classCaloAxis.html#fa2726b36147a39e2c64d4808aa435e3">CaloAxis::GetQ</a> for at least nMinHit planes (both for X and Y) the condition is fulfilled.<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 the track hits at least nMinHit planes both in X and Y. <p>
171 0 otherwise. </dd></dl>
172 <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCaloNHitCut.html#220d9db8d015f09a97bb7a222f059cd2" title="Constructor.">CaloNHitCut::CaloNHitCut</a> </dd></dl>
173
174 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
175
176 <p>Definition at line <a class="el" href="CaloNHitCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="CaloNHitCut_8cpp_source.html">CaloNHitCut.cpp</a>.</p>
177
178 <p>References <a class="el" href="CaloNHitCut_8h_source.html#l00065">_nMinHit</a>, <a class="el" href="CaloNHitCut_8h_source.html#l00064">_xCaloAxis</a>, <a class="el" href="CaloNHitCut_8h_source.html#l00064">_yCaloAxis</a>, <a class="el" href="CommonDefs_8h_source.html#l00015">CUTOK</a>, and <a class="el" href="CaloAxis2_8h_source.html#l00274">CaloAxis::GetQ()</a>.</p>
179
180 </div>
181 </div><p>
182 <hr><h2>Member Data Documentation</h2>
183 <a class="anchor" name="4a261716ce5e71159d2da6414a819a9a"></a><!-- doxytag: member="CaloNHitCut::_nMinHit" ref="4a261716ce5e71159d2da6414a819a9a" args="" -->
184 <div class="memitem">
185 <div class="memproto">
186 <table class="memname">
187 <tr>
188 <td class="memname">int <a class="el" href="classCaloNHitCut.html#4a261716ce5e71159d2da6414a819a9a">CaloNHitCut::_nMinHit</a><code> [private]</code> </td>
189 </tr>
190 </table>
191 </div>
192 <div class="memdoc">
193
194 <p>
195
196 <p>Definition at line <a class="el" href="CaloNHitCut_8h_source.html#l00065">65</a> of file <a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>.</p>
197
198 <p>Referenced by <a class="el" href="CaloNHitCut_8cpp_source.html#l00012">Check()</a>.</p>
199
200 </div>
201 </div><p>
202 <a class="anchor" name="30652791bd9af9d61c5a156fc85f922a"></a><!-- doxytag: member="CaloNHitCut::_xCaloAxis" ref="30652791bd9af9d61c5a156fc85f922a" args="" -->
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
206 <tr>
207 <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a>* <a class="el" href="classCaloNHitCut.html#30652791bd9af9d61c5a156fc85f922a">CaloNHitCut::_xCaloAxis</a><code> [private]</code> </td>
208 </tr>
209 </table>
210 </div>
211 <div class="memdoc">
212
213 <p>
214
215 <p>Definition at line <a class="el" href="CaloNHitCut_8h_source.html#l00064">64</a> of file <a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>.</p>
216
217 <p>Referenced by <a class="el" href="CaloNHitCut_8cpp_source.html#l00012">Check()</a>.</p>
218
219 </div>
220 </div><p>
221 <a class="anchor" name="a2561d175842814d056ffbd99b50ea6e"></a><!-- doxytag: member="CaloNHitCut::_yCaloAxis" ref="a2561d175842814d056ffbd99b50ea6e" args="" -->
222 <div class="memitem">
223 <div class="memproto">
224 <table class="memname">
225 <tr>
226 <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a> * <a class="el" href="classCaloNHitCut.html#a2561d175842814d056ffbd99b50ea6e">CaloNHitCut::_yCaloAxis</a><code> [private]</code> </td>
227 </tr>
228 </table>
229 </div>
230 <div class="memdoc">
231
232 <p>
233
234 <p>Definition at line <a class="el" href="CaloNHitCut_8h_source.html#l00064">64</a> of file <a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a>.</p>
235
236 <p>Referenced by <a class="el" href="CaloNHitCut_8cpp_source.html#l00012">Check()</a>.</p>
237
238 </div>
239 </div><p>
240 <hr>The documentation for this class was generated from the following files:<ul>
241 <li>CaloCuts/CaloNHitCut/<a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a><li>CaloCuts/CaloNHitCut/<a class="el" href="CaloNHitCut_8cpp_source.html">CaloNHitCut.cpp</a></ul>
242 </div>
243 <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:32 2009 for PamCut by&nbsp;
244 <a href="http://www.doxygen.org/index.html">
245 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
246 </body>
247 </html>
  ViewVC Help
Powered by ViewVC 1.1.23