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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (show annotations) (download) (as text)
Fri Sep 25 15:41:24 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: 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, CaloAxis *xCaloAxis, CaloAxis *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"><a class="anchor" name="dbb2f15f8cf67625be67aa7143b52a7e"></a><!-- doxytag: member="CaloIonCut::~CaloIonCut" ref="dbb2f15f8cf67625be67aa7143b52a7e" args="()" -->
48 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCaloIonCut.html#dbb2f15f8cf67625be67aa7143b52a7e">~CaloIonCut</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="classCaloIonCut.html#20a353b53560701ba1ba72db42f48083">Check</a> (PamLevel2 *event)</td></tr>
52
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The calorimeter ionization check. <a href="#20a353b53560701ba1ba72db42f48083"></a><br></td></tr>
54 </table>
55 <hr><a name="_details"></a><h2>Detailed Description</h2>
56 The calorimeter ionization cut.
57 <p>
58 Checks the energy release on the first calorimeter plane. The current implementation uses the CaloAxis objects; 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.<p>
59 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>
60 <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.)" -->
61 <div class="memitem">
62 <div class="memproto">
63 <table class="memname">
64 <tr>
65 <td class="memname">CaloIonCut::CaloIonCut </td>
66 <td>(</td>
67 <td class="paramtype">const char *&nbsp;</td>
68 <td class="paramname"> <em>cutName</em>, </td>
69 </tr>
70 <tr>
71 <td class="paramkey"></td>
72 <td></td>
73 <td class="paramtype">CaloAxis *&nbsp;</td>
74 <td class="paramname"> <em>xCaloAxis</em>, </td>
75 </tr>
76 <tr>
77 <td class="paramkey"></td>
78 <td></td>
79 <td class="paramtype">CaloAxis *&nbsp;</td>
80 <td class="paramname"> <em>yCaloAxis</em>, </td>
81 </tr>
82 <tr>
83 <td class="paramkey"></td>
84 <td></td>
85 <td class="paramtype">float&nbsp;</td>
86 <td class="paramname"> <em>minRelease</em> = <code>0.</code>, </td>
87 </tr>
88 <tr>
89 <td class="paramkey"></td>
90 <td></td>
91 <td class="paramtype">float&nbsp;</td>
92 <td class="paramname"> <em>maxRelease</em> = <code>3.</code></td><td>&nbsp;</td>
93 </tr>
94 <tr>
95 <td></td>
96 <td>)</td>
97 <td></td><td></td><td><code> [inline]</code></td>
98 </tr>
99 </table>
100 </div>
101 <div class="memdoc">
102
103 <p>
104 Constructor.
105 <p>
106 The CaloAxis arguments are objects which contain the calorimeter track information for current event.<p>
107 <dl compact><dt><b>Parameters:</b></dt><dd>
108 <table border="0" cellspacing="2" cellpadding="0">
109 <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut's name. </td></tr>
110 <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>
111 <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>
112 <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>
113 <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>
114 </table>
115 </dl>
116
117 </div>
118 </div><p>
119 <hr><h2>Member Function Documentation</h2>
120 <a class="anchor" name="20a353b53560701ba1ba72db42f48083"></a><!-- doxytag: member="CaloIonCut::Check" ref="20a353b53560701ba1ba72db42f48083" args="(PamLevel2 *event)" -->
121 <div class="memitem">
122 <div class="memproto">
123 <table class="memname">
124 <tr>
125 <td class="memname">int CaloIonCut::Check </td>
126 <td>(</td>
127 <td class="paramtype">PamLevel2 *&nbsp;</td>
128 <td class="paramname"> <em>event</em> </td>
129 <td>&nbsp;)&nbsp;</td>
130 <td><code> [virtual]</code></td>
131 </tr>
132 </table>
133 </div>
134 <div class="memdoc">
135
136 <p>
137 The calorimeter ionization check.
138 <p>
139 <dl compact><dt><b>Parameters:</b></dt><dd>
140 <table border="0" cellspacing="2" cellpadding="0">
141 <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
142 </table>
143 </dl>
144 <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 CaloAxis) is greater than minRelease and lesser than maxRelease, for both X and Y <p>
145 0 otherwise </dd></dl>
146
147 <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
148
149 </div>
150 </div><p>
151 <hr>The documentation for this class was generated from the following files:<ul>
152 <li>CaloCuts/CaloIonCut/<a class="el" href="CaloIonCut_8h_source.html">CaloIonCut.h</a><li>CaloCuts/CaloIonCut/<a class="el" href="CaloIonCut_8cpp.html">CaloIonCut.cpp</a></ul>
153 </div>
154 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:00 2009 for PamCut by&nbsp;
155 <a href="http://www.doxygen.org/index.html">
156 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
157 </body>
158 </html>

  ViewVC Help
Powered by ViewVC 1.1.23