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

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

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

revision 1.1 by pam-fi, Wed May 27 13:30:01 2009 UTC revision 1.2 by pam-fi, Fri Jun 5 13:15:23 2009 UTC
# Line 10  A collection class designed to use \hype Line 10  A collection class designed to use \hype
10  Inheritance diagram for SmartCollection::\begin{figure}[H]  Inheritance diagram for SmartCollection::\begin{figure}[H]
11  \begin{center}  \begin{center}
12  \leavevmode  \leavevmode
13  \includegraphics[height=4cm]{classSmartCollection}  \includegraphics[height=5cm]{classSmartCollection}
14  \end{center}  \end{center}
15  \end{figure}  \end{figure}
16  \subsection*{Public Member Functions}  \subsection*{Public Member Functions}
# Line 18  Inheritance diagram for SmartCollection: Line 18  Inheritance diagram for SmartCollection:
18  \item  \item
19  \hyperlink{classSmartCollection_597157bb186c4688cd305b62a197009d}{SmartCollection} (const char $\ast$collectionName)  \hyperlink{classSmartCollection_597157bb186c4688cd305b62a197009d}{SmartCollection} (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{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}{$\sim$SmartCollection} ()  \hypertarget{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}{
22    \hyperlink{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}{$\sim$SmartCollection} ()}
23    \label{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}
24    
25  \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26  virtual void \hyperlink{classSmartCollection_9265adb168bca295f264af65276a002b}{AddAction} (\hyperlink{classCollectionAction}{CollectionAction} \&action)  \hypertarget{classSmartCollection_9265adb168bca295f264af65276a002b}{
27    virtual void \hyperlink{classSmartCollection_9265adb168bca295f264af65276a002b}{AddAction} (\hyperlink{classCollectionAction}{CollectionAction} \&action)}
28    \label{classSmartCollection_9265adb168bca295f264af65276a002b}
29    
30  \begin{CompactList}\small\item\em Adds an action to the \hyperlink{classSmartCollection}{SmartCollection}. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Adds an action to the \hyperlink{classSmartCollection}{SmartCollection}. \item\end{CompactList}\item
31  \hyperlink{classCollectionAction}{CollectionAction} $\ast$ \hyperlink{classSmartCollection_acadaf64f683e7932c376e924e7020ea}{GetAction} (unsigned int iAction)  \hyperlink{classCollectionAction}{CollectionAction} $\ast$ \hyperlink{classSmartCollection_acadaf64f683e7932c376e924e7020ea}{GetAction} (unsigned int iAction)
32  \begin{CompactList}\small\item\em Returns the iAction-th action. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Returns the iAction-th action. \item\end{CompactList}\item
# Line 28  void \hyperlink{classSmartCollection_9b5 Line 34  void \hyperlink{classSmartCollection_9b5
34  \begin{CompactList}\small\item\em The pre-analysis task definition. \item\end{CompactList}\item  \begin{CompactList}\small\item\em The pre-analysis task definition. \item\end{CompactList}\item
35  void \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{Finalize} ()  void \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{Finalize} ()
36  \begin{CompactList}\small\item\em The post-analysis task definition. \item\end{CompactList}\item  \begin{CompactList}\small\item\em The post-analysis task definition. \item\end{CompactList}\item
37  void \hyperlink{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{OnGood} (PamLevel2 $\ast$event)  int \hyperlink{classSmartCollection_98213ec078e9b94ea70c72132757da46}{ApplyCut} (PamLevel2 $\ast$event)
38  \begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\item  \end{CompactItemize}
39  void \hyperlink{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}{OnBad} (PamLevel2 $\ast$event, int selectionResult)  \subsection*{Protected Attributes}
 \begin{CompactList}\small\item\em Post-selection tasks. \item\end{CompactList}\end{CompactItemize}  
 \subsection*{Private Attributes}  
40  \begin{CompactItemize}  \begin{CompactItemize}
41  \item  \item
42  std::vector$<$ \hyperlink{classCollectionAction}{CollectionAction} $\ast$ $>$ \hyperlink{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}{\_\-actions}  \hypertarget{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}{
43    std::vector$<$ \hyperlink{classCollectionAction}{CollectionAction} $\ast$ $>$ \textbf{\_\-actions}}
44    \label{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}
45    
46    \item
47    \hypertarget{classSmartCollection_732af2b9a16d0c098ce90ed29e15d09f}{
48    std::vector$<$ unsigned int $>$ \textbf{\_\-actionsPositions}}
49    \label{classSmartCollection_732af2b9a16d0c098ce90ed29e15d09f}
50    
51  \end{CompactItemize}  \end{CompactItemize}
52    
53    
54  \subsection{Detailed Description}  \subsection{Detailed Description}
55  A collection class designed to use \hyperlink{classCollectionAction}{CollectionAction} objects.  A collection class designed to use \hyperlink{classCollectionAction}{CollectionAction} objects.
56    
57  The \hyperlink{classSmartCollection}{SmartCollection} class is designed to handle \hyperlink{classCollectionAction}{CollectionAction} objects. These defines the procedures to do when an event is selected or discarded. A \hyperlink{classSmartCollection}{SmartCollection} handles a vector of these objects, calling \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{CollectionAction::OnGood()} for each of them when a good event is selected and \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{CollectionAction::OnBad()} when a bad one is rejected. It will also call the \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{CollectionAction::Setup()} and \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{CollectionAction::Finalize()} methods at the beginning and at the end of the analysis, respectively.  The \hyperlink{classSmartCollection}{SmartCollection} class is designed to handle \hyperlink{classCollectionAction}{CollectionAction} objects. It holds a vector of these objects and takes care of calling Setup and Finalize for each of them at the beginning and at the end of the analysis, respectively. Actions can be added to the \hyperlink{classSmartCollection}{SmartCollection} by means of the \hyperlink{classSmartCollection_9265adb168bca295f264af65276a002b}{AddAction()} method. If a bunch of cuts have been already added to the collection, the action will be logically placed after the cuts. The \hyperlink{classSmartCollection}{SmartCollection} will call \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{CollectionAction::OnGood()} if the cuts preceding the actions are satisfied, and \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{CollectionAction::OnBad()} if at least one of them fails. An action will not be sensitive to cuts added to the collection after the action itself. The resulting structure is composed by bunches of cuts intertwined by actions, which are \char`\"{}executed\char`\"{} depending on the result of the bunch of cuts that precedes the action. Note that \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{CollectionAction::OnBad()} is called only for those actions at the end of the bunch where the first failed cut is: if after these actions there are other bunches of cuts and actions, they will be ignored. For example, in the sequence below:
58    
59    $|$ cut1 $|$ cut2 $|$ action1 $|$ action2 $|$ cut3 $|$ cut4 $|$ action3 $|$ ...
60    
61  Definition at line 26 of file SmartCollection.h.  action1 and action2 are executed (eg., OnGood is called for them) if cut1 and cut2 are both satisfied, then cut3 and cut4 are evaluated and if both of them are satisfied then action3 is executed. If, for example, cut 1 or cut2 fail, then OnBad is called for action1 and action2; however, cut3, cut4, action3 and all that follows are ignored. The analysis goes on with the next event.
62    
63  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
64  \hypertarget{classSmartCollection_597157bb186c4688cd305b62a197009d}{  \hypertarget{classSmartCollection_597157bb186c4688cd305b62a197009d}{
# Line 63  Constructor. Line 77  Constructor.
77  \end{Desc}  \end{Desc}
78    
79    
 Definition at line 34 of file SmartCollection.h.\hypertarget{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}{  
 \index{SmartCollection@{SmartCollection}!$\sim$SmartCollection@{$\sim$SmartCollection}}  
 \index{$\sim$SmartCollection@{$\sim$SmartCollection}!SmartCollection@{SmartCollection}}  
 \subsubsection[{$\sim$SmartCollection}]{\setlength{\rightskip}{0pt plus 5cm}SmartCollection::$\sim$SmartCollection ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classSmartCollection_63fdadd219eb42065c6e9adc63558b63}  
   
   
 Destructor.  
   
   
   
 Definition at line 39 of file SmartCollection.h.  
   
80  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
81  \hypertarget{classSmartCollection_9265adb168bca295f264af65276a002b}{  \hypertarget{classSmartCollection_98213ec078e9b94ea70c72132757da46}{
82  \index{SmartCollection@{SmartCollection}!AddAction@{AddAction}}  \index{SmartCollection@{SmartCollection}!ApplyCut@{ApplyCut}}
83  \index{AddAction@{AddAction}!SmartCollection@{SmartCollection}}  \index{ApplyCut@{ApplyCut}!SmartCollection@{SmartCollection}}
84  \subsubsection[{AddAction}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::AddAction ({\bf CollectionAction} \& {\em action})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{ApplyCut}]{\setlength{\rightskip}{0pt plus 5cm}int SmartCollection::ApplyCut (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
85  \label{classSmartCollection_9265adb168bca295f264af65276a002b}  \label{classSmartCollection_98213ec078e9b94ea70c72132757da46}
86    
87    
88    Applies the cuts and executes the actions.
89    
90  Adds an action to the \hyperlink{classSmartCollection}{SmartCollection}.  When cuts are applied, a \hyperlink{classSmartCollection}{SmartCollection} will also execute the actions at the end of the bunches of cuts.
91    
92    \begin{Desc}
93    \item[Parameters:]
94    \begin{description}
95    \item[{\em event}]The event to analyze. \end{description}
96    \end{Desc}
97    
98    
99  Definition at line 12 of file SmartCollection.cpp.  Reimplemented from \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{PamCutCollection}.
100    
101  References \_\-actions.\hypertarget{classSmartCollection_8105730615ad127a482a7fb399695977}{  Reimplemented in \hyperlink{classSmartBlindCollection_1eb231a8a437018bfd966644c7b18ba4}{SmartBlindCollection}.\hypertarget{classSmartCollection_8105730615ad127a482a7fb399695977}{
102  \index{SmartCollection@{SmartCollection}!Finalize@{Finalize}}  \index{SmartCollection@{SmartCollection}!Finalize@{Finalize}}
103  \index{Finalize@{Finalize}!SmartCollection@{SmartCollection}}  \index{Finalize@{Finalize}!SmartCollection@{SmartCollection}}
104  \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::Finalize ()\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::Finalize ()\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 103  This override of the \hyperlink{classSma Line 111  This override of the \hyperlink{classSma
111    
112  Reimplemented from \hyperlink{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{PamCutCollection}.  Reimplemented from \hyperlink{classPamCutCollection_15785c75fb13b998422739e741bb5c01}{PamCutCollection}.
113    
114  Reimplemented in \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}.  Reimplemented in \hyperlink{classVerboseBlindCollection_43d6ea7b5ea35c5dbb342e23584b79ee}{VerboseBlindCollection}, and \hyperlink{classVerboseCollection_3fcdf28d50507d772647d4306a78f3cc}{VerboseCollection}.\hypertarget{classSmartCollection_acadaf64f683e7932c376e924e7020ea}{
   
 Definition at line 33 of file SmartCollection.cpp.  
   
 References \_\-actions.\hypertarget{classSmartCollection_acadaf64f683e7932c376e924e7020ea}{  
115  \index{SmartCollection@{SmartCollection}!GetAction@{GetAction}}  \index{SmartCollection@{SmartCollection}!GetAction@{GetAction}}
116  \index{GetAction@{GetAction}!SmartCollection@{SmartCollection}}  \index{GetAction@{GetAction}!SmartCollection@{SmartCollection}}
117  \subsubsection[{GetAction}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CollectionAction} $\ast$ SmartCollection::GetAction (unsigned int {\em iAction})}}  \subsubsection[{GetAction}]{\setlength{\rightskip}{0pt plus 5cm}{\bf CollectionAction} $\ast$ SmartCollection::GetAction (unsigned int {\em iAction})}}
# Line 123  Returns the iAction-th action. Line 127  Returns the iAction-th action.
127  \end{Desc}  \end{Desc}
128  \begin{Desc}  \begin{Desc}
129  \item[Returns:]pointer to the iAction-th action; NULL if the specified action cannot be found or if no actions are present. \end{Desc}  \item[Returns:]pointer to the iAction-th action; NULL if the specified action cannot be found or if no actions are present. \end{Desc}
130    \hypertarget{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{
   
 Definition at line 16 of file SmartCollection.cpp.  
   
 References \_\-actions.\hypertarget{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}{  
 \index{SmartCollection@{SmartCollection}!OnBad@{OnBad}}  
 \index{OnBad@{OnBad}!SmartCollection@{SmartCollection}}  
 \subsubsection[{OnBad}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::OnBad (PamLevel2 $\ast$ {\em event}, \/  int {\em selectionResult})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  
 \label{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}  
   
   
 Post-selection tasks.  
   
 This routine is automatically called after a bad event has been rejected by \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut()}. It will simply call \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{PamCutCollection::OnBad()} and then \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{CollectionAction::OnBad()} for each action in the \hyperlink{classSmartCollection}{SmartCollection}.  
   
 \begin{Desc}  
 \item[See also:]\hyperlink{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{OnGood} \end{Desc}  
 \begin{Desc}  
 \item[Parameters:]  
 \begin{description}  
 \item[{\em event}]The event which don't satisfy the cut. \item[{\em selectionResult}]The return value of the \hyperlink{classPamCutCollection_85f04cef7b560a37061391dd397813a7}{Check()} routine. \end{description}  
 \end{Desc}  
   
   
 Reimplemented from \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{PamCut}.  
   
 Definition at line 49 of file SmartCollection.cpp.  
   
 References \_\-actions.\hypertarget{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{  
 \index{SmartCollection@{SmartCollection}!OnGood@{OnGood}}  
 \index{OnGood@{OnGood}!SmartCollection@{SmartCollection}}  
 \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  
 \label{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}  
   
   
 Post-selection tasks.  
   
 This routine is automatically called after a good event has been selected by \hyperlink{classPamCutCollection_e7af429a3afef3685cbd5aa076ef96e5}{ApplyCut()}. It will simply call \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCutCollection::OnGood()} and then \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{CollectionAction::OnGood()} for each action in the \hyperlink{classSmartCollection}{SmartCollection}. \begin{Desc}  
 \item[Parameters:]  
 \begin{description}  
 \item[{\em event}]The event which satisfy the cut. \end{description}  
 \end{Desc}  
   
   
 Reimplemented from \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCut}.  
   
 Definition at line 41 of file SmartCollection.cpp.  
   
 References \_\-actions.\hypertarget{classSmartCollection_9b5b11a854b9e174218ea516ceffb34c}{  
131  \index{SmartCollection@{SmartCollection}!Setup@{Setup}}  \index{SmartCollection@{SmartCollection}!Setup@{Setup}}
132  \index{Setup@{Setup}!SmartCollection@{SmartCollection}}  \index{Setup@{Setup}!SmartCollection@{SmartCollection}}
133  \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}void SmartCollection::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 191  This override of the \hyperlink{classSma Line 147  This override of the \hyperlink{classSma
147    
148  Reimplemented from \hyperlink{classPamCutCollection_982821389af5e585688611d733b3a7b0}{PamCutCollection}.  Reimplemented from \hyperlink{classPamCutCollection_982821389af5e585688611d733b3a7b0}{PamCutCollection}.
149    
 Definition at line 25 of file SmartCollection.cpp.  
   
 References \_\-actions.  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}{  
 \index{SmartCollection@{SmartCollection}!\_\-actions@{\_\-actions}}  
 \index{\_\-actions@{\_\-actions}!SmartCollection@{SmartCollection}}  
 \subsubsection[{\_\-actions}]{\setlength{\rightskip}{0pt plus 5cm}std::vector$<${\bf CollectionAction}$\ast$$>$ {\bf SmartCollection::\_\-actions}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classSmartCollection_a80a9cf5cab3683a61b47a1145ff8f15}  
   
   
   
   
 Definition at line 93 of file SmartCollection.h.  
   
 Referenced by AddAction(), Finalize(), GetAction(), OnBad(), OnGood(), and Setup().  
   
150  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}
151  \item  \item
152  Collections/SmartCollection/\hyperlink{SmartCollection_8h}{SmartCollection.h}\item  Collections/SmartCollection/\hyperlink{SmartCollection_8h}{SmartCollection.h}\item
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.23