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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (show annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:01 2009 UTC (15 years, 9 months ago) by pam-fi
Branch: DEV
CVS Tags: v0r00
Changes since 1.1: +0 -0 lines
File MIME type: application/x-tex
First import

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 \hyperlink{classPamCut_a8192c75b3fe95687f6835100d6ee8b9}{PamCut} (const char $\ast$cutName)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 virtual \hyperlink{classPamCut_8a6fb3b6ff60cd514fed53c7a9044790}{$\sim$PamCut} ()
22 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23 virtual int \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check} (PamLevel2 $\ast$event)=0
24 \begin{CompactList}\small\item\em The basic event check. \item\end{CompactList}\item
25 virtual int \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{ApplyCut} (PamLevel2 $\ast$event)
26 \begin{CompactList}\small\item\em Applies the cut to the current event. \item\end{CompactList}\item
27 virtual void \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process} (PamLevel2 $\ast$events, ULong\_\-t firstEvent, ULong\_\-t lastEvent)
28 \begin{CompactList}\small\item\em Applies the cut to a range of events. \item\end{CompactList}\item
29 virtual void \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{OnGood} (PamLevel2 $\ast$event)
30 \begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\item
31 virtual void \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{OnBad} (PamLevel2 $\ast$event, int selectionResult)
32 \begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\item
33 virtual UInt\_\-t \hyperlink{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}{GetNEv} ()
34 \begin{CompactList}\small\item\em Returns the number of checked events. \item\end{CompactList}\item
35 virtual UInt\_\-t \hyperlink{classPamCut_b8a69206312cfcf6df6897aef973ef4a}{GetNGood} ()
36 \begin{CompactList}\small\item\em Returns the number of good events. \item\end{CompactList}\item
37 virtual void \hyperlink{classPamCut_e587828903b809c99f9ab5ba97ae6616}{Setup} (PamLevel2 $\ast$events)
38 \begin{CompactList}\small\item\em The pre-analysis task definition. \item\end{CompactList}\item
39 virtual void \hyperlink{classPamCut_fd74c1565552cabe4aced316df803737}{Finalize} ()
40 \begin{CompactList}\small\item\em The post-analysis task definition. \item\end{CompactList}\item
41 const char $\ast$ \hyperlink{classPamCut_9f14d875c176c2af470838a1b6dc069b}{GetName} () const
42 \begin{CompactList}\small\item\em Returns the cut name. \item\end{CompactList}\item
43 void \hyperlink{classPamCut_276bd306ea0a62cc0effa5dea4118e21}{SetName} (const char $\ast$newName)
44 \begin{CompactList}\small\item\em Changes the cut's name. \item\end{CompactList}\item
45 \hyperlink{classPamCut}{PamCut} \& \hyperlink{classPamCut_cff560f2c6a663345c81f95df905956e}{operator=} (const \hyperlink{classPamCut}{PamCut} \&rightValue)
46 \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}
47 \subsection*{Protected Attributes}
48 \begin{CompactItemize}
49 \item
50 UInt\_\-t \hyperlink{classPamCut_0525bd3c71dbd445f817c163d56562d5}{\_\-nEv}
51 \begin{CompactList}\small\item\em The number of analyzed events. \item\end{CompactList}\item
52 UInt\_\-t \hyperlink{classPamCut_eacb32030a52b4353861159e3ca098d0}{\_\-nGood}
53 \begin{CompactList}\small\item\em The number of good events. \item\end{CompactList}\end{CompactItemize}
54 \subsection*{Private Attributes}
55 \begin{CompactItemize}
56 \item
57 const char $\ast$ \hyperlink{classPamCut_1eb606f9dab9c7f2fd5d84f834dcf146}{\_\-cutName}
58 \end{CompactItemize}
59
60
61 \subsection{Detailed Description}
62 An abstract class to apply cuts to Pamela data.
63
64 This class provides a basic interface for a cut object to apply to PamLevel2 data.
65
66 Definition at line 22 of file PamCutBase.h.
67
68 \subsection{Constructor \& Destructor Documentation}
69 \hypertarget{classPamCut_a8192c75b3fe95687f6835100d6ee8b9}{
70 \index{PamCut@{PamCut}!PamCut@{PamCut}}
71 \index{PamCut@{PamCut}!PamCut@{PamCut}}
72 \subsubsection[{PamCut}]{\setlength{\rightskip}{0pt plus 5cm}PamCut::PamCut (const char $\ast$ {\em cutName})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
73 \label{classPamCut_a8192c75b3fe95687f6835100d6ee8b9}
74
75
76 Constructor.
77
78
79
80 Definition at line 26 of file PamCutBase.h.\hypertarget{classPamCut_8a6fb3b6ff60cd514fed53c7a9044790}{
81 \index{PamCut@{PamCut}!$\sim$PamCut@{$\sim$PamCut}}
82 \index{$\sim$PamCut@{$\sim$PamCut}!PamCut@{PamCut}}
83 \subsubsection[{$\sim$PamCut}]{\setlength{\rightskip}{0pt plus 5cm}virtual PamCut::$\sim$PamCut ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
84 \label{classPamCut_8a6fb3b6ff60cd514fed53c7a9044790}
85
86
87 Destructor.
88
89
90
91 Definition at line 31 of file PamCutBase.h.
92
93 \subsection{Member Function Documentation}
94 \hypertarget{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{
95 \index{PamCut@{PamCut}!ApplyCut@{ApplyCut}}
96 \index{ApplyCut@{ApplyCut}!PamCut@{PamCut}}
97 \subsubsection[{ApplyCut}]{\setlength{\rightskip}{0pt plus 5cm}int PamCut::ApplyCut (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
98 \label{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}
99
100
101 Applies the cut to the current event.
102
103 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()}).
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:]same return values as \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{Check()} \end{Desc}
112
113
114 Reimplemented in \hyperlink{classBlindCutCollection_8d387de8cbc54ff0eab8cff220b49c20}{BlindCutCollection}, and \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{PamCutCollection}.
115
116 Definition at line 15 of file PamCutBase.cpp.
117
118 References \_\-nEv, \_\-nGood, Check(), CUTOK, OnBad(), and OnGood().
119
120 Referenced by Process().\hypertarget{classPamCut_a874600461950d1f2b75ce3938f91cbe}{
121 \index{PamCut@{PamCut}!Check@{Check}}
122 \index{Check@{Check}!PamCut@{PamCut}}
123 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}virtual int PamCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}pure virtual\mbox{]}}}}
124 \label{classPamCut_a874600461950d1f2b75ce3938f91cbe}
125
126
127 The basic event check.
128
129 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.
130
131 \begin{Desc}
132 \item[Parameters:]
133 \begin{description}
134 \item[{\em event}]The event to analyze. \end{description}
135 \end{Desc}
136 \begin{Desc}
137 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event satisfy the cut, other return values are implementation-specific. \end{Desc}
138
139
140 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}.
141
142 Referenced by ApplyCut().\hypertarget{classPamCut_fd74c1565552cabe4aced316df803737}{
143 \index{PamCut@{PamCut}!Finalize@{Finalize}}
144 \index{Finalize@{Finalize}!PamCut@{PamCut}}
145 \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}virtual void PamCut::Finalize ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
146 \label{classPamCut_fd74c1565552cabe4aced316df803737}
147
148
149 The post-analysis task definition.
150
151 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.
152
153 Reimplemented in \hyperlink{classSmartBlindCollection_a78ee7b18b0913554e64b4e560453167}{SmartBlindCollection}, \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}, \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}, and \hyperlink{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{PamCutCollection}.
154
155 Definition at line 128 of file PamCutBase.h.
156
157 Referenced by Process().\hypertarget{classPamCut_9f14d875c176c2af470838a1b6dc069b}{
158 \index{PamCut@{PamCut}!GetName@{GetName}}
159 \index{GetName@{GetName}!PamCut@{PamCut}}
160 \subsubsection[{GetName}]{\setlength{\rightskip}{0pt plus 5cm}const char $\ast$ PamCut::GetName () const}}
161 \label{classPamCut_9f14d875c176c2af470838a1b6dc069b}
162
163
164 Returns the cut name.
165
166 \begin{Desc}
167 \item[Returns:]The cut name. \end{Desc}
168
169
170 Definition at line 57 of file PamCutBase.cpp.
171
172 References \_\-cutName.
173
174 Referenced by VerboseCollection::Finalize(), and VerboseBlindCollection::Finalize().\hypertarget{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}{
175 \index{PamCut@{PamCut}!GetNEv@{GetNEv}}
176 \index{GetNEv@{GetNEv}!PamCut@{PamCut}}
177 \subsubsection[{GetNEv}]{\setlength{\rightskip}{0pt plus 5cm}virtual UInt\_\-t PamCut::GetNEv ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
178 \label{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}
179
180
181 Returns the number of checked events.
182
183 \begin{Desc}
184 \item[Returns:]The number of checked events. \end{Desc}
185
186
187 Definition at line 94 of file PamCutBase.h.
188
189 References \_\-nEv.
190
191 Referenced by VerboseCollection::Finalize(), and VerboseBlindCollection::Finalize().\hypertarget{classPamCut_b8a69206312cfcf6df6897aef973ef4a}{
192 \index{PamCut@{PamCut}!GetNGood@{GetNGood}}
193 \index{GetNGood@{GetNGood}!PamCut@{PamCut}}
194 \subsubsection[{GetNGood}]{\setlength{\rightskip}{0pt plus 5cm}virtual UInt\_\-t PamCut::GetNGood ()\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
195 \label{classPamCut_b8a69206312cfcf6df6897aef973ef4a}
196
197
198 Returns the number of good events.
199
200 This counter keeps track of how many events have fulfilled the conditions specified in Check.
201
202 \begin{Desc}
203 \item[Returns:]The number of good events. \end{Desc}
204
205
206 Definition at line 104 of file PamCutBase.h.
207
208 References \_\-nGood.
209
210 Referenced by VerboseCollection::Finalize(), and VerboseBlindCollection::Finalize().\hypertarget{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{
211 \index{PamCut@{PamCut}!OnBad@{OnBad}}
212 \index{OnBad@{OnBad}!PamCut@{PamCut}}
213 \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{]}}}}
214 \label{classPamCut_cbb3b507d79f20878fac4392ffa57acb}
215
216
217 Post-selection tasks.
218
219 The post-selection tasks for bad events (ie., not satisfying the cut) can be defined here.
220
221 \begin{Desc}
222 \item[See also:]\hyperlink{classPamCut_56021e959232270c12528ddec3062985}{OnGood} \end{Desc}
223 \begin{Desc}
224 \item[Parameters:]
225 \begin{description}
226 \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}
227 \end{Desc}
228
229
230 Reimplemented in \hyperlink{classSmartBlindCollection_f91282918f2ac3966b8ca491ef0ef634}{SmartBlindCollection}, and \hyperlink{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}{SmartCollection}.
231
232 Definition at line 87 of file PamCutBase.h.
233
234 Referenced by PamCutCollection::ApplyCut(), ApplyCut(), and BlindCutCollection::ApplyCut().\hypertarget{classPamCut_56021e959232270c12528ddec3062985}{
235 \index{PamCut@{PamCut}!OnGood@{OnGood}}
236 \index{OnGood@{OnGood}!PamCut@{PamCut}}
237 \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}virtual void PamCut::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}inline, virtual\mbox{]}}}}
238 \label{classPamCut_56021e959232270c12528ddec3062985}
239
240
241 Post-selection tasks.
242
243 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}
244 \item[Parameters:]
245 \begin{description}
246 \item[{\em event}]The event which satisfy the cut. \end{description}
247 \end{Desc}
248
249
250 Reimplemented in \hyperlink{classSmartBlindCollection_d56853747b6484dec74fef529388ea28}{SmartBlindCollection}, \hyperlink{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{SmartCollection}, \hyperlink{classLTGeoFillCut_17593f86005dd51a09a637232797c925}{LTGeoFillCut}, and \hyperlink{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}{RigFillCut}.
251
252 Definition at line 76 of file PamCutBase.h.
253
254 Referenced by PamCutCollection::ApplyCut(), ApplyCut(), and BlindCutCollection::ApplyCut().\hypertarget{classPamCut_cff560f2c6a663345c81f95df905956e}{
255 \index{PamCut@{PamCut}!operator=@{operator=}}
256 \index{operator=@{operator=}!PamCut@{PamCut}}
257 \subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCut} \& PamCut::operator= (const {\bf PamCut} \& {\em rightValue})}}
258 \label{classPamCut_cff560f2c6a663345c81f95df905956e}
259
260
261 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.
262
263 \begin{Desc}
264 \item[Parameters:]
265 \begin{description}
266 \item[{\em rightValue}]The RHS. \end{description}
267 \end{Desc}
268 \begin{Desc}
269 \item[Returns:]The new value for LHS. \end{Desc}
270
271
272 Definition at line 65 of file PamCutBase.cpp.
273
274 References \_\-cutName.\hypertarget{classPamCut_047b75499ea4457d60397ee5491adcd4}{
275 \index{PamCut@{PamCut}!Process@{Process}}
276 \index{Process@{Process}!PamCut@{PamCut}}
277 \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{]}}}}
278 \label{classPamCut_047b75499ea4457d60397ee5491adcd4}
279
280
281 Applies the cut to a range of events.
282
283 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.
284
285 \begin{Desc}
286 \item[Parameters:]
287 \begin{description}
288 \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}
289 \end{Desc}
290
291
292 Definition at line 30 of file PamCutBase.cpp.
293
294 References ApplyCut(), Finalize(), and Setup().\hypertarget{classPamCut_276bd306ea0a62cc0effa5dea4118e21}{
295 \index{PamCut@{PamCut}!SetName@{SetName}}
296 \index{SetName@{SetName}!PamCut@{PamCut}}
297 \subsubsection[{SetName}]{\setlength{\rightskip}{0pt plus 5cm}void PamCut::SetName (const char $\ast$ {\em newName})}}
298 \label{classPamCut_276bd306ea0a62cc0effa5dea4118e21}
299
300
301 Changes the cut's name.
302
303 \begin{Desc}
304 \item[Parameters:]
305 \begin{description}
306 \item[{\em newName}]The new name. \end{description}
307 \end{Desc}
308
309
310 Definition at line 61 of file PamCutBase.cpp.
311
312 References \_\-cutName.\hypertarget{classPamCut_e587828903b809c99f9ab5ba97ae6616}{
313 \index{PamCut@{PamCut}!Setup@{Setup}}
314 \index{Setup@{Setup}!PamCut@{PamCut}}
315 \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void PamCut::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
316 \label{classPamCut_e587828903b809c99f9ab5ba97ae6616}
317
318
319 The pre-analysis task definition.
320
321 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.
322
323 \begin{Desc}
324 \item[Parameters:]
325 \begin{description}
326 \item[{\em events}]The PamLevel2 pointer to the events that will be analyzed.\end{description}
327 \end{Desc}
328 \begin{Desc}
329 \item[See also:]\hyperlink{classPamCut_3ae6ebc9dd777e11e0d8ce18948538be}{GetNEv()}, \hyperlink{classPamCut_b8a69206312cfcf6df6897aef973ef4a}{GetNGood()}. \end{Desc}
330
331
332 Reimplemented in \hyperlink{classSmartBlindCollection_e59d373921df00a54a8a8401a1ae2baf}{SmartBlindCollection}, \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{SmartCollection}, and \hyperlink{classPamCutCollection_982821389af5e585688611d733b3a7b0}{PamCutCollection}.
333
334 Definition at line 53 of file PamCutBase.cpp.
335
336 References \_\-nEv, and \_\-nGood.
337
338 Referenced by Process().
339
340 \subsection{Member Data Documentation}
341 \hypertarget{classPamCut_1eb606f9dab9c7f2fd5d84f834dcf146}{
342 \index{PamCut@{PamCut}!\_\-cutName@{\_\-cutName}}
343 \index{\_\-cutName@{\_\-cutName}!PamCut@{PamCut}}
344 \subsubsection[{\_\-cutName}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ {\bf PamCut::\_\-cutName}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
345 \label{classPamCut_1eb606f9dab9c7f2fd5d84f834dcf146}
346
347
348
349
350 Definition at line 154 of file PamCutBase.h.
351
352 Referenced by GetName(), operator=(), and SetName().\hypertarget{classPamCut_0525bd3c71dbd445f817c163d56562d5}{
353 \index{PamCut@{PamCut}!\_\-nEv@{\_\-nEv}}
354 \index{\_\-nEv@{\_\-nEv}!PamCut@{PamCut}}
355 \subsubsection[{\_\-nEv}]{\setlength{\rightskip}{0pt plus 5cm}UInt\_\-t {\bf PamCut::\_\-nEv}\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}}
356 \label{classPamCut_0525bd3c71dbd445f817c163d56562d5}
357
358
359 The number of analyzed events.
360
361
362
363 Definition at line 158 of file PamCutBase.h.
364
365 Referenced by PamCutCollection::ApplyCut(), ApplyCut(), BlindCutCollection::ApplyCut(), GetNEv(), and Setup().\hypertarget{classPamCut_eacb32030a52b4353861159e3ca098d0}{
366 \index{PamCut@{PamCut}!\_\-nGood@{\_\-nGood}}
367 \index{\_\-nGood@{\_\-nGood}!PamCut@{PamCut}}
368 \subsubsection[{\_\-nGood}]{\setlength{\rightskip}{0pt plus 5cm}UInt\_\-t {\bf PamCut::\_\-nGood}\hspace{0.3cm}{\tt \mbox{[}protected\mbox{]}}}}
369 \label{classPamCut_eacb32030a52b4353861159e3ca098d0}
370
371
372 The number of good events.
373
374
375
376 Definition at line 159 of file PamCutBase.h.
377
378 Referenced by PamCutCollection::ApplyCut(), ApplyCut(), BlindCutCollection::ApplyCut(), GetNGood(), and Setup().
379
380 The documentation for this class was generated from the following files:\begin{CompactItemize}
381 \item
382 PamCutBase/\hyperlink{PamCutBase_8h}{PamCutBase.h}\item
383 PamCutBase/\hyperlink{PamCutBase_8cpp}{PamCutBase.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23