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

Annotation of /PamCut/doc/Doxygen/html/classCaloCrossCut.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.1 - (hide annotations) (download) (as text)
Wed May 27 13:30:04 2009 UTC (16 years, 4 months ago) by pam-fi
Branch: MAIN
Branch point for: DEV
File MIME type: text/html 
Initial revision
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: CaloCrossCut 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>CaloCrossCut Class Reference</h1><!-- doxytag: class="CaloCrossCut" --><!-- doxytag: inherits="PamCut" -->The calorimeter last plane cut.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for CaloCrossCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classCaloCrossCut.png" usemap="#CaloCrossCut_map" border="0" alt=""></center>
35     <map name="CaloCrossCut_map">
36     <area href="classPamCut.html" alt="PamCut" shape="rect" coords="0,0,90,24">
37     </map>
38     </div>
39    
40     <p>
41     <a href="classCaloCrossCut-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="classCaloCrossCut.html#33b00ac9d115f74bd2aa0c6418a61c0d">CaloCrossCut</a> (const char *cutName, <a class="el" href="classCaloAxis.html">CaloAxis</a> *xCaloAxis, <a class="el" href="classCaloAxis.html">CaloAxis</a> *yCaloAxis)</td></tr>
45    
46     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <a href="#33b00ac9d115f74bd2aa0c6418a61c0d"></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="classCaloCrossCut.html#30eff9bbcbcee85132b85fccd78159fe">~CaloCrossCut</a> ()</td></tr>
48    
49     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <a href="#30eff9bbcbcee85132b85fccd78159fe"></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="classCaloCrossCut.html#c79de9378fe4816ef37291da64d5a4f0">Check</a> (PamLevel2 *event)</td></tr>
51    
52     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The calorimeter last plane check. <a href="#c79de9378fe4816ef37291da64d5a4f0"></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="classCaloCrossCut.html#6443179bfcb21cef379b8383440eda5c">_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="classCaloCrossCut.html#bf61655ea8330e0c7e4139ab1e3809ec">_yCaloAxis</a></td></tr>
57    
58     </table>
59     <hr><a name="_details"></a><h2>Detailed Description</h2>
60     The calorimeter last plane cut.
61     <p>
62     Checks if the particle has crossed the last 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>
63     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).
64     <p>Definition at line <a class="el" href="CaloCrossCut_8h_source.html#l00030">30</a> of file <a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a>.</p>
65     <hr><h2>Constructor &amp; Destructor Documentation</h2>
66     <a class="anchor" name="33b00ac9d115f74bd2aa0c6418a61c0d"></a><!-- doxytag: member="CaloCrossCut::CaloCrossCut" ref="33b00ac9d115f74bd2aa0c6418a61c0d" args="(const char *cutName, CaloAxis *xCaloAxis, CaloAxis *yCaloAxis)" -->
67     <div class="memitem">
68     <div class="memproto">
69     <table class="memname">
70     <tr>
71     <td class="memname">CaloCrossCut::CaloCrossCut </td>
72     <td>(</td>
73     <td class="paramtype">const char *&nbsp;</td>
74     <td class="paramname"> <em>cutName</em>, </td>
75     </tr>
76     <tr>
77     <td class="paramkey"></td>
78     <td></td>
79     <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>
80     <td class="paramname"> <em>xCaloAxis</em>, </td>
81     </tr>
82     <tr>
83     <td class="paramkey"></td>
84     <td></td>
85     <td class="paramtype"><a class="el" href="classCaloAxis.html">CaloAxis</a> *&nbsp;</td>
86     <td class="paramname"> <em>yCaloAxis</em></td><td>&nbsp;</td>
87     </tr>
88     <tr>
89     <td></td>
90     <td>)</td>
91     <td></td><td></td><td><code> [inline]</code></td>
92     </tr>
93     </table>
94     </div>
95     <div class="memdoc">
96    
97     <p>
98     Constructor.
99     <p>
100     The <a class="el" href="classCaloAxis.html">CaloAxis</a> arguments are pointers to objects which contain the calorimeter track information for current event.<p>
101     <dl compact><dt><b>Parameters:</b></dt><dd>
102     <table border="0" cellspacing="2" cellpadding="0">
103     <tr><td valign="top"></td><td valign="top"><em>cutName</em>&nbsp;</td><td>The cut name. </td></tr>
104     <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>
105     <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>
106     </table>
107     </dl>
108    
109     <p>Definition at line <a class="el" href="CaloCrossCut_8h_source.html#l00042">42</a> of file <a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a>.</p>
110    
111     </div>
112     </div><p>
113     <a class="anchor" name="30eff9bbcbcee85132b85fccd78159fe"></a><!-- doxytag: member="CaloCrossCut::~CaloCrossCut" ref="30eff9bbcbcee85132b85fccd78159fe" args="()" -->
114     <div class="memitem">
115     <div class="memproto">
116     <table class="memname">
117     <tr>
118     <td class="memname">CaloCrossCut::~CaloCrossCut </td>
119     <td>(</td>
120     <td class="paramname"> </td>
121     <td>&nbsp;)&nbsp;</td>
122     <td><code> [inline]</code></td>
123     </tr>
124     </table>
125     </div>
126     <div class="memdoc">
127    
128     <p>
129     Destructor.
130     <p>
131    
132     <p>Definition at line <a class="el" href="CaloCrossCut_8h_source.html#l00046">46</a> of file <a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a>.</p>
133    
134     </div>
135     </div><p>
136     <hr><h2>Member Function Documentation</h2>
137     <a class="anchor" name="c79de9378fe4816ef37291da64d5a4f0"></a><!-- doxytag: member="CaloCrossCut::Check" ref="c79de9378fe4816ef37291da64d5a4f0" args="(PamLevel2 *event)" -->
138     <div class="memitem">
139     <div class="memproto">
140     <table class="memname">
141     <tr>
142     <td class="memname">int CaloCrossCut::Check </td>
143     <td>(</td>
144     <td class="paramtype">PamLevel2 *&nbsp;</td>
145     <td class="paramname"> <em>event</em> </td>
146     <td>&nbsp;)&nbsp;</td>
147     <td><code> [virtual]</code></td>
148     </tr>
149     </table>
150     </div>
151     <div class="memdoc">
152    
153     <p>
154     The calorimeter last plane check.
155     <p>
156     <dl compact><dt><b>Parameters:</b></dt><dd>
157     <table border="0" cellspacing="2" cellpadding="0">
158     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
159     </table>
160     </dl>
161     <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 22 is greater than 0 (from <a class="el" href="classCaloAxis.html">CaloAxis</a>) for both X and Y <p>
162     0 otherwise </dd></dl>
163    
164     <p>Implements <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">PamCut</a>.</p>
165    
166     <p>Definition at line <a class="el" href="CaloCrossCut_8cpp_source.html#l00012">12</a> of file <a class="el" href="CaloCrossCut_8cpp_source.html">CaloCrossCut.cpp</a>.</p>
167    
168     <p>References <a class="el" href="CaloCrossCut_8h_source.html#l00058">_xCaloAxis</a>, <a class="el" href="CaloCrossCut_8h_source.html#l00058">_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>
169    
170     </div>
171     </div><p>
172     <hr><h2>Member Data Documentation</h2>
173     <a class="anchor" name="6443179bfcb21cef379b8383440eda5c"></a><!-- doxytag: member="CaloCrossCut::_xCaloAxis" ref="6443179bfcb21cef379b8383440eda5c" args="" -->
174     <div class="memitem">
175     <div class="memproto">
176     <table class="memname">
177     <tr>
178     <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a>* <a class="el" href="classCaloCrossCut.html#6443179bfcb21cef379b8383440eda5c">CaloCrossCut::_xCaloAxis</a><code> [private]</code> </td>
179     </tr>
180     </table>
181     </div>
182     <div class="memdoc">
183    
184     <p>
185    
186     <p>Definition at line <a class="el" href="CaloCrossCut_8h_source.html#l00058">58</a> of file <a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a>.</p>
187    
188     <p>Referenced by <a class="el" href="CaloCrossCut_8cpp_source.html#l00012">Check()</a>.</p>
189    
190     </div>
191     </div><p>
192     <a class="anchor" name="bf61655ea8330e0c7e4139ab1e3809ec"></a><!-- doxytag: member="CaloCrossCut::_yCaloAxis" ref="bf61655ea8330e0c7e4139ab1e3809ec" args="" -->
193     <div class="memitem">
194     <div class="memproto">
195     <table class="memname">
196     <tr>
197     <td class="memname"><a class="el" href="classCaloAxis.html">CaloAxis</a> * <a class="el" href="classCaloCrossCut.html#bf61655ea8330e0c7e4139ab1e3809ec">CaloCrossCut::_yCaloAxis</a><code> [private]</code> </td>
198     </tr>
199     </table>
200     </div>
201     <div class="memdoc">
202    
203     <p>
204    
205     <p>Definition at line <a class="el" href="CaloCrossCut_8h_source.html#l00058">58</a> of file <a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a>.</p>
206    
207     <p>Referenced by <a class="el" href="CaloCrossCut_8cpp_source.html#l00012">Check()</a>.</p>
208    
209     </div>
210     </div><p>
211     <hr>The documentation for this class was generated from the following files:<ul>
212     <li>CaloCuts/CaloCrossCut/<a class="el" href="CaloCrossCut_8h_source.html">CaloCrossCut.h</a><li>CaloCuts/CaloCrossCut/<a class="el" href="CaloCrossCut_8cpp_source.html">CaloCrossCut.cpp</a></ul>
213     </div>
214     <hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 15:21:31 2009 for PamCut by&nbsp;
215     <a href="http://www.doxygen.org/index.html">
216     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
217     </body>
218     </html>
  ViewVC Help
Powered by ViewVC 1.1.23