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

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

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.3 - (hide annotations) (download) (as text)
Fri Sep 25 15:40:46 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 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: PamCut 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>PamCut Class Reference</h1><!-- doxytag: class="PamCut" -->An abstract class to apply cuts to Pamela data.
26     <a href="#_details">More...</a>
27     <p>
28     <code>#include &lt;<a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a>&gt;</code>
29     <p>
30     <div class="dynheader">
31     Inheritance diagram for PamCut:</div>
32     <div class="dynsection">
33    
34     <p><center><img src="classPamCut.png" usemap="#PamCut_map" border="0" alt=""></center>
35     <map name="PamCut_map">
36     <area href="classAbsTimeCut.html" alt="AbsTimeCut" shape="rect" coords="125,56,240,80">
37     <area href="classCaloCrossCut.html" alt="CaloCrossCut" shape="rect" coords="125,112,240,136">
38     <area href="classCaloGeomCut.html" alt="CaloGeomCut" shape="rect" coords="125,168,240,192">
39     <area href="classCaloIonCut.html" alt="CaloIonCut" shape="rect" coords="125,224,240,248">
40     <area href="classCaloNHitCut.html" alt="CaloNHitCut" shape="rect" coords="125,280,240,304">
41     <area href="classCaloNotIntCut.html" alt="CaloNotIntCut" shape="rect" coords="125,336,240,360">
42     <area href="classCaloNucleiZCut.html" alt="CaloNucleiZCut" shape="rect" coords="125,392,240,416">
43     <area href="classCaloTrackChi2Cut.html" alt="CaloTrackChi2Cut" shape="rect" coords="125,448,240,472">
44     <area href="classCaloTrackCut.html" alt="CaloTrackCut" shape="rect" coords="125,504,240,528">
45     <area href="classCARDCut.html" alt="CARDCut" shape="rect" coords="125,560,240,584">
46     <area href="classCATCut.html" alt="CATCut" shape="rect" coords="125,616,240,640">
47     <area href="classDataQualCut.html" alt="DataQualCut" shape="rect" coords="125,672,240,696">
48     <area href="classEvRateS11Cut.html" alt="EvRateS11Cut" shape="rect" coords="125,728,240,752">
49     <area href="classGeoFieldCut.html" alt="GeoFieldCut" shape="rect" coords="125,784,240,808">
50     <area href="classLTGeoFillCut.html" alt="LTGeoFillCut" shape="rect" coords="125,840,240,864">
51     <area href="classLTQualCut.html" alt="LTQualCut" shape="rect" coords="125,896,240,920">
52     <area href="classOBTQualCut.html" alt="OBTQualCut" shape="rect" coords="125,952,240,976">
53     <area href="classPamCutCollection.html" alt="PamCutCollection" shape="rect" coords="125,1008,240,1032">
54     <area href="classPktQualCut.html" alt="PktQualCut" shape="rect" coords="125,1064,240,1088">
55     <area href="classRigFillCut.html" alt="RigFillCut" shape="rect" coords="125,1120,240,1144">
56     <area href="classTofBetaCut.html" alt="TofBetaCut" shape="rect" coords="125,1176,240,1200">
57     <area href="classTofBetaRangeCut.html" alt="TofBetaRangeCut" shape="rect" coords="125,1232,240,1256">
58     <area href="classTofBetaRigCut.html" alt="TofBetaRigCut" shape="rect" coords="125,1288,240,1312">
59     <area href="classTofDedxS1Cut.html" alt="TofDedxS1Cut" shape="rect" coords="125,1344,240,1368">
60     <area href="classTofNucleiZCut.html" alt="TofNucleiZCut" shape="rect" coords="125,1400,240,1424">
61     <area href="classTofPatternCut.html" alt="TofPatternCut" shape="rect" coords="125,1456,240,1480">
62     <area href="classTofQualCut.html" alt="TofQualCut" shape="rect" coords="125,1512,240,1536">
63     <area href="classTofTopS1Cut.html" alt="TofTopS1Cut" shape="rect" coords="125,1568,240,1592">
64     <area href="classTrgConfCut.html" alt="TrgConfCut" shape="rect" coords="125,1624,240,1648">
65     <area href="classTrkCalQualCut.html" alt="TrkCalQualCut" shape="rect" coords="125,1680,240,1704">
66     <area href="classTrkChi2DeflCut.html" alt="TrkChi2DeflCut" shape="rect" coords="125,1736,240,1760">
67     <area href="classTrkChi2QualCut.html" alt="TrkChi2QualCut" shape="rect" coords="125,1792,240,1816">
68     <area href="classTrkDedxHCut.html" alt="TrkDedxHCut" shape="rect" coords="125,1848,240,1872">
69     <area href="classTrkGeomCut.html" alt="TrkGeomCut" shape="rect" coords="125,1904,240,1928">
70     <area href="classTrkHitQualCut.html" alt="TrkHitQualCut" shape="rect" coords="125,1960,240,1984">
71     <area href="classTrkIdCut.html" alt="TrkIdCut" shape="rect" coords="125,2016,240,2040">
72     <area href="classTrkIonCut.html" alt="TrkIonCut" shape="rect" coords="125,2072,240,2096">
73     <area href="classTrkNucleiZCut.html" alt="TrkNucleiZCut" shape="rect" coords="125,2128,240,2152">
74     <area href="classTrkPhSinCut.html" alt="TrkPhSinCut" shape="rect" coords="125,2184,240,2208">
75     <area href="classTrkRigCut.html" alt="TrkRigCut" shape="rect" coords="125,2240,240,2264">
76     <area href="classTrkRigGeoCut.html" alt="TrkRigGeoCut" shape="rect" coords="125,2296,240,2320">
77     <area href="classTrkRigRangeCut.html" alt="TrkRigRangeCut" shape="rect" coords="125,2352,240,2376">
78     <area href="classTrkRunValCut.html" alt="TrkRunValCut" shape="rect" coords="125,2408,240,2432">
79     <area href="classTrkSigmaDeflCut.html" alt="TrkSigmaDeflCut" shape="rect" coords="125,2464,240,2488">
80     </map>
81     </div>
82    
83     <p>
84     <a href="classPamCut-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
85     <tr><td></td></tr>
86     <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
87 pam-fi 1.2 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8192c75b3fe95687f6835100d6ee8b9"></a><!-- doxytag: member="PamCut::PamCut" ref="a8192c75b3fe95687f6835100d6ee8b9" args="(const char *cutName)" -->
88     &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#a8192c75b3fe95687f6835100d6ee8b9">PamCut</a> (const char *cutName)</td></tr>
89 pam-fi 1.1
90 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor. <br></td></tr>
91     <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a6fb3b6ff60cd514fed53c7a9044790"></a><!-- doxytag: member="PamCut::~PamCut" ref="8a6fb3b6ff60cd514fed53c7a9044790" args="()" -->
92     virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#8a6fb3b6ff60cd514fed53c7a9044790">~PamCut</a> ()</td></tr>
93 pam-fi 1.1
94 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
95 pam-fi 1.1 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe">Check</a> (PamLevel2 *event)=0</td></tr>
96    
97     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The basic event check. <a href="#a874600461950d1f2b75ce3938f91cbe"></a><br></td></tr>
98     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#132a1a7cf365ff28eca38b7dda1acb7f">ApplyCut</a> (PamLevel2 *event)</td></tr>
99    
100     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Applies the cut to the current event. <a href="#132a1a7cf365ff28eca38b7dda1acb7f"></a><br></td></tr>
101     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#047b75499ea4457d60397ee5491adcd4">Process</a> (PamLevel2 *events, ULong_t firstEvent, ULong_t lastEvent)</td></tr>
102    
103     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Applies the cut to a range of events. <a href="#047b75499ea4457d60397ee5491adcd4"></a><br></td></tr>
104     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985">OnGood</a> (PamLevel2 *event)</td></tr>
105    
106     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Post-selection tasks. <a href="#56021e959232270c12528ddec3062985"></a><br></td></tr>
107     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#cbb3b507d79f20878fac4392ffa57acb">OnBad</a> (PamLevel2 *event, int selectionResult)</td></tr>
108    
109     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Post-selection tasks. <a href="#cbb3b507d79f20878fac4392ffa57acb"></a><br></td></tr>
110     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual UInt_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#3ae6ebc9dd777e11e0d8ce18948538be">GetNEv</a> ()</td></tr>
111    
112     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of checked events. <a href="#3ae6ebc9dd777e11e0d8ce18948538be"></a><br></td></tr>
113     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual UInt_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#b8a69206312cfcf6df6897aef973ef4a">GetNGood</a> ()</td></tr>
114    
115     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of good events. <a href="#b8a69206312cfcf6df6897aef973ef4a"></a><br></td></tr>
116     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#e587828903b809c99f9ab5ba97ae6616">Setup</a> (PamLevel2 *events)</td></tr>
117    
118     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The pre-analysis task definition. <a href="#e587828903b809c99f9ab5ba97ae6616"></a><br></td></tr>
119     <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#fd74c1565552cabe4aced316df803737">Finalize</a> ()</td></tr>
120    
121     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The post-analysis task definition. <a href="#fd74c1565552cabe4aced316df803737"></a><br></td></tr>
122     <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#9f14d875c176c2af470838a1b6dc069b">GetName</a> () const </td></tr>
123    
124     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the cut name. <a href="#9f14d875c176c2af470838a1b6dc069b"></a><br></td></tr>
125     <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#276bd306ea0a62cc0effa5dea4118e21">SetName</a> (const char *newName)</td></tr>
126    
127     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Changes the cut's name. <a href="#276bd306ea0a62cc0effa5dea4118e21"></a><br></td></tr>
128     <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classPamCut.html">PamCut</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#cff560f2c6a663345c81f95df905956e">operator=</a> (const <a class="el" href="classPamCut.html">PamCut</a> &amp;rightValue)</td></tr>
129    
130     <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The assignment operator. This operator defines how to copy a <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> object into another. In current implementation, it only copies the cut's name of the RHS on the LHS. <a href="#cff560f2c6a663345c81f95df905956e"></a><br></td></tr>
131     <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
132 pam-fi 1.2 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0525bd3c71dbd445f817c163d56562d5"></a><!-- doxytag: member="PamCut::_nEv" ref="0525bd3c71dbd445f817c163d56562d5" args="" -->
133     UInt_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#0525bd3c71dbd445f817c163d56562d5">_nEv</a></td></tr>
134 pam-fi 1.1
135 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of analyzed events. <br></td></tr>
136     <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eacb32030a52b4353861159e3ca098d0"></a><!-- doxytag: member="PamCut::_nGood" ref="eacb32030a52b4353861159e3ca098d0" args="" -->
137     UInt_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classPamCut.html#eacb32030a52b4353861159e3ca098d0">_nGood</a></td></tr>
138 pam-fi 1.1
139 pam-fi 1.2 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The number of good events. <br></td></tr>
140 pam-fi 1.1 </table>
141     <hr><a name="_details"></a><h2>Detailed Description</h2>
142     An abstract class to apply cuts to Pamela data.
143     <p>
144 pam-fi 1.2 This class provides a basic interface for a cut object to apply to PamLevel2 data. <hr><h2>Member Function Documentation</h2>
145 pam-fi 1.1 <a class="anchor" name="132a1a7cf365ff28eca38b7dda1acb7f"></a><!-- doxytag: member="PamCut::ApplyCut" ref="132a1a7cf365ff28eca38b7dda1acb7f" args="(PamLevel2 *event)" -->
146     <div class="memitem">
147     <div class="memproto">
148     <table class="memname">
149     <tr>
150     <td class="memname">int PamCut::ApplyCut </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     Applies the cut to the current event.
163     <p>
164     This routine applies the cut to the currently selected event, eg., it calls <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe" title="The basic event check.">Check()</a> and if the event satisfy the selection it consequently call <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985" title="Post-selection tasks.">OnGood()</a>, otherwise it calls <a class="el" href="classPamCut.html#cbb3b507d79f20878fac4392ffa57acb" title="Post-selection tasks.">OnBad()</a>(this is the only difference with <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe" title="The basic event check.">Check()</a>).<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>same return values as <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe" title="The basic event check.">Check()</a> </dd></dl>
171    
172 pam-fi 1.2 <p>Reimplemented in <a class="el" href="classBlindCutCollection.html#8d387de8cbc54ff0eab8cff220b49c20">BlindCutCollection</a>, <a class="el" href="classSmartBlindCollection.html#1eb231a8a437018bfd966644c7b18ba4">SmartBlindCollection</a>, <a class="el" href="classSmartCollection.html#98213ec078e9b94ea70c72132757da46">SmartCollection</a>, and <a class="el" href="classPamCutCollection.html#e7af429a3afef3685cbd5aa076ef96e5">PamCutCollection</a>.</p>
173 pam-fi 1.1
174     </div>
175     </div><p>
176     <a class="anchor" name="a874600461950d1f2b75ce3938f91cbe"></a><!-- doxytag: member="PamCut::Check" ref="a874600461950d1f2b75ce3938f91cbe" args="(PamLevel2 *event)=0" -->
177     <div class="memitem">
178     <div class="memproto">
179     <table class="memname">
180     <tr>
181     <td class="memname">virtual int PamCut::Check </td>
182     <td>(</td>
183     <td class="paramtype">PamLevel2 *&nbsp;</td>
184     <td class="paramname"> <em>event</em> </td>
185     <td>&nbsp;)&nbsp;</td>
186     <td><code> [pure virtual]</code></td>
187     </tr>
188     </table>
189     </div>
190     <div class="memdoc">
191    
192     <p>
193     The basic event check.
194     <p>
195     This routine applies the cut to the currently selected event, eg., to the event selected by the last PamLevel2::GetEntry() call performed by the object pointed by event. Note that <a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985" title="Post-selection tasks.">OnGood()</a> is not called by this method.<p>
196     <dl compact><dt><b>Parameters:</b></dt><dd>
197     <table border="0" cellspacing="2" cellpadding="0">
198     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event to analyze. </td></tr>
199     </table>
200     </dl>
201     <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 event satisfy the cut, other return values are implementation-specific. </dd></dl>
202    
203     <p>Implemented in <a class="el" href="classCARDCut.html#4862d16f307b0108b2f053b9e8d037d3">CARDCut</a>, <a class="el" href="classCATCut.html#3f0de5d967c8cfe8bc9244720bfaf885">CATCut</a>, <a class="el" href="classCaloCrossCut.html#c79de9378fe4816ef37291da64d5a4f0">CaloCrossCut</a>, <a class="el" href="classCaloGeomCut.html#ef28e99e442a7ab58fb8250107ac82e9">CaloGeomCut</a>, <a class="el" href="classCaloIonCut.html#20a353b53560701ba1ba72db42f48083">CaloIonCut</a>, <a class="el" href="classCaloNHitCut.html#54aae0d5514f7bda15297b9cfdceee68">CaloNHitCut</a>, <a class="el" href="classCaloNotIntCut.html#b2b6fd2f100cc967156633edf18a346a">CaloNotIntCut</a>, <a class="el" href="classCaloNucleiZCut.html#af2ac497ae8c5b356eec8d0cfe8a2c7a">CaloNucleiZCut</a>, <a class="el" href="classCaloTrackChi2Cut.html#63fe6418b40b1908a4a9df6ee2920909">CaloTrackChi2Cut</a>, <a class="el" href="classCaloTrackCut.html#c4b3a9ed9d0436a1cbedb49286ff62f0">CaloTrackCut</a>, <a class="el" href="classBlindCutCollection.html#016ee86612e57a50f03c8469d3ed9d1f">BlindCutCollection</a>, <a class="el" href="classAbsTimeCut.html#f7c55e8b9e801a59ea93f9b5b9212c8c">AbsTimeCut</a>, <a class="el" href="classDataQualCut.html#38d0e630a49d113ba6f7d7cc44a663e6">DataQualCut</a>, <a class="el" href="classEvRateS11Cut.html#196fc98a75f1acc3ddef7dc86b5150a1">EvRateS11Cut</a>, <a class="el" href="classGeoFieldCut.html#edb5a8ed5c91d3f2436fe45e979cc778">GeoFieldCut</a>, <a class="el" href="classLTGeoFillCut.html#aee811750d195e71f676db5e240e7f18">LTGeoFillCut</a>, <a class="el" href="classLTQualCut.html#b38dc0bd6b25f899753b4598c278e6a2">LTQualCut</a>, <a class="el" href="classOBTQualCut.html#7731b6f7e6e08ff629550da311952c6a">OBTQualCut</a>, <a class="el" href="classPktQualCut.html#80b1473a595cd2536ae434212bbe00fc">PktQualCut</a>, <a class="el" href="classTrgConfCut.html#5570ce7035bf8638ad3a59b0cadbec4f">TrgConfCut</a>, <a class="el" href="classPamCutCollection.html#85f04cef7b560a37061391dd397813a7">PamCutCollection</a>, <a class="el" href="classTofBetaCut.html#8be0aa44a411b218f7dcf502b53864ff">TofBetaCut</a>, <a class="el" href="classTofBetaRangeCut.html#e9ee404fb4b3435746113d72c9471ec9">TofBetaRangeCut</a>, <a class="el" href="classTofBetaRigCut.html#661c3a16f981d43c28ccea04242a2a17">TofBetaRigCut</a>, <a class="el" href="classTofDedxS1Cut.html#28eb66874012caa199a3d78bf99c59ae">TofDedxS1Cut</a>, <a class="el" href="classTofNucleiZCut.html#86aa8211e4afee39ff38080347bf651d">TofNucleiZCut</a>, <a class="el" href="classTofPatternCut.html#b960628bc87a72be3c8aedab6b036dce">TofPatternCut</a>, <a class="el" href="classTofQualCut.html#b4b8322f9d91ffc647d4279536c446dc">TofQualCut</a>, <a class="el" href="classTofTopS1Cut.html#cd65ae025a3b089d8ea8c1809c023aba">TofTopS1Cut</a>, <a class="el" href="classRigFillCut.html#5441206a7a24f1f5d19dc1a64685fcd4">RigFillCut</a>, <a class="el" href="classTrkCalQualCut.html#1678dc1c169379f1faf1bb2407b1d99a">TrkCalQualCut</a>, <a class="el" href="classTrkChi2DeflCut.html#9a83aea89ca0147ca956c57fed60c2f4">TrkChi2DeflCut</a>, <a class="el" href="classTrkChi2QualCut.html#b3f014b4575ab61bee63ccf991e91e18">TrkChi2QualCut</a>, <a class="el" href="classTrkDedxHCut.html#2d8cd4ed98f290cb803c9720a42ff376">TrkDedxHCut</a>, <a class="el" href="classTrkGeomCut.html#4fef0bbfb92036676974671133e1ce5a">TrkGeomCut</a>, <a class="el" href="classTrkHitQualCut.html#e4327bc3c511827d3d2bcf0b3ed95f86">TrkHitQualCut</a>, <a class="el" href="classTrkIdCut.html#8c5dd8c6e34bd6234ae9bd3178090508">TrkIdCut</a>, <a class="el" href="classTrkIonCut.html#e96a9561ce59c156b6a913545b0960b9">TrkIonCut</a>, <a class="el" href="classTrkNucleiZCut.html#de47cb3c368d7ab12a8a5236de8915a4">TrkNucleiZCut</a>, <a class="el" href="classTrkPhSinCut.html#c9529432c0c9b8667c5c97ea824a7c93">TrkPhSinCut</a>, <a class="el" href="classTrkRigCut.html#00ddc4658bff1f28065ccb91d3eb43e6">TrkRigCut</a>, <a class="el" href="classTrkRigGeoCut.html#d334792be6ca66d01d75bb2f86a57382">TrkRigGeoCut</a>, <a class="el" href="classTrkRigRangeCut.html#ebebf52705ab17ef48ab12ec6d599c37">TrkRigRangeCut</a>, <a class="el" href="classTrkRunValCut.html#2c76ef62866b009e30b208749cf563f5">TrkRunValCut</a>, and <a class="el" href="classTrkSigmaDeflCut.html#8af1e1457f8c5d33b70aa75816188e72">TrkSigmaDeflCut</a>.</p>
204    
205     </div>
206     </div><p>
207     <a class="anchor" name="fd74c1565552cabe4aced316df803737"></a><!-- doxytag: member="PamCut::Finalize" ref="fd74c1565552cabe4aced316df803737" args="()" -->
208     <div class="memitem">
209     <div class="memproto">
210     <table class="memname">
211     <tr>
212     <td class="memname">virtual void PamCut::Finalize </td>
213     <td>(</td>
214     <td class="paramname"> </td>
215     <td>&nbsp;)&nbsp;</td>
216     <td><code> [inline, virtual]</code></td>
217     </tr>
218     </table>
219     </div>
220     <div class="memdoc">
221    
222     <p>
223     The post-analysis task definition.
224     <p>
225     This method is automatically called by <a class="el" href="classPamCut.html#047b75499ea4457d60397ee5491adcd4" title="Applies the cut to a range of events.">Process()</a> after the event selection has been performed; override this in derived classes to perform post-analysis tasks like writing histograms, closing files and so on.
226 pam-fi 1.2 <p>Reimplemented in <a class="el" href="classSmartCollection.html#8105730615ad127a482a7fb399695977">SmartCollection</a>, <a class="el" href="classVerboseBlindCollection.html#43d6ea7b5ea35c5dbb342e23584b79ee">VerboseBlindCollection</a>, <a class="el" href="classVerboseCollection.html#3fcdf28d50507d772647d4306a78f3cc">VerboseCollection</a>, and <a class="el" href="classPamCutCollection.html#15785c75fb13b998422739e741bb5c01">PamCutCollection</a>.</p>
227 pam-fi 1.1
228     </div>
229     </div><p>
230     <a class="anchor" name="9f14d875c176c2af470838a1b6dc069b"></a><!-- doxytag: member="PamCut::GetName" ref="9f14d875c176c2af470838a1b6dc069b" args="() const " -->
231     <div class="memitem">
232     <div class="memproto">
233     <table class="memname">
234     <tr>
235     <td class="memname">const char * PamCut::GetName </td>
236     <td>(</td>
237     <td class="paramname"> </td>
238     <td>&nbsp;)&nbsp;</td>
239     <td> const</td>
240     </tr>
241     </table>
242     </div>
243     <div class="memdoc">
244    
245     <p>
246     Returns the cut name.
247     <p>
248     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The cut name. </dd></dl>
249    
250     </div>
251     </div><p>
252     <a class="anchor" name="3ae6ebc9dd777e11e0d8ce18948538be"></a><!-- doxytag: member="PamCut::GetNEv" ref="3ae6ebc9dd777e11e0d8ce18948538be" args="()" -->
253     <div class="memitem">
254     <div class="memproto">
255     <table class="memname">
256     <tr>
257     <td class="memname">virtual UInt_t PamCut::GetNEv </td>
258     <td>(</td>
259     <td class="paramname"> </td>
260     <td>&nbsp;)&nbsp;</td>
261     <td><code> [inline, virtual]</code></td>
262     </tr>
263     </table>
264     </div>
265     <div class="memdoc">
266    
267     <p>
268     Returns the number of checked events.
269     <p>
270     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of checked events. </dd></dl>
271    
272     </div>
273     </div><p>
274     <a class="anchor" name="b8a69206312cfcf6df6897aef973ef4a"></a><!-- doxytag: member="PamCut::GetNGood" ref="b8a69206312cfcf6df6897aef973ef4a" args="()" -->
275     <div class="memitem">
276     <div class="memproto">
277     <table class="memname">
278     <tr>
279     <td class="memname">virtual UInt_t PamCut::GetNGood </td>
280     <td>(</td>
281     <td class="paramname"> </td>
282     <td>&nbsp;)&nbsp;</td>
283     <td><code> [inline, virtual]</code></td>
284     </tr>
285     </table>
286     </div>
287     <div class="memdoc">
288    
289     <p>
290     Returns the number of good events.
291     <p>
292     This counter keeps track of how many events have fulfilled the conditions specified in Check.<p>
293     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of good events. </dd></dl>
294    
295     </div>
296     </div><p>
297     <a class="anchor" name="cbb3b507d79f20878fac4392ffa57acb"></a><!-- doxytag: member="PamCut::OnBad" ref="cbb3b507d79f20878fac4392ffa57acb" args="(PamLevel2 *event, int selectionResult)" -->
298     <div class="memitem">
299     <div class="memproto">
300     <table class="memname">
301     <tr>
302     <td class="memname">virtual void PamCut::OnBad </td>
303     <td>(</td>
304     <td class="paramtype">PamLevel2 *&nbsp;</td>
305     <td class="paramname"> <em>event</em>, </td>
306     </tr>
307     <tr>
308     <td class="paramkey"></td>
309     <td></td>
310     <td class="paramtype">int&nbsp;</td>
311     <td class="paramname"> <em>selectionResult</em></td><td>&nbsp;</td>
312     </tr>
313     <tr>
314     <td></td>
315     <td>)</td>
316     <td></td><td></td><td><code> [inline, virtual]</code></td>
317     </tr>
318     </table>
319     </div>
320     <div class="memdoc">
321    
322     <p>
323     Post-selection tasks.
324     <p>
325     The post-selection tasks for bad events (ie., not satisfying the cut) can be defined here.<p>
326     <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPamCut.html#56021e959232270c12528ddec3062985" title="Post-selection tasks.">OnGood</a> </dd></dl>
327     <dl compact><dt><b>Parameters:</b></dt><dd>
328     <table border="0" cellspacing="2" cellpadding="0">
329     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event which don't satisfy the cut. </td></tr>
330     <tr><td valign="top"></td><td valign="top"><em>selectionResult</em>&nbsp;</td><td>The return value of the <a class="el" href="classPamCut.html#a874600461950d1f2b75ce3938f91cbe" title="The basic event check.">Check()</a> routine. </td></tr>
331     </table>
332     </dl>
333    
334     </div>
335     </div><p>
336     <a class="anchor" name="56021e959232270c12528ddec3062985"></a><!-- doxytag: member="PamCut::OnGood" ref="56021e959232270c12528ddec3062985" args="(PamLevel2 *event)" -->
337     <div class="memitem">
338     <div class="memproto">
339     <table class="memname">
340     <tr>
341     <td class="memname">virtual void PamCut::OnGood </td>
342     <td>(</td>
343     <td class="paramtype">PamLevel2 *&nbsp;</td>
344     <td class="paramname"> <em>event</em> </td>
345     <td>&nbsp;)&nbsp;</td>
346     <td><code> [inline, virtual]</code></td>
347     </tr>
348     </table>
349     </div>
350     <div class="memdoc">
351    
352     <p>
353     Post-selection tasks.
354     <p>
355     Here the post-selection actions (histogram filling, parameter calculation etc.) can be defined. This routine is automatically called after a good event has been selected by <a class="el" href="classPamCut.html#132a1a7cf365ff28eca38b7dda1acb7f" title="Applies the cut to the current event.">ApplyCut()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
356     <table border="0" cellspacing="2" cellpadding="0">
357     <tr><td valign="top"></td><td valign="top"><em>event</em>&nbsp;</td><td>The event which satisfy the cut. </td></tr>
358     </table>
359     </dl>
360    
361 pam-fi 1.2 <p>Reimplemented in <a class="el" href="classLTGeoFillCut.html#17593f86005dd51a09a637232797c925">LTGeoFillCut</a>, and <a class="el" href="classRigFillCut.html#537f1b31f208ebe8f190f254be1fdc6c">RigFillCut</a>.</p>
362 pam-fi 1.1
363     </div>
364     </div><p>
365     <a class="anchor" name="cff560f2c6a663345c81f95df905956e"></a><!-- doxytag: member="PamCut::operator=" ref="cff560f2c6a663345c81f95df905956e" args="(const PamCut &amp;rightValue)" -->
366     <div class="memitem">
367     <div class="memproto">
368     <table class="memname">
369     <tr>
370     <td class="memname"><a class="el" href="classPamCut.html">PamCut</a> &amp; PamCut::operator= </td>
371     <td>(</td>
372     <td class="paramtype">const <a class="el" href="classPamCut.html">PamCut</a> &amp;&nbsp;</td>
373     <td class="paramname"> <em>rightValue</em> </td>
374     <td>&nbsp;)&nbsp;</td>
375     <td></td>
376     </tr>
377     </table>
378     </div>
379     <div class="memdoc">
380    
381     <p>
382     The assignment operator. This operator defines how to copy a <a class="el" href="classPamCut.html" title="An abstract class to apply cuts to Pamela data.">PamCut</a> object into another. In current implementation, it only copies the cut's name of the RHS on the LHS.
383     <p>
384     <dl compact><dt><b>Parameters:</b></dt><dd>
385     <table border="0" cellspacing="2" cellpadding="0">
386     <tr><td valign="top"></td><td valign="top"><em>rightValue</em>&nbsp;</td><td>The RHS. </td></tr>
387     </table>
388     </dl>
389     <dl class="return" compact><dt><b>Returns:</b></dt><dd>The new value for LHS. </dd></dl>
390    
391     </div>
392     </div><p>
393     <a class="anchor" name="047b75499ea4457d60397ee5491adcd4"></a><!-- doxytag: member="PamCut::Process" ref="047b75499ea4457d60397ee5491adcd4" args="(PamLevel2 *events, ULong_t firstEvent, ULong_t lastEvent)" -->
394     <div class="memitem">
395     <div class="memproto">
396     <table class="memname">
397     <tr>
398     <td class="memname">void PamCut::Process </td>
399     <td>(</td>
400     <td class="paramtype">PamLevel2 *&nbsp;</td>
401     <td class="paramname"> <em>events</em>, </td>
402     </tr>
403     <tr>
404     <td class="paramkey"></td>
405     <td></td>
406     <td class="paramtype">ULong_t&nbsp;</td>
407     <td class="paramname"> <em>firstEvent</em>, </td>
408     </tr>
409     <tr>
410     <td class="paramkey"></td>
411     <td></td>
412     <td class="paramtype">ULong_t&nbsp;</td>
413     <td class="paramname"> <em>lastEvent</em></td><td>&nbsp;</td>
414     </tr>
415     <tr>
416     <td></td>
417     <td>)</td>
418     <td></td><td></td><td><code> [virtual]</code></td>
419     </tr>
420     </table>
421     </div>
422     <div class="memdoc">
423    
424     <p>
425     Applies the cut to a range of events.
426     <p>
427     This method resets the counters calling Reset() and then calls <a class="el" href="classPamCut.html#132a1a7cf365ff28eca38b7dda1acb7f" title="Applies the cut to the current event.">ApplyCut(PamLevel2 *event)</a> for all the events in PamLevel2 argument inside the specified range. After checking all the events, it calls the private method _Finalize(), on which the tasks to be performed after the selection can be defined.<p>
428     <dl compact><dt><b>Parameters:</b></dt><dd>
429     <table border="0" cellspacing="2" cellpadding="0">
430     <tr><td valign="top"></td><td valign="top"><em>events</em>&nbsp;</td><td>Pointer to PamLevel2 object which contains the events. </td></tr>
431     <tr><td valign="top"></td><td valign="top"><em>firstEvent</em>&nbsp;</td><td>The first event to analyze. Possible values range from 0 to #events - 1. </td></tr>
432     <tr><td valign="top"></td><td valign="top"><em>lastEvent</em>&nbsp;</td><td>The last event to analyze. </td></tr>
433     </table>
434     </dl>
435    
436     </div>
437     </div><p>
438     <a class="anchor" name="276bd306ea0a62cc0effa5dea4118e21"></a><!-- doxytag: member="PamCut::SetName" ref="276bd306ea0a62cc0effa5dea4118e21" args="(const char *newName)" -->
439     <div class="memitem">
440     <div class="memproto">
441     <table class="memname">
442     <tr>
443     <td class="memname">void PamCut::SetName </td>
444     <td>(</td>
445     <td class="paramtype">const char *&nbsp;</td>
446     <td class="paramname"> <em>newName</em> </td>
447     <td>&nbsp;)&nbsp;</td>
448     <td></td>
449     </tr>
450     </table>
451     </div>
452     <div class="memdoc">
453    
454     <p>
455     Changes the cut's name.
456     <p>
457     <dl compact><dt><b>Parameters:</b></dt><dd>
458     <table border="0" cellspacing="2" cellpadding="0">
459     <tr><td valign="top"></td><td valign="top"><em>newName</em>&nbsp;</td><td>The new name. </td></tr>
460     </table>
461     </dl>
462    
463     </div>
464     </div><p>
465     <a class="anchor" name="e587828903b809c99f9ab5ba97ae6616"></a><!-- doxytag: member="PamCut::Setup" ref="e587828903b809c99f9ab5ba97ae6616" args="(PamLevel2 *events)" -->
466     <div class="memitem">
467     <div class="memproto">
468     <table class="memname">
469     <tr>
470     <td class="memname">void PamCut::Setup </td>
471     <td>(</td>
472     <td class="paramtype">PamLevel2 *&nbsp;</td>
473     <td class="paramname"> <em>events</em> </td>
474     <td>&nbsp;)&nbsp;</td>
475     <td><code> [virtual]</code></td>
476     </tr>
477     </table>
478     </div>
479     <div class="memdoc">
480    
481     <p>
482     The pre-analysis task definition.
483     <p>
484     This method is automatically called by <a class="el" href="classPamCut.html#047b75499ea4457d60397ee5491adcd4" title="Applies the cut to a range of events.">Process()</a> before the event selection; override this in derived classes to perform pre-analysis tasks like opening files and so on. In this base class implementation it only resets the counters for examined and good events. The parameter PamLevel2 *events may serve to initialize the analysis (even if in this base class implementation it is unused), so the interface includes it.<p>
485     <dl compact><dt><b>Parameters:</b></dt><dd>
486     <table border="0" cellspacing="2" cellpadding="0">
487     <tr><td valign="top"></td><td valign="top"><em>events</em>&nbsp;</td><td>The PamLevel2 pointer to the events that will be analyzed.</td></tr>
488     </table>
489     </dl>
490     <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classPamCut.html#3ae6ebc9dd777e11e0d8ce18948538be" title="Returns the number of checked events.">GetNEv()</a>, <a class="el" href="classPamCut.html#b8a69206312cfcf6df6897aef973ef4a" title="Returns the number of good events.">GetNGood()</a>. </dd></dl>
491    
492 pam-fi 1.2 <p>Reimplemented in <a class="el" href="classSmartCollection.html#9b5b11a854b9e174218ea516ceffb34c">SmartCollection</a>, and <a class="el" href="classPamCutCollection.html#982821389af5e585688611d733b3a7b0">PamCutCollection</a>.</p>
493 pam-fi 1.1
494     </div>
495     </div><p>
496     <hr>The documentation for this class was generated from the following files:<ul>
497 pam-fi 1.2 <li>PamCutBase/<a class="el" href="PamCutBase_8h_source.html">PamCutBase.h</a><li>PamCutBase/<a class="el" href="PamCutBase_8cpp.html">PamCutBase.cpp</a></ul>
498 pam-fi 1.1 </div>
499 pam-fi 1.2 <hr size="1"><address style="text-align: right;"><small>Generated on Fri Jun 5 15:09:03 2009 for PamCut by&nbsp;
500 pam-fi 1.1 <a href="http://www.doxygen.org/index.html">
501     <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
502     </body>
503     </html>
  ViewVC Help
Powered by ViewVC 1.1.23