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

Diff of /PamCut/doc/Doxygen/latex/classCollectionAction.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:03 2009 UTC revision 1.3 by pam-fi, Fri Sep 25 15:44:48 2009 UTC
# Line 18  Inheritance diagram for CollectionAction Line 18  Inheritance diagram for CollectionAction
18  \item  \item
19  \hyperlink{classCollectionAction_35e6d0d0351e0fafe4b508faeb3598d6}{CollectionAction} (const char $\ast$actionName)  \hyperlink{classCollectionAction_35e6d0d0351e0fafe4b508faeb3598d6}{CollectionAction} (const char $\ast$actionName)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  virtual \hyperlink{classCollectionAction_d327a6cfdc6148db563ae52aa004e098}{$\sim$CollectionAction} ()  \hypertarget{classCollectionAction_d327a6cfdc6148db563ae52aa004e098}{
22    virtual \hyperlink{classCollectionAction_d327a6cfdc6148db563ae52aa004e098}{$\sim$CollectionAction} ()}
23    \label{classCollectionAction_d327a6cfdc6148db563ae52aa004e098}
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{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{Setup} (PamLevel2 $\ast$events)  virtual void \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{Setup} (PamLevel2 $\ast$events)
27  \begin{CompactList}\small\item\em The initialization routine. \item\end{CompactList}\item  \begin{CompactList}\small\item\em The initialization routine. \item\end{CompactList}\item
28  virtual void \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{OnGood} (PamLevel2 $\ast$event)=0  virtual void \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{OnGood} (PamLevel2 $\ast$event)
29  \begin{CompactList}\small\item\em Routine for selected events. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Routine for selected events. \item\end{CompactList}\item
30  virtual void \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{OnBad} (PamLevel2 $\ast$event, int selectionResult)  virtual void \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{OnBad} (PamLevel2 $\ast$event, int selectionResult)
31  \begin{CompactList}\small\item\em Routine for discarded events. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Routine for discarded events. \item\end{CompactList}\item
32  virtual void \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{Finalize} ()=0  virtual void \hyperlink{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}{Finalize} ()
33  \begin{CompactList}\small\item\em The finalization routine. \item\end{CompactList}\item  \begin{CompactList}\small\item\em The finalization routine. \item\end{CompactList}\item
34  const char $\ast$ \hyperlink{classCollectionAction_96783ca0685b2095bf519c17a057c926}{GetName} ()  \hypertarget{classCollectionAction_96783ca0685b2095bf519c17a057c926}{
35    const char $\ast$ \hyperlink{classCollectionAction_96783ca0685b2095bf519c17a057c926}{GetName} ()}
36    \label{classCollectionAction_96783ca0685b2095bf519c17a057c926}
37    
38  \begin{CompactList}\small\item\em Returns the action name. \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em Returns the action name. \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 const char $\ast$ \hyperlink{classCollectionAction_5c046c663d75fdcb53d00cda91cc3509}{\_\-actionName}  
 \end{CompactItemize}  
39    
40    
41  \subsection{Detailed Description}  \subsection{Detailed Description}
42  An abstract class that defines the interface of a generic collection action.  An abstract class that defines the interface of a generic collection action.
43    
44  The \hyperlink{classCollectionAction}{CollectionAction} abstract class defines an interface for a generic action object which can be used to implement common actions that can be done by collections, like filling histograms or saving selected events. The structure of this class mimicks that of a standard collection: it has a \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{Setup()} and a \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{Finalize()} methods that are meant to be called at the beginning and at the end of the selection procedure, respectively. In \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{Setup()} one can prepare the analysis actions like instantiating a histogram object (this can be done also in the constructor), while in \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{Finalize()} the analysis can be closed by, eg., writing histograms on a file and closing that file. The two methods \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{OnGood()} and \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{OnBad()} have exactly the same purpose they have in a Collection: to define action to perform each time an event is selected as good or bad. The class \hyperlink{classSmartCollection}{SmartCollection} is specially designed to handle \hyperlink{classCollectionAction}{CollectionAction} objects: see the documentation of \hyperlink{classSmartCollection}{SmartCollection} for info on how these objects are handled.  The \hyperlink{classCollectionAction}{CollectionAction} abstract class defines an interface for a generic action object which can be used to implement common actions that can be done by collections, like filling histograms or saving selected events. The structure of this class mimicks that of a standard collection: it has a \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{Setup()} and a \hyperlink{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}{Finalize()} methods that are meant to be called at the beginning and at the end of the selection procedure, respectively. In \hyperlink{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{Setup()} one can prepare the analysis actions like instantiating a histogram object (this can be done also in the constructor), while in \hyperlink{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}{Finalize()} the analysis can be closed by, eg., writing histograms on a file and closing that file. The two methods \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{OnGood()} and \hyperlink{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{OnBad()} have exactly the same purpose they have in a Collection: to define action to perform each time an event is selected as good or bad. The class \hyperlink{classSmartCollection}{SmartCollection} is specially designed to handle \hyperlink{classCollectionAction}{CollectionAction} objects: see the documentation of \hyperlink{classSmartCollection}{SmartCollection} for info on how these objects are handled.
   
 Definition at line 30 of file CollectionAction.h.  
45    
46  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
47  \hypertarget{classCollectionAction_35e6d0d0351e0fafe4b508faeb3598d6}{  \hypertarget{classCollectionAction_35e6d0d0351e0fafe4b508faeb3598d6}{
# Line 61  Constructor. Line 60  Constructor.
60  \end{Desc}  \end{Desc}
61    
62    
 Definition at line 37 of file CollectionAction.h.\hypertarget{classCollectionAction_d327a6cfdc6148db563ae52aa004e098}{  
 \index{CollectionAction@{CollectionAction}!$\sim$CollectionAction@{$\sim$CollectionAction}}  
 \index{$\sim$CollectionAction@{$\sim$CollectionAction}!CollectionAction@{CollectionAction}}  
 \subsubsection[{$\sim$CollectionAction}]{\setlength{\rightskip}{0pt plus 5cm}virtual CollectionAction::$\sim$CollectionAction ()\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}  
 \label{classCollectionAction_d327a6cfdc6148db563ae52aa004e098}  
   
   
 Destructor.  
   
   
   
 Definition at line 41 of file CollectionAction.h.  
   
63  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
64  \hypertarget{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{  \hypertarget{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}{
65  \index{CollectionAction@{CollectionAction}!Finalize@{Finalize}}  \index{CollectionAction@{CollectionAction}!Finalize@{Finalize}}
66  \index{Finalize@{Finalize}!CollectionAction@{CollectionAction}}  \index{Finalize@{Finalize}!CollectionAction@{CollectionAction}}
67  \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::Finalize ()\hspace{0.3cm}{\tt  \mbox{[}pure virtual\mbox{]}}}}  \subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::Finalize ()\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
68  \label{classCollectionAction_c32b42fc08bc1be7b003579b633de041}  \label{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}
69    
70    
71  The finalization routine.  The finalization routine.
72    
73  This method is intended to be called at the end of the analysis. Its implementations contain the finalizing procedures, like writing histograms to file or printing reports. It is automatically called by \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection::Finalize()}.  This method is intended to be called at the end of the analysis. Its implementations contain the finalizing procedures, like writing histograms to file or printing reports. It is automatically called by \hyperlink{classSmartCollection_8105730615ad127a482a7fb399695977}{SmartCollection::Finalize()}.
74    
75  Implemented in \hyperlink{classChargeHistosAction_b0aa2e207eea6e8f80c89197f9705dbe}{ChargeHistosAction}, \hyperlink{classEvRateS11VsCutoffHistoAction_71062bd029caf54cb174b9b8df5ed6ad}{EvRateS11VsCutoffHistoAction}, \hyperlink{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{FluxHistoAction}, and \hyperlink{classSaveEventsAction_790f534c0a888c2a57814cd859b97270}{SaveEventsAction}.\hypertarget{classCollectionAction_96783ca0685b2095bf519c17a057c926}{  Reimplemented in \hyperlink{classChargeHistosAction_b0aa2e207eea6e8f80c89197f9705dbe}{ChargeHistosAction}, \hyperlink{classEvRateS11VsCutoffHistoAction_71062bd029caf54cb174b9b8df5ed6ad}{EvRateS11VsCutoffHistoAction}, \hyperlink{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{FluxHistoAction}, and \hyperlink{classSaveEventsAction_790f534c0a888c2a57814cd859b97270}{SaveEventsAction}.\hypertarget{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{
 \index{CollectionAction@{CollectionAction}!GetName@{GetName}}  
 \index{GetName@{GetName}!CollectionAction@{CollectionAction}}  
 \subsubsection[{GetName}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ CollectionAction::GetName ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classCollectionAction_96783ca0685b2095bf519c17a057c926}  
   
   
 Returns the action name.  
   
   
   
 Definition at line 89 of file CollectionAction.h.  
   
 References \_\-actionName.  
   
 Referenced by FluxHistoAction::Finalize().\hypertarget{classCollectionAction_ef4ee9fd63c0d232e90694e068e6e339}{  
76  \index{CollectionAction@{CollectionAction}!OnBad@{OnBad}}  \index{CollectionAction@{CollectionAction}!OnBad@{OnBad}}
77  \index{OnBad@{OnBad}!CollectionAction@{CollectionAction}}  \index{OnBad@{OnBad}!CollectionAction@{CollectionAction}}
78  \subsubsection[{OnBad}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::OnBad (PamLevel2 $\ast$ {\em event}, \/  int {\em selectionResult})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}  \subsubsection[{OnBad}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::OnBad (PamLevel2 $\ast$ {\em event}, \/  int {\em selectionResult})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
# Line 110  Referenced by FluxHistoAction::Finalize( Line 81  Referenced by FluxHistoAction::Finalize(
81    
82  Routine for discarded events.  Routine for discarded events.
83    
84  The concrete implementations define what to do when an event is discarded. This is conceptually the same as \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{PamCut::OnBad()}. Call to this method is automatically done in \hyperlink{classSmartCollection_99ac049c98461fbe04167f386ca7ed76}{SmartCollection::OnBad()}. This method is not pure virtual, since many times there's nothing to do when a cut fails; this way, it's not necessary to implement it in derived classes. Current implementation is void.  The concrete implementations define what to do when an event is discarded. This is conceptually the same as \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{PamCut::OnBad()}. Call to this method is automatically done in \hyperlink{classPamCut_cbb3b507d79f20878fac4392ffa57acb}{SmartCollection::OnBad()}. This method is not pure virtual, since many times there's nothing to do when a cut fails; this way, it's not necessary to implement it in derived classes. Current implementation is void.
85    
86  \begin{Desc}  \begin{Desc}
87  \item[Parameters:]  \item[Parameters:]
88  \begin{description}  \begin{description}
89  \item[{\em event}]The selected event. \item[{\em selectionResult}]The code describing the reason of cut's failure (collections will automatically pass the index of the failed cut as selectionResult). \end{description}  \item[{\em event}]The selected event. \item[{\em selectionResult}]The code describing the reason of cut's failure (collections will automatically pass the index of the failed cut as selectionResult). \end{description}
90  \end{Desc}  \end{Desc}
91    \hypertarget{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{
   
 Definition at line 78 of file CollectionAction.h.\hypertarget{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{  
92  \index{CollectionAction@{CollectionAction}!OnGood@{OnGood}}  \index{CollectionAction@{CollectionAction}!OnGood@{OnGood}}
93  \index{OnGood@{OnGood}!CollectionAction@{CollectionAction}}  \index{OnGood@{OnGood}!CollectionAction@{CollectionAction}}
94  \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}pure virtual\mbox{]}}}}  \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
95  \label{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}  \label{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}
96    
97    
98  Routine for selected events.  Routine for selected events.
99    
100  The concrete implementations define what to do when an event is selected. This is conceptually the same as \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCut::OnGood()}. Call to this method is automatically done in \hyperlink{classSmartCollection_13ce6deb47b60d10225598dd1201cd80}{SmartCollection::OnGood()}.  The concrete implementations define what to do when an event is selected. This is conceptually the same as \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCut::OnGood()}. Call to this method is automatically done in \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{SmartCollection::OnGood()}.
101    
102  \begin{Desc}  \begin{Desc}
103  \item[Parameters:]  \item[Parameters:]
# Line 137  The concrete implementations define what Line 106  The concrete implementations define what
106  \end{Desc}  \end{Desc}
107    
108    
109  Implemented in \hyperlink{classChargeHistosAction_315d81cbff24a228c85b648393d67107}{ChargeHistosAction}, \hyperlink{classEvRateS11VsCutoffHistoAction_bb38c1bcb9d3e52abd6f929db8577ac6}{EvRateS11VsCutoffHistoAction}, \hyperlink{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{FluxHistoAction}, and \hyperlink{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a}{SaveEventsAction}.\hypertarget{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{  Reimplemented in \hyperlink{classChargeHistosAction_315d81cbff24a228c85b648393d67107}{ChargeHistosAction}, \hyperlink{classEvRateS11VsCutoffHistoAction_bb38c1bcb9d3e52abd6f929db8577ac6}{EvRateS11VsCutoffHistoAction}, \hyperlink{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{FluxHistoAction}, and \hyperlink{classSaveEventsAction_47e8259afe7a68ba3c0adf3bd79fe52a}{SaveEventsAction}.\hypertarget{classCollectionAction_13adbcacf5e088f7979f0644a65372b4}{
110  \index{CollectionAction@{CollectionAction}!Setup@{Setup}}  \index{CollectionAction@{CollectionAction}!Setup@{Setup}}
111  \index{Setup@{Setup}!CollectionAction@{CollectionAction}}  \index{Setup@{Setup}!CollectionAction@{CollectionAction}}
112  \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}  \subsubsection[{Setup}]{\setlength{\rightskip}{0pt plus 5cm}virtual void CollectionAction::Setup (PamLevel2 $\ast$ {\em events})\hspace{0.3cm}{\tt  \mbox{[}inline, virtual\mbox{]}}}}
# Line 157  In this routine the initialization proce Line 126  In this routine the initialization proce
126    
127  Reimplemented in \hyperlink{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2}{SaveEventsAction}.  Reimplemented in \hyperlink{classSaveEventsAction_3a59e42181c79dcd192b0be3d14a34c2}{SaveEventsAction}.
128    
 Definition at line 55 of file CollectionAction.h.  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classCollectionAction_5c046c663d75fdcb53d00cda91cc3509}{  
 \index{CollectionAction@{CollectionAction}!\_\-actionName@{\_\-actionName}}  
 \index{\_\-actionName@{\_\-actionName}!CollectionAction@{CollectionAction}}  
 \subsubsection[{\_\-actionName}]{\setlength{\rightskip}{0pt plus 5cm}const char$\ast$ {\bf CollectionAction::\_\-actionName}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classCollectionAction_5c046c663d75fdcb53d00cda91cc3509}  
   
   
   
   
 Definition at line 94 of file CollectionAction.h.  
   
 Referenced by GetName().  
   
129  The documentation for this class was generated from the following file:\begin{CompactItemize}  The documentation for this class was generated from the following file:\begin{CompactItemize}
130  \item  \item
131  CollectionActions/CollectionAction/\hyperlink{CollectionAction_8h}{CollectionAction.h}\end{CompactItemize}  CollectionActions/CollectionAction/\hyperlink{CollectionAction_8h}{CollectionAction.h}\end{CompactItemize}
Legend:
Removed from v.1.1.1.1  
changed lines
  Added in v.1.3
  ViewVC Help
Powered by ViewVC 1.1.23