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

Annotation of /PamCut/doc/Doxygen/html/classCaloIonCut.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:05 2009 UTC (16 years, 5 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: CaloIonCut 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>CaloIonCut Class Reference</h1><!-- doxytag: class="CaloIonCut" --><!-- doxytag: inherits="PamCut" -->The calorimeter ionization cut.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for CaloIonCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classCaloIonCut.png" usemap="#CaloIonCut_map" border="0" alt=""></center>
35     <map name="CaloIonCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,74,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classCaloIonCut-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="classCaloIonCut.html#d6b2ee30eed42510b052ce7276adbb2e">CaloIonCut</a> (const char *cutName, <a class="el" href="classCaloAxis.html">CaloAxis</a> *xCaloAxis, <a class="el" href="classCaloAxis.html">CaloAxis</a> *yCaloAxis, float minRelease=0., float maxRelease=3.)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#d6b2ee30eed42510b052ce7276adbb2e"></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="classCaloIonCut.html#dbb2f15f8cf67625be67aa7143b52a7e">~CaloIonCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#dbb2f15f8cf67625be67aa7143b52a7e"></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="classCaloIonCut.html#20a353b53560701ba1ba72db42f48083">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The calorimeter ionization check. <a href="#20a353b53560701ba1ba72db42f48083"></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="classCaloIonCut.html#d5fefbe29b26f0c8d299aaa8d95f70c5">_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="classCaloIonCut.html#f26eab85609cbd18cf6579c9fe79dd08">_yCaloAxis</a></td></tr>
57    
58     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloIonCut.html#9e0be06d5e079c5ea249ba7cc4fe203b">_minRelease</a></td></tr>
59    
60     <tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloIonCut.html#4c1f2201a07e1bf6f72df1b958721677">_maxRelease</a></td></tr>
61    
62     </table>
63     <hr><a name="_details"></a><h2>Detailed Description</h2>
64     The calorimeter ionization cut.
65     <p>
66     Checks the energy release on the first calorimeter plane. The current implementation uses the <a class="el" href="classCaloAxis.html">CaloAxis</a> objects; 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.<p>
67     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).
68     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00030">30</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
69     <hr><h2>Constructor &amp; Destructor Documentation</h2>
70     <a class="anchor" name="d6b2ee30eed42510b052ce7276adbb2e"></a><!-- doxytag: member="CaloIonCut::CaloIonCut" ref="d6b2ee30eed42510b052ce7276adbb2e" args="(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis, float minRelease=0., float maxRelease=3.)" -->
71     <div class="memitem">
72     <div class="memproto">
73     <table class="memname">
74     <tr>
75     <td class="memname">CaloIonCut::CaloIonCut </td>
76     <td>(</td>
77     <td class="paramtype">const char *&nbsp;</td>
78     <td class="paramname"> <em>cutName</em>, </td>
79     </tr>
80     <tr>
81     <td class="paramkey"></td>
82     <td></td>
83     <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>
84     <td class="paramname"> <em>xCaloAxis</em>, </td>
85     </tr>
86     <tr>
87     <td class="paramkey"></td>
88     <td></td>
89     <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>
90     <td class="paramname"> <em>yCaloAxis</em>, </td>
91     </tr>
92     <tr>
93     <td class="paramkey"></td>
94     <td></td>
95     <td class="paramtype">float&nbsp;</td>
96     <td class="paramname"> <em>minRelease</em> = <code>0.</code>, </td>
97     </tr>
98     <tr>
99     <td class="paramkey"></td>
100     <td></td>
101     <td class="paramtype">float&nbsp;</td>
102     <td class="paramname"> <em>maxRelease</em> = <code>3.</code></td><td>&nbsp;</td>
103     </tr>
104     <tr>
105     <td></td>
106     <td>)</td>
107     <td></td><td></td><td><code> [inline]</code></td>
108     </tr>
109     </table>
110     </div>
111     <div class="memdoc">
112    
113     <p>
114     Constructor.
115     <p>
116     The <a class="el" href="classCaloAxis.html">CaloAxis</a> arguments are objects which contain the calorimeter track information for current event.<p>
117     <dl compact><dt><b>Parameters:</b></dt><dd>
118     <table border="0" cellspacing="2" cellpadding="0">
119     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
120     <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>
121     <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>
122     <tr><td valign="top"></td><td valign="top"><em>maxRelease</em>&nbsp;</td><td>The maximum mean ionization (in MIP) in the tracker planes above which an event is discarded. Default: 3. </td></tr>
123     <tr><td valign="top"></td><td valign="top"><em>minRelease</em>&nbsp;</td><td>The minimum mean ionization (in MIP) in the tracker planes below which an event is discarded. Default: 0. </td></tr>
124     </table>
125     </dl>
126    
127     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00044">44</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
128    
129     </div>
130     </div><p>
131     <a class="anchor" name="dbb2f15f8cf67625be67aa7143b52a7e"></a><!-- doxytag: member="CaloIonCut::~CaloIonCut" ref="dbb2f15f8cf67625be67aa7143b52a7e" args="()" -->
132     <div class="memitem">
133     <div class="memproto">
134     <table class="memname">
135     <tr>
136     <td class="memname">CaloIonCut::~CaloIonCut </td>
137     <td>(</td>
138     <td class="paramname"> </td>
139     <td>&nbsp;)&nbsp;</td>
140     <td><code> [inline]</code></td>
141     </tr>
142     </table>
143     </div>
144     <div class="memdoc">
145    
146     <p>
147     Destructor.
148     <p>
149    
150     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00049">49</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
151    
152     </div>
153     </div><p>
154     <hr><h2>Member Function Documentation</h2>
155     <a class="anchor" name="20a353b53560701ba1ba72db42f48083"></a><!-- doxytag: member="CaloIonCut::Check" ref="20a353b53560701ba1ba72db42f48083" args="(PamLevel2 *event)" -->
156     <div class="memitem">
157     <div class="memproto">
158     <table class="memname">
159     <tr>
160     <td class="memname">int CaloIonCut::Check </td>
161     <td>(</td>
162     <td class="paramtype">PamLevel2 *&nbsp;</td>
163     <td class="paramname"> <em>event</em> </td>
164     <td>&nbsp;)&nbsp;</td>
165     <td><code> [virtual]</code></td>
166     </tr>
167     </table>
168     </div>
169     <div class="memdoc">
170    
171     <p>
172     The calorimeter ionization check.
173     <p>
174     <dl compact><dt><b>Parameters:</b></dt><dd>
175     <table border="0" cellspacing="2" cellpadding="0">
176     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
177     </table>
178     </dl>
179     <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 charge released in plane 0 (from <a class="el" href="classCaloAxis.html">CaloAxis</a>) is greater than minRelease and lesser than maxRelease, for both X and Y <p>
180     0 otherwise </dd></dl>
181    
182     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
183    
184     <p>Definition at line <a class="el" href="CaloIonCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="CaloIonCut_8cpp_source.html">CaloIonCut.cpp</a>.</p>
185    
186     <p>References <a class="el" href="CaloIonCut_8h_source.html#l00062">_maxRelease</a>, <a class="el" href="CaloIonCut_8h_source.html#l00062">_minRelease</a>, <a class="el" href="CaloIonCut_8h_source.html#l00061">_xCaloAxis</a>, <a class="el" href="CaloIonCut_8h_source.html#l00061">_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>
187    
188     </div>
189     </div><p>
190     <hr><h2>Member Data Documentation</h2>
191     <a class="anchor" name="4c1f2201a07e1bf6f72df1b958721677"></a><!-- doxytag: member="CaloIonCut::_maxRelease" ref="4c1f2201a07e1bf6f72df1b958721677" args="" -->
192     <div class="memitem">
193     <div class="memproto">
194     <table class="memname">
195     <tr>
196     <td class="memname">float <a class="el" href="classCaloIonCut.html#4c1f2201a07e1bf6f72df1b958721677">CaloIonCut::_maxRelease</a><code> [private]</code> </td>
197     </tr>
198     </table>
199     </div>
200     <div class="memdoc">
201    
202     <p>
203    
204     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00062">62</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
205    
206     <p>Referenced by <a class="el" href="CaloIonCut_8cpp_source.html#l00012">Check()</a>.</p>
207    
208     </div>
209     </div><p>
210     <a class="anchor" name="9e0be06d5e079c5ea249ba7cc4fe203b"></a><!-- doxytag: member="CaloIonCut::_minRelease" ref="9e0be06d5e079c5ea249ba7cc4fe203b" args="" -->
211     <div class="memitem">
212     <div class="memproto">
213     <table class="memname">
214     <tr>
215     <td class="memname">float <a class="el" href="classCaloIonCut.html#9e0be06d5e079c5ea249ba7cc4fe203b">CaloIonCut::_minRelease</a><code> [private]</code> </td>
216     </tr>
217     </table>
218     </div>
219     <div class="memdoc">
220    
221     <p>
222    
223     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00062">62</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
224    
225     <p>Referenced by <a class="el" href="CaloIonCut_8cpp_source.html#l00012">Check()</a>.</p>
226    
227     </div>
228     </div><p>
229     <a class="anchor" name="d5fefbe29b26f0c8d299aaa8d95f70c5"></a><!-- doxytag: member="CaloIonCut::_xCaloAxis" ref="d5fefbe29b26f0c8d299aaa8d95f70c5" args="" -->
230     <div class="memitem">
231     <div class="memproto">
232     <table class="memname">
233     <tr>
234     <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a>* <a class="el" href="classCaloIonCut.html#d5fefbe29b26f0c8d299aaa8d95f70c5">CaloIonCut::_xCaloAxis</a><code> [private]</code> </td>
235     </tr>
236     </table>
237     </div>
238     <div class="memdoc">
239    
240     <p>
241    
242     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00061">61</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
243    
244     <p>Referenced by <a class="el" href="CaloIonCut_8cpp_source.html#l00012">Check()</a>.</p>
245    
246     </div>
247     </div><p>
248     <a class="anchor" name="f26eab85609cbd18cf6579c9fe79dd08"></a><!-- doxytag: member="CaloIonCut::_yCaloAxis" ref="f26eab85609cbd18cf6579c9fe79dd08" args="" -->
249     <div class="memitem">
250     <div class="memproto">
251     <table class="memname">
252     <tr>
253     <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a> * <a class="el" href="classCaloIonCut.html#f26eab85609cbd18cf6579c9fe79dd08">CaloIonCut::_yCaloAxis</a><code> [private]</code> </td>
254     </tr>
255     </table>
256     </div>
257     <div class="memdoc">
258    
259     <p>
260    
261     <p>Definition at line <a class="el" href="CaloIonCut_8h_source.html#l00061">61</a> of file <a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a>.</p>
262    
263     <p>Referenced by <a class="el" href="CaloIonCut_8cpp_source.html#l00012">Check()</a>.</p>
264    
265     </div>
266     </div><p>
267     <hr>The documentation for this class was generated from the following files:<ul>
268     <li>CaloCuts/CaloIonCut/<a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a><li>CaloCuts/CaloIonCut/<a class="el" href="CaloIonCut_8cpp_source.html">CaloIonCut.cpp</a></ul>
269     </div>
270     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:32 2009 for PamCut by&nbsp;
271     <a href="http://www.doxygen.org/index.html">
272     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
273     </body>
274     </html>
  ViewVC Help
Powered by ViewVC 1.1.23