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

Annotation of /PamCut/doc/Doxygen/latex/classPamCut.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations) (download) (as text)
Fri Jun 5 13:14:57 2009 UTC (15 years, 9 months ago) by pam-fi
Branch: MAIN
Changes since 1.1: +28 -146 lines
File MIME type: application/x-tex
Updated.

1 pam-fi 1.1 \hypertarget{classPamCut}{
2     \section{PamCut Class Reference}
3     \label{classPamCut}\index{PamCut@{PamCut}}
4     }
5     An abstract class to apply cuts to Pamela data.
6    
7    
8     {\tt \#include $<$PamCutBase.h$>$}
9    
10     Inheritance diagram for PamCut::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=12cm]{classPamCut}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19 pam-fi 1.2 \hypertarget{classPamCut_a8192c75b3fe95687f6835100d6ee8b9}{
20     \hyperlink{classPamCut_a8192c75b3fe95687f6835100d6ee8b9}{PamCut} (const char $\ast$cutName)}
21     \label{classPamCut_a8192c75b3fe95687f6835100d6ee8b9}
22    
23 pam-fi 1.1 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
24 pam-fi 1.2 \hypertarget{classPamCut_8a6fb3b6ff60cd514fed53c7a9044790}{
25     virtual \hyperlink{classPamCut_8a6fb3b6ff60cd514fed53c7a9044790}{$\sim$PamCut} ()}
26     \label{classPamCut_8a6fb3b6ff60cd514fed53c7a9044790}
27    
28 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
29     virtual int \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check} (PamLevel2 $\ast$event)=0
30     \begin{CompactList}\small\item\em The basic event check. \item\end{CompactList}\item
31     virtual int \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{ApplyCut} (PamLevel2 $\ast$event)
32     \begin{CompactList}\small\item\em Applies the cut to the current event. \item\end{CompactList}\item
33     virtual void \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process} (PamLevel2 $\ast$events, ULong\_\-t firstEvent, ULong\_\-t lastEvent)
34     \begin{CompactList}\small\item\em Applies the cut to a range of events. \item\end{CompactList}\item
35     virtual void \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{OnGood} (PamLevel2 $\ast$event)
36     \begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\item
37     virtual void \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{OnBad} (PamLevel2 $\ast$event, int selectionResult)
38     \begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\item
39     virtual UInt\_\-t \hyperlink{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}{GetNEv} ()
40     \begin{CompactList}\small\item\em Returns the number of checked events. \item\end{CompactList}\item
41     virtual UInt\_\-t \hyperlink{classPamCut_b8a69206312cfcf6df6897aef973ef4a}{GetNGood} ()
42     \begin{CompactList}\small\item\em Returns the number of good events. \item\end{CompactList}\item
43     virtual void \hyperlink{classPamCut_e587828903b809c99f9ab5ba97ae6616}{Setup} (PamLevel2 $\ast$events)
44     \begin{CompactList}\small\item\em The pre-analysis task definition. \item\end{CompactList}\item
45     virtual void \hyperlink{classPamCut_fd74c1565552cabe4aced316df803737}{Finalize} ()
46     \begin{CompactList}\small\item\em The post-analysis task definition. \item\end{CompactList}\item
47     const char $\ast$ \hyperlink{classPamCut_9f14d875c176c2af470838a1b6dc069b}{GetName} () const
48     \begin{CompactList}\small\item\em Returns the cut name. \item\end{CompactList}\item
49     void \hyperlink{classPamCut_276bd306ea0a62cc0effa5dea4118e21}{SetName} (const char $\ast$newName)
50     \begin{CompactList}\small\item\em Changes the cut's name. \item\end{CompactList}\item
51     \hyperlink{classPamCut}{PamCut} \& \hyperlink{classPamCut_cff560f2c6a663345c81f95df905956e}{operator=} (const \hyperlink{classPamCut}{PamCut} \&rightValue)
52     \begin{CompactList}\small\item\em The assignment operator. This operator defines how to copy a \hyperlink{classPamCut}{PamCut} object into another. In current implementation, it only copies the cut's name of the RHS on the LHS. \item\end{CompactList}\end{CompactItemize}
53     \subsection*{Protected Attributes}
54     \begin{CompactItemize}
55     \item
56 pam-fi 1.2 \hypertarget{classPamCut_0525bd3c71dbd445f817c163d56562d5}{
57     UInt\_\-t \hyperlink{classPamCut_0525bd3c71dbd445f817c163d56562d5}{\_\-nEv}}
58     \label{classPamCut_0525bd3c71dbd445f817c163d56562d5}
59    
60 pam-fi 1.1 \begin{CompactList}\small\item\em The number of analyzed events. \item\end{CompactList}\item
61 pam-fi 1.2 \hypertarget{classPamCut_eacb32030a52b4353861159e3ca098d0}{
62     UInt\_\-t \hyperlink{classPamCut_eacb32030a52b4353861159e3ca098d0}{\_\-nGood}}
63     \label{classPamCut_eacb32030a52b4353861159e3ca098d0}
64    
65 pam-fi 1.1 \begin{CompactList}\small\item\em The number of good events. \item\end{CompactList}\end{CompactItemize}
66    
67    
68     \subsection{Detailed Description}
69     An abstract class to apply cuts to Pamela data.
70    
71     This class provides a basic interface for a cut object to apply to PamLevel2 data.
72    
73     \subsection{Member Function Documentation}
74     \hypertarget{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{
75     \index{PamCut@{PamCut}!ApplyCut@{ApplyCut}}
76     \index{ApplyCut@{ApplyCut}!PamCut@{PamCut}}
77     \subsubsection[{ApplyCut}]{\setlength{\rightskip}{0pt plus 5cm}int PamCut::ApplyCut (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
78     \label{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}
79    
80    
81     Applies the cut to the current event.
82    
83     This routine applies the cut to the currently selected event, eg., it calls \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check()} and if the event satisfy the selection it consequently call \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{OnGood()}, otherwise it calls \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{OnBad()}(this is the only difference with \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check()}).
84    
85     \begin{Desc}
86     \item[Parameters:]
87     \begin{description}
88     \item[{\em event}]The event to analyze. \end{description}
89     \end{Desc}
90     \begin{Desc}
91     \item[Returns:]same return values as \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check()} \end{Desc}
92    
93    
94 pam-fi 1.2 Reimplemented in \hyperlink{classBlindCutCollection_8d387de8cbc54ff0eab8cff220b49c20}{BlindCutCollection}, \hyperlink{classSmartBlindCollection_1eb231a8a437018bfd966644c7b18ba4}{SmartBlindCollection}, \hyperlink{classSmartCollection_98213ec078e9b94ea70c72132757da46}{SmartCollection}, and \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{PamCutCollection}.\hypertarget{classPamCut_a874600461950d1f2b75ce3938f91cbe}{
95 pam-fi 1.1 \index{PamCut@{PamCut}!Check@{Check}}
96     \index{Check@{Check}!PamCut@{PamCut}}
97     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}virtual int PamCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}pure virtual\mbox{]}}}}
98     \label{classPamCut_a874600461950d1f2b75ce3938f91cbe}
99    
100    
101     The basic event check.
102    
103     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 \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{OnGood()} is not called by this method.
104    
105     \begin{Desc}
106     \item[Parameters:]
107     \begin{description}
108     \item[{\em event}]The event to analyze. \end{description}
109     \end{Desc}
110     \begin{Desc}
111     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event satisfy the cut, other return values are implementation-specific. \end{Desc}
112    
113    
114 pam-fi 1.2 Implemented in \hyperlink{classCARDCut_4862d16f307b0108b2f053b9e8d037d3}{CARDCut}, \hyperlink{classCATCut_3f0de5d967c8cfe8bc9244720bfaf885}{CATCut}, \hyperlink{classCaloCrossCut_c79de9378fe4816ef37291da64d5a4f0}{CaloCrossCut}, \hyperlink{classCaloGeomCut_ef28e99e442a7ab58fb8250107ac82e9}{CaloGeomCut}, \hyperlink{classCaloIonCut_20a353b53560701ba1ba72db42f48083}{CaloIonCut}, \hyperlink{classCaloNHitCut_54aae0d5514f7bda15297b9cfdceee68}{CaloNHitCut}, \hyperlink{classCaloNotIntCut_b2b6fd2f100cc967156633edf18a346a}{CaloNotIntCut}, \hyperlink{classCaloNucleiZCut_af2ac497ae8c5b356eec8d0cfe8a2c7a}{CaloNucleiZCut}, \hyperlink{classCaloTrackChi2Cut_63fe6418b40b1908a4a9df6ee2920909}{CaloTrackChi2Cut}, \hyperlink{classCaloTrackCut_c4b3a9ed9d0436a1cbedb49286ff62f0}{CaloTrackCut}, \hyperlink{classBlindCutCollection_016ee86612e57a50f03c8469d3ed9d1f}{BlindCutCollection}, \hyperlink{classAbsTimeCut_f7c55e8b9e801a59ea93f9b5b9212c8c}{AbsTimeCut}, \hyperlink{classDataQualCut_38d0e630a49d113ba6f7d7cc44a663e6}{DataQualCut}, \hyperlink{classEvRateS11Cut_196fc98a75f1acc3ddef7dc86b5150a1}{EvRateS11Cut}, \hyperlink{classGeoFieldCut_edb5a8ed5c91d3f2436fe45e979cc778}{GeoFieldCut}, \hyperlink{classLTGeoFillCut_aee811750d195e71f676db5e240e7f18}{LTGeoFillCut}, \hyperlink{classLTQualCut_b38dc0bd6b25f899753b4598c278e6a2}{LTQualCut}, \hyperlink{classOBTQualCut_7731b6f7e6e08ff629550da311952c6a}{OBTQualCut}, \hyperlink{classPktQualCut_80b1473a595cd2536ae434212bbe00fc}{PktQualCut}, \hyperlink{classTrgConfCut_5570ce7035bf8638ad3a59b0cadbec4f}{TrgConfCut}, \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{PamCutCollection}, \hyperlink{classTofBetaCut_8be0aa44a411b218f7dcf502b53864ff}{TofBetaCut}, \hyperlink{classTofBetaRangeCut_e9ee404fb4b3435746113d72c9471ec9}{TofBetaRangeCut}, \hyperlink{classTofBetaRigCut_661c3a16f981d43c28ccea04242a2a17}{TofBetaRigCut}, \hyperlink{classTofDedxS1Cut_28eb66874012caa199a3d78bf99c59ae}{TofDedxS1Cut}, \hyperlink{classTofNucleiZCut_86aa8211e4afee39ff38080347bf651d}{TofNucleiZCut}, \hyperlink{classTofPatternCut_b960628bc87a72be3c8aedab6b036dce}{TofPatternCut}, \hyperlink{classTofQualCut_b4b8322f9d91ffc647d4279536c446dc}{TofQualCut}, \hyperlink{classTofTopS1Cut_cd65ae025a3b089d8ea8c1809c023aba}{TofTopS1Cut}, \hyperlink{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}{RigFillCut}, \hyperlink{classTrkCalQualCut_1678dc1c169379f1faf1bb2407b1d99a}{TrkCalQualCut}, \hyperlink{classTrkChi2DeflCut_9a83aea89ca0147ca956c57fed60c2f4}{TrkChi2DeflCut}, \hyperlink{classTrkChi2QualCut_b3f014b4575ab61bee63ccf991e91e18}{TrkChi2QualCut}, \hyperlink{classTrkDedxHCut_2d8cd4ed98f290cb803c9720a42ff376}{TrkDedxHCut}, \hyperlink{classTrkGeomCut_4fef0bbfb92036676974671133e1ce5a}{TrkGeomCut}, \hyperlink{classTrkHitQualCut_e4327bc3c511827d3d2bcf0b3ed95f86}{TrkHitQualCut}, \hyperlink{classTrkIdCut_8c5dd8c6e34bd6234ae9bd3178090508}{TrkIdCut}, \hyperlink{classTrkIonCut_e96a9561ce59c156b6a913545b0960b9}{TrkIonCut}, \hyperlink{classTrkNucleiZCut_de47cb3c368d7ab12a8a5236de8915a4}{TrkNucleiZCut}, \hyperlink{classTrkPhSinCut_c9529432c0c9b8667c5c97ea824a7c93}{TrkPhSinCut}, \hyperlink{classTrkRigCut_00ddc4658bff1f28065ccb91d3eb43e6}{TrkRigCut}, \hyperlink{classTrkRigGeoCut_d334792be6ca66d01d75bb2f86a57382}{TrkRigGeoCut}, \hyperlink{classTrkRigRangeCut_ebebf52705ab17ef48ab12ec6d599c37}{TrkRigRangeCut}, \hyperlink{classTrkRunValCut_2c76ef62866b009e30b208749cf563f5}{TrkRunValCut}, and \hyperlink{classTrkSigmaDeflCut_8af1e1457f8c5d33b70aa75816188e72}{TrkSigmaDeflCut}.\hypertarget{classPamCut_fd74c1565552cabe4aced316df803737}{
115 pam-fi 1.1 \index{PamCut@{PamCut}!Finalize@{Finalize}}
116     \index{Finalize@{Finalize}!PamCut@{PamCut}}
117     \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}virtual void PamCut::Finalize ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
118     \label{classPamCut_fd74c1565552cabe4aced316df803737}
119    
120    
121     The post-analysis task definition.
122    
123     This method is automatically called by \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process()} 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.
124    
125 pam-fi 1.2 Reimplemented in \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}, \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}, and \hyperlink{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{PamCutCollection}.\hypertarget{classPamCut_9f14d875c176c2af470838a1b6dc069b}{
126 pam-fi 1.1 \index{PamCut@{PamCut}!GetName@{GetName}}
127     \index{GetName@{GetName}!PamCut@{PamCut}}
128     \subsubsection[{GetName}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ PamCut::GetName () const}}
129     \label{classPamCut_9f14d875c176c2af470838a1b6dc069b}
130    
131    
132     Returns the cut name.
133    
134     \begin{Desc}
135     \item[Returns:]The cut name. \end{Desc}
136 pam-fi 1.2 \hypertarget{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}{
137 pam-fi 1.1 \index{PamCut@{PamCut}!GetNEv@{GetNEv}}
138     \index{GetNEv@{GetNEv}!PamCut@{PamCut}}
139     \subsubsection[{GetNEv}]{\setlength{\rightskip}{0pt plus 5cm}virtual UInt\_\-t PamCut::GetNEv ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
140     \label{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}
141    
142    
143     Returns the number of checked events.
144    
145     \begin{Desc}
146     \item[Returns:]The number of checked events. \end{Desc}
147 pam-fi 1.2 \hypertarget{classPamCut_b8a69206312cfcf6df6897aef973ef4a}{
148 pam-fi 1.1 \index{PamCut@{PamCut}!GetNGood@{GetNGood}}
149     \index{GetNGood@{GetNGood}!PamCut@{PamCut}}
150     \subsubsection[{GetNGood}]{\setlength{\rightskip}{0pt plus 5cm}virtual UInt\_\-t PamCut::GetNGood ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
151     \label{classPamCut_b8a69206312cfcf6df6897aef973ef4a}
152    
153    
154     Returns the number of good events.
155    
156     This counter keeps track of how many events have fulfilled the conditions specified in Check.
157    
158     \begin{Desc}
159     \item[Returns:]The number of good events. \end{Desc}
160 pam-fi 1.2 \hypertarget{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{
161 pam-fi 1.1 \index{PamCut@{PamCut}!OnBad@{OnBad}}
162     \index{OnBad@{OnBad}!PamCut@{PamCut}}
163     \subsubsection[{OnBad}]{\setlength{\rightskip}{0pt plus 5cm}virtual void PamCut::OnBad (PamLevel2 $\ast$ {\em event}, \/ int {\em selectionResult})\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
164     \label{classPamCut_cbb3b507d79f20878fac4392ffa57acb}
165    
166    
167     Post-selection tasks.
168    
169     The post-selection tasks for bad events (ie., not satisfying the cut) can be defined here.
170    
171     \begin{Desc}
172     \item[See also:]\hyperlink{classPamCut_56021e959232270c12528ddec3062985}{OnGood} \end{Desc}
173     \begin{Desc}
174     \item[Parameters:]
175     \begin{description}
176     \item[{\em event}]The event which don't satisfy the cut. \item[{\em selectionResult}]The return value of the \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check()} routine. \end{description}
177     \end{Desc}
178 pam-fi 1.2 \hypertarget{classPamCut_56021e959232270c12528ddec3062985}{
179 pam-fi 1.1 \index{PamCut@{PamCut}!OnGood@{OnGood}}
180     \index{OnGood@{OnGood}!PamCut@{PamCut}}
181     \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}virtual void PamCut::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
182     \label{classPamCut_56021e959232270c12528ddec3062985}
183    
184    
185     Post-selection tasks.
186    
187     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 \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{ApplyCut()}. \begin{Desc}
188     \item[Parameters:]
189     \begin{description}
190     \item[{\em event}]The event which satisfy the cut. \end{description}
191     \end{Desc}
192    
193    
194 pam-fi 1.2 Reimplemented in \hyperlink{classLTGeoFillCut_17593f86005dd51a09a637232797c925}{LTGeoFillCut}, and \hyperlink{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}{RigFillCut}.\hypertarget{classPamCut_cff560f2c6a663345c81f95df905956e}{
195 pam-fi 1.1 \index{PamCut@{PamCut}!operator=@{operator=}}
196     \index{operator=@{operator=}!PamCut@{PamCut}}
197     \subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCut} \& PamCut::operator= (const {\bf PamCut} \& {\em rightValue})}}
198     \label{classPamCut_cff560f2c6a663345c81f95df905956e}
199    
200    
201     The assignment operator. This operator defines how to copy a \hyperlink{classPamCut}{PamCut} object into another. In current implementation, it only copies the cut's name of the RHS on the LHS.
202    
203     \begin{Desc}
204     \item[Parameters:]
205     \begin{description}
206     \item[{\em rightValue}]The RHS. \end{description}
207     \end{Desc}
208     \begin{Desc}
209     \item[Returns:]The new value for LHS. \end{Desc}
210 pam-fi 1.2 \hypertarget{classPamCut_047b75499ea4457d60397ee5491adcd4}{
211 pam-fi 1.1 \index{PamCut@{PamCut}!Process@{Process}}
212     \index{Process@{Process}!PamCut@{PamCut}}
213     \subsubsection[{Process}]{\setlength{\rightskip}{0pt plus 5cm}void PamCut::Process (PamLevel2 $\ast$ {\em events}, \/ ULong\_\-t {\em firstEvent}, \/ ULong\_\-t {\em lastEvent})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
214     \label{classPamCut_047b75499ea4457d60397ee5491adcd4}
215    
216    
217     Applies the cut to a range of events.
218    
219     This method resets the counters calling Reset() and then calls \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{ApplyCut(PamLevel2 $\ast$event)} 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.
220    
221     \begin{Desc}
222     \item[Parameters:]
223     \begin{description}
224     \item[{\em events}]Pointer to PamLevel2 object which contains the events. \item[{\em firstEvent}]The first event to analyze. Possible values range from 0 to \#events - 1. \item[{\em lastEvent}]The last event to analyze. \end{description}
225     \end{Desc}
226 pam-fi 1.2 \hypertarget{classPamCut_276bd306ea0a62cc0effa5dea4118e21}{
227 pam-fi 1.1 \index{PamCut@{PamCut}!SetName@{SetName}}
228     \index{SetName@{SetName}!PamCut@{PamCut}}
229     \subsubsection[{SetName}]{\setlength{\rightskip}{0pt plus 5cm}void PamCut::SetName (const char $\ast$ {\em newName})}}
230     \label{classPamCut_276bd306ea0a62cc0effa5dea4118e21}
231    
232    
233     Changes the cut's name.
234    
235     \begin{Desc}
236     \item[Parameters:]
237     \begin{description}
238     \item[{\em newName}]The new name. \end{description}
239     \end{Desc}
240 pam-fi 1.2 \hypertarget{classPamCut_e587828903b809c99f9ab5ba97ae6616}{
241 pam-fi 1.1 \index{PamCut@{PamCut}!Setup@{Setup}}
242     \index{Setup@{Setup}!PamCut@{PamCut}}
243     \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void PamCut::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
244     \label{classPamCut_e587828903b809c99f9ab5ba97ae6616}
245    
246    
247     The pre-analysis task definition.
248    
249     This method is automatically called by \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process()} 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 $\ast$events may serve to initialize the analysis (even if in this base class implementation it is unused), so the interface includes it.
250    
251     \begin{Desc}
252     \item[Parameters:]
253     \begin{description}
254     \item[{\em events}]The PamLevel2 pointer to the events that will be analyzed.\end{description}
255     \end{Desc}
256     \begin{Desc}
257     \item[See also:]\hyperlink{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}{GetNEv()}, \hyperlink{classPamCut_b8a69206312cfcf6df6897aef973ef4a}{GetNGood()}. \end{Desc}
258    
259    
260 pam-fi 1.2 Reimplemented in \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{SmartCollection}, and \hyperlink{classPamCutCollection_982821389af5e585688611d733b3a7b0}{PamCutCollection}.
261 pam-fi 1.1
262     The documentation for this class was generated from the following files:\begin{CompactItemize}
263     \item
264     PamCutBase/\hyperlink{PamCutBase_8h}{PamCutBase.h}\item
265     PamCutBase/\hyperlink{PamCutBase_8cpp}{PamCutBase.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23