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

Diff of /PamCut/doc/Doxygen/latex/classPamCutCollection.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.1.1.1 by pam-fi, Wed May 27 13:30:02 2009 UTC revision 1.2 by pam-fi, Fri Jun 5 13:15:24 2009 UTC
# Line 18  Inheritance diagram for PamCutCollection Line 18  Inheritance diagram for PamCutCollection
18  \item  \item
19  \hyperlink{classPamCutCollection_756d6cc1c69e85a0f76e7674789c5588}{PamCutCollection} (const char $\ast$collectionName)  \hyperlink{classPamCutCollection_756d6cc1c69e85a0f76e7674789c5588}{PamCutCollection} (const char $\ast$collectionName)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classPamCutCollection_932711c5f613639091adbcd851107b0c}{$\sim$PamCutCollection} ()  \hypertarget{classPamCutCollection_932711c5f613639091adbcd851107b0c}{
22    \hyperlink{classPamCutCollection_932711c5f613639091adbcd851107b0c}{$\sim$PamCutCollection} ()}
23    \label{classPamCutCollection_932711c5f613639091adbcd851107b0c}
24    
25  \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26  void \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut} (\hyperlink{classPamCut}{PamCut} \&cut)  void \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut} (\hyperlink{classPamCut}{PamCut} \&cut)
27  \begin{CompactList}\small\item\em Adds a cut to the cut collection This routine adds a cut to the collection. These are stored in a vector in the same order they are inserted (the first cut would be element 0, the second cut element 1 and so on). All the references to a \char`\"{}cut number\char`\"{} or \char`\"{}cut index\char`\"{} will refer to this numbering scheme. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Adds a cut to the cut collection This routine adds a cut to the collection. These are stored in a vector in the same order they are inserted (the first cut would be element 0, the second cut element 1 and so on). All the references to a \char`\"{}cut number\char`\"{} or \char`\"{}cut index\char`\"{} will refer to this numbering scheme. \item\end{CompactList}\item
# Line 39  void \hyperlink{classPamCutCollection_15 Line 42  void \hyperlink{classPamCutCollection_15
42  \subsection*{Protected Attributes}  \subsection*{Protected Attributes}
43  \begin{CompactItemize}  \begin{CompactItemize}
44  \item  \item
45  std::vector$<$ \hyperlink{classPamCut}{PamCut} $\ast$ $>$ \hyperlink{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{\_\-cuts}  \hypertarget{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{
46    std::vector$<$ \hyperlink{classPamCut}{PamCut} $\ast$ $>$ \hyperlink{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{\_\-cuts}}
47    \label{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}
48    
49  \begin{CompactList}\small\item\em A vector containing pointers to \hyperlink{classPamCut}{PamCut} objects. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em A vector containing pointers to \hyperlink{classPamCut}{PamCut} objects. \item\end{CompactList}\end{CompactItemize}
50    
51    
# Line 48  A class which applies a set of cuts to P Line 54  A class which applies a set of cuts to P
54    
55  This is a multi-cut class, which inherits from \hyperlink{classPamCut}{PamCut}. Indeed, a multi-cut can be seen as a cut composed by various simpler cuts; hence the interface of \hyperlink{classPamCut}{PamCut} is also functional for \hyperlink{classPamCutCollection}{PamCutCollection}. The \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut(PamLevel2 $\ast$event)} method is overridden so as all the cuts that compose the \hyperlink{classPamCutCollection}{PamCutCollection} are applied to the events in the same order they are added to the collection. Instead, \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process(PamLevel2 $\ast$events, ULong\_\-t firstEvent, ULong\_\-t lastEvent)} is NOT overridden, since it performs the same task as the one in the base class: it is sufficient to override \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check(PamLevel2 $\ast$event)} to replace the single-cut evaluation with a multi-cut evaluation.  This is a multi-cut class, which inherits from \hyperlink{classPamCut}{PamCut}. Indeed, a multi-cut can be seen as a cut composed by various simpler cuts; hence the interface of \hyperlink{classPamCut}{PamCut} is also functional for \hyperlink{classPamCutCollection}{PamCutCollection}. The \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut(PamLevel2 $\ast$event)} method is overridden so as all the cuts that compose the \hyperlink{classPamCutCollection}{PamCutCollection} are applied to the events in the same order they are added to the collection. Instead, \hyperlink{classPamCut_047b75499ea4457d60397ee5491adcd4}{Process(PamLevel2 $\ast$events, ULong\_\-t firstEvent, ULong\_\-t lastEvent)} is NOT overridden, since it performs the same task as the one in the base class: it is sufficient to override \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check(PamLevel2 $\ast$event)} to replace the single-cut evaluation with a multi-cut evaluation.
56    
 Definition at line 171 of file PamCutBase.h.  
   
57  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
58  \hypertarget{classPamCutCollection_756d6cc1c69e85a0f76e7674789c5588}{  \hypertarget{classPamCutCollection_756d6cc1c69e85a0f76e7674789c5588}{
59  \index{PamCutCollection@{PamCutCollection}!PamCutCollection@{PamCutCollection}}  \index{PamCutCollection@{PamCutCollection}!PamCutCollection@{PamCutCollection}}
# Line 67  Constructor. Line 71  Constructor.
71  \end{Desc}  \end{Desc}
72    
73    
 Definition at line 178 of file PamCutBase.h.\hypertarget{classPamCutCollection_932711c5f613639091adbcd851107b0c}{  
 \index{PamCutCollection@{PamCutCollection}!$\sim$PamCutCollection@{$\sim$PamCutCollection}}  
 \index{$\sim$PamCutCollection@{$\sim$PamCutCollection}!PamCutCollection@{PamCutCollection}}  
 \subsubsection[{$\sim$PamCutCollection}]{\setlength{\rightskip}{0pt plus 5cm}PamCutCollection::$\sim$PamCutCollection ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classPamCutCollection_932711c5f613639091adbcd851107b0c}  
   
   
 Destructor.  
   
   
   
 Definition at line 183 of file PamCutBase.h.  
   
74  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
75  \hypertarget{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{  \hypertarget{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{
76  \index{PamCutCollection@{PamCutCollection}!AddCut@{AddCut}}  \index{PamCutCollection@{PamCutCollection}!AddCut@{AddCut}}
# Line 95  Adds a cut to the cut collection This ro Line 86  Adds a cut to the cut collection This ro
86  \begin{description}  \begin{description}
87  \item[{\em cut}]The PamCut-derived object to add to the collection. \end{description}  \item[{\em cut}]The PamCut-derived object to add to the collection. \end{description}
88  \end{Desc}  \end{Desc}
89    \hypertarget{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{
   
 Definition at line 74 of file PamCutBase.cpp.  
   
 References \_\-cuts.\hypertarget{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{  
90  \index{PamCutCollection@{PamCutCollection}!ApplyCut@{ApplyCut}}  \index{PamCutCollection@{PamCutCollection}!ApplyCut@{ApplyCut}}
91  \index{ApplyCut@{ApplyCut}!PamCutCollection@{PamCutCollection}}  \index{ApplyCut@{ApplyCut}!PamCutCollection@{PamCutCollection}}
92  \subsubsection[{ApplyCut}]{\setlength{\rightskip}{0pt plus 5cm}int PamCutCollection::ApplyCut (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{ApplyCut}]{\setlength{\rightskip}{0pt plus 5cm}int PamCutCollection::ApplyCut (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 121  This routine works pretty much like the Line 108  This routine works pretty much like the
108    
109  Reimplemented from \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{PamCut}.  Reimplemented from \hyperlink{classPamCut_132a1a7cf365ff28eca38b7dda1acb7f}{PamCut}.
110    
111  Reimplemented in \hyperlink{classBlindCutCollection_8d387de8cbc54ff0eab8cff220b49c20}{BlindCutCollection}.  Reimplemented in \hyperlink{classBlindCutCollection_8d387de8cbc54ff0eab8cff220b49c20}{BlindCutCollection}, \hyperlink{classSmartBlindCollection_1eb231a8a437018bfd966644c7b18ba4}{SmartBlindCollection}, and \hyperlink{classSmartCollection_98213ec078e9b94ea70c72132757da46}{SmartCollection}.\hypertarget{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{
   
 Definition at line 94 of file PamCutBase.cpp.  
   
 References \_\-cuts, PamCut::\_\-nEv, PamCut::\_\-nGood, CUTOK, PamCut::OnBad(), and PamCut::OnGood().\hypertarget{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{  
112  \index{PamCutCollection@{PamCutCollection}!Check@{Check}}  \index{PamCutCollection@{PamCutCollection}!Check@{Check}}
113  \index{Check@{Check}!PamCutCollection@{PamCutCollection}}  \index{Check@{Check}!PamCutCollection@{PamCutCollection}}
114  \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int PamCutCollection::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int PamCutCollection::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 137  The basic selection. Line 120  The basic selection.
120  Like in the mother class, this method performs a basic check on the current event: it calls \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check()} for each cut previously added with \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut()}, exiting if one of them is not satisfied.  Like in the mother class, this method performs a basic check on the current event: it calls \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check()} for each cut previously added with \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut()}, exiting if one of them is not satisfied.
121    
122  \begin{Desc}  \begin{Desc}
123    \item[Parameters:]
124    \begin{description}
125    \item[{\em event}]The event to analyze. \end{description}
126    \end{Desc}
127    \begin{Desc}
128  \item[Returns:]the index of the failed cut (range: \mbox{[}0, \#cuts-1\mbox{]}, see \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut()}); \hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event satisfies all the cuts. \end{Desc}  \item[Returns:]the index of the failed cut (range: \mbox{[}0, \#cuts-1\mbox{]}, see \hyperlink{classPamCutCollection_6dc6a92a7ee9243f567a2a244e1e5685}{AddCut()}); \hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if the event satisfies all the cuts. \end{Desc}
129    
130    
131  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.  Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
132    
133  Reimplemented in \hyperlink{classBlindCutCollection_016ee86612e57a50f03c8469d3ed9d1f}{BlindCutCollection}.  Reimplemented in \hyperlink{classBlindCutCollection_016ee86612e57a50f03c8469d3ed9d1f}{BlindCutCollection}.\hypertarget{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{
   
 Definition at line 78 of file PamCutBase.cpp.  
   
 References \_\-cuts, and CUTOK.\hypertarget{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{  
134  \index{PamCutCollection@{PamCutCollection}!Finalize@{Finalize}}  \index{PamCutCollection@{PamCutCollection}!Finalize@{Finalize}}
135  \index{Finalize@{Finalize}!PamCutCollection@{PamCutCollection}}  \index{Finalize@{Finalize}!PamCutCollection@{PamCutCollection}}
136  \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void PamCutCollection::Finalize ()\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void PamCutCollection::Finalize ()\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 159  This override of the \hyperlink{classPam Line 143  This override of the \hyperlink{classPam
143    
144  Reimplemented from \hyperlink{classPamCut_fd74c1565552cabe4aced316df803737}{PamCut}.  Reimplemented from \hyperlink{classPamCut_fd74c1565552cabe4aced316df803737}{PamCut}.
145    
146  Reimplemented in \hyperlink{classSmartBlindCollection_a78ee7b18b0913554e64b4e560453167}{SmartBlindCollection}, \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}, \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, and \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}.  Reimplemented in \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection}, \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, and \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}.\hypertarget{classPamCutCollection_55e41082749260f5cee2fd53d9fd331b}{
   
 Definition at line 146 of file PamCutBase.cpp.  
   
 References \_\-cuts, and GetSize().\hypertarget{classPamCutCollection_55e41082749260f5cee2fd53d9fd331b}{  
147  \index{PamCutCollection@{PamCutCollection}!GetCut@{GetCut}}  \index{PamCutCollection@{PamCutCollection}!GetCut@{GetCut}}
148  \index{GetCut@{GetCut}!PamCutCollection@{PamCutCollection}}  \index{GetCut@{GetCut}!PamCutCollection@{PamCutCollection}}
149  \subsubsection[{GetCut}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCut} $\ast$ PamCutCollection::GetCut (unsigned int {\em iCut})}}  \subsubsection[{GetCut}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCut} $\ast$ PamCutCollection::GetCut (unsigned int {\em iCut})}}
# Line 181  The return value of this method is a poi Line 161  The return value of this method is a poi
161  \end{Desc}  \end{Desc}
162  \begin{Desc}  \begin{Desc}
163  \item[Returns:]pointer to the iCut-th cut; NULL if the specified cut cannot be found or if no cuts are present. \end{Desc}  \item[Returns:]pointer to the iCut-th cut; NULL if the specified cut cannot be found or if no cuts are present. \end{Desc}
164    \hypertarget{classPamCutCollection_231f91b82b18cf326a2912b0b515baca}{
   
 Definition at line 116 of file PamCutBase.cpp.  
   
 References \_\-cuts.  
   
 Referenced by VerboseCollection::Finalize(), and VerboseBlindCollection::Finalize().\hypertarget{classPamCutCollection_231f91b82b18cf326a2912b0b515baca}{  
165  \index{PamCutCollection@{PamCutCollection}!GetSize@{GetSize}}  \index{PamCutCollection@{PamCutCollection}!GetSize@{GetSize}}
166  \index{GetSize@{GetSize}!PamCutCollection@{PamCutCollection}}  \index{GetSize@{GetSize}!PamCutCollection@{PamCutCollection}}
167  \subsubsection[{GetSize}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int PamCutCollection::GetSize ()}}  \subsubsection[{GetSize}]{\setlength{\rightskip}{0pt plus 5cm}unsigned int PamCutCollection::GetSize ()}}
# Line 198  The number of cuts contained in the coll Line 172  The number of cuts contained in the coll
172    
173  \begin{Desc}  \begin{Desc}
174  \item[Returns:]The number of cuts \end{Desc}  \item[Returns:]The number of cuts \end{Desc}
175    \hypertarget{classPamCutCollection_3fb36e5fb38627f5cbffe6c23cf57d2a}{
   
 Definition at line 125 of file PamCutBase.cpp.  
   
 References \_\-cuts.  
   
 Referenced by Finalize(), VerboseCollection::Finalize(), VerboseBlindCollection::Finalize(), and Setup().\hypertarget{classPamCutCollection_3fb36e5fb38627f5cbffe6c23cf57d2a}{  
176  \index{PamCutCollection@{PamCutCollection}!operator=@{operator=}}  \index{PamCutCollection@{PamCutCollection}!operator=@{operator=}}
177  \index{operator=@{operator=}!PamCutCollection@{PamCutCollection}}  \index{operator=@{operator=}!PamCutCollection@{PamCutCollection}}
178  \subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCutCollection} \& PamCutCollection::operator= (const {\bf PamCutCollection} \& {\em rightValue})}}  \subsubsection[{operator=}]{\setlength{\rightskip}{0pt plus 5cm}{\bf PamCutCollection} \& PamCutCollection::operator= (const {\bf PamCutCollection} \& {\em rightValue})}}
# Line 220  Assignment operator redefinition. The as Line 188  Assignment operator redefinition. The as
188  \end{Desc}  \end{Desc}
189  \begin{Desc}  \begin{Desc}
190  \item[Returns:]The new value for LHS. \end{Desc}  \item[Returns:]The new value for LHS. \end{Desc}
191    \hypertarget{classPamCutCollection_982821389af5e585688611d733b3a7b0}{
   
 Definition at line 130 of file PamCutBase.cpp.  
   
 References \_\-cuts.\hypertarget{classPamCutCollection_982821389af5e585688611d733b3a7b0}{  
192  \index{PamCutCollection@{PamCutCollection}!Setup@{Setup}}  \index{PamCutCollection@{PamCutCollection}!Setup@{Setup}}
193  \index{Setup@{Setup}!PamCutCollection@{PamCutCollection}}  \index{Setup@{Setup}!PamCutCollection@{PamCutCollection}}
194  \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void PamCutCollection::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void PamCutCollection::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 244  This override of the \hyperlink{classPam Line 208  This override of the \hyperlink{classPam
208    
209  Reimplemented from \hyperlink{classPamCut_e587828903b809c99f9ab5ba97ae6616}{PamCut}.  Reimplemented from \hyperlink{classPamCut_e587828903b809c99f9ab5ba97ae6616}{PamCut}.
210    
211  Reimplemented in \hyperlink{classSmartBlindCollection_e59d373921df00a54a8a8401a1ae2baf}{SmartBlindCollection}, and \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{SmartCollection}.  Reimplemented in \hyperlink{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{SmartCollection}.
   
 Definition at line 137 of file PamCutBase.cpp.  
   
 References \_\-cuts, and GetSize().  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}{  
 \index{PamCutCollection@{PamCutCollection}!\_\-cuts@{\_\-cuts}}  
 \index{\_\-cuts@{\_\-cuts}!PamCutCollection@{PamCutCollection}}  
 \subsubsection[{\_\-cuts}]{\setlength{\rightskip}{0pt plus 5cm}std::vector$<${\bf PamCut}$\ast$$>$ {\bf PamCutCollection::\_\-cuts}\hspace{0.3cm}{\tt  \mbox{[}protected\mbox{]}}}}  
 \label{classPamCutCollection_95f91f4b81f916cb6e120ee4b5bb5403}  
   
   
 A vector containing pointers to \hyperlink{classPamCut}{PamCut} objects.  
   
   
   
 Definition at line 261 of file PamCutBase.h.  
   
 Referenced by AddCut(), ApplyCut(), BlindCutCollection::ApplyCut(), Check(), BlindCutCollection::Check(), Finalize(), VerboseCollection::Finalize(), VerboseBlindCollection::Finalize(), GetCut(), GetSize(), operator=(), and Setup().  
212    
213  The documentation for this class was generated from the following files:\begin{CompactItemize}  The documentation for this class was generated from the following files:\begin{CompactItemize}
214  \item  \item
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.23