/[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.3 - (show annotations) (download) (as text)
Fri Sep 25 15:41:40 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: text/html
FILE REMOVED
Removed from repository.

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 CaloAxis 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 CaloAxis 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, CaloAxis *xCaloAxis, CaloAxis *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"><a class="anchor" name="97d9858496d6c3f8a47aa2c60d844065"></a><!-- doxytag: member="CaloNHitCut::~CaloNHitCut" ref="97d9858496d6c3f8a47aa2c60d844065" args="()" -->
48 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloNHitCut.html#97d9858496d6c3f8a47aa2c60d844065">~CaloNHitCut</a> ()</td></tr>
49
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
51 <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>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of hit planes check. <a href="#54aae0d5514f7bda15297b9cfdceee68"></a><br></td></tr>
54 </table>
55 <hr><a name="_details"></a><h2>Detailed Description</h2>
56 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 CaloAxis 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 CaloAxis 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.
57 <p>
58 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 CaloAxis objects). <hr><h2>Constructor &amp; Destructor Documentation</h2>
59 <a class="anchor" name="220d9db8d015f09a97bb7a222f059cd2"></a><!-- doxytag: member="CaloNHitCut::CaloNHitCut" ref="220d9db8d015f09a97bb7a222f059cd2" args="(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, int nMinHit=10)" -->
60 <div class="memitem">
61 <div class="memproto">
62 <table class="memname">
63 <tr>
64 <td class="memname">CaloNHitCut::CaloNHitCut </td>
65 <td>(</td>
66 <td class="paramtype">const char *&nbsp;</td>
67 <td class="paramname"> <em>cutName</em>, </td>
68 </tr>
69 <tr>
70 <td class="paramkey"></td>
71 <td></td>
72 <td class="paramtype">CaloAxis *&nbsp;</td>
73 <td class="paramname"> <em>xCaloAxis</em>, </td>
74 </tr>
75 <tr>
76 <td class="paramkey"></td>
77 <td></td>
78 <td class="paramtype">CaloAxis *&nbsp;</td>
79 <td class="paramname"> <em>yCaloAxis</em>, </td>
80 </tr>
81 <tr>
82 <td class="paramkey"></td>
83 <td></td>
84 <td class="paramtype">int&nbsp;</td>
85 <td class="paramname"> <em>nMinHit</em> = <code>10</code></td><td>&nbsp;</td>
86 </tr>
87 <tr>
88 <td></td>
89 <td>)</td>
90 <td></td><td></td><td><code> [inline]</code></td>
91 </tr>
92 </table>
93 </div>
94 <div class="memdoc">
95
96 <p>
97 Constructor.
98 <p>
99 The CaloAxis arguments are pointers to objects which contain the calorimeter track information for current event.<p>
100 <dl compact><dt><b>Parameters:</b></dt><dd>
101 <table border="0" cellspacing="2" cellpadding="0">
102 <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut name. </td></tr>
103 <tr><td valign="top"></td><td valign="top"><em>xCaloAxis</em>&nbsp;</td><td>The pointer to the CaloAxis object for X axis. </td></tr>
104 <tr><td valign="top"></td><td valign="top"><em>yCaloAxis</em>&nbsp;</td><td>The pointer to the CaloAxis object for Y axis. </td></tr>
105 <tr><td valign="top"></td><td valign="top"><em>nMinHit</em>&nbsp;</td><td>The minimum number of hits. </td></tr>
106 </table>
107 </dl>
108
109 </div>
110 </div><p>
111 <hr><h2>Member Function Documentation</h2>
112 <a class="anchor" name="54aae0d5514f7bda15297b9cfdceee68"></a><!-- doxytag: member="CaloNHitCut::Check" ref="54aae0d5514f7bda15297b9cfdceee68" args="(PamLevel2 *event)" -->
113 <div class="memitem">
114 <div class="memproto">
115 <table class="memname">
116 <tr>
117 <td class="memname">int CaloNHitCut::Check </td>
118 <td>(</td>
119 <td class="paramtype">PamLevel2 *&nbsp;</td>
120 <td class="paramname"> <em>event</em> </td>
121 <td>&nbsp;)&nbsp;</td>
122 <td><code> [virtual]</code></td>
123 </tr>
124 </table>
125 </div>
126 <div class="memdoc">
127
128 <p>
129 The number of hit planes check.
130 <p>
131 The check is done by looking if there is a charge release near the track, using the CaloAxis class. If a charge greater than 0 is found by invoking CaloAxis::GetQ for at least nMinHit planes (both for X and Y) the condition is fulfilled.<p>
132 <dl compact><dt><b>Parameters:</b></dt><dd>
133 <table border="0" cellspacing="2" cellpadding="0">
134 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
135 </table>
136 </dl>
137 <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>
138 0 otherwise. </dd></dl>
139 <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>
140
141 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
142
143 </div>
144 </div><p>
145 <hr>The documentation for this class was generated from the following files:<ul>
146 <li>CaloCuts/CaloNHitCut/<a class="el" href="CaloNHitCut_8h_source.html">CaloNHitCut.h</a><li>CaloCuts/CaloNHitCut/<a class="el" href="CaloNHitCut_8cpp.html">CaloNHitCut.cpp</a></ul>
147 </div>
148 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:00 2009 for PamCut by&nbsp;
149 <a href="http://www.doxygen.org/index.html">
150 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
151 </body>
152 </html>

  ViewVC Help
Powered by ViewVC 1.1.23