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

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

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

revision 1.1 by pam-fi, Wed May 27 13:30:03 2009 UTC revision 1.2 by pam-fi, Fri Jun 5 13:15:19 2009 UTC
# Line 18  Inheritance diagram for FluxHistoAction: Line 18  Inheritance diagram for FluxHistoAction:
18  \item  \item
19  \hyperlink{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d}{FluxHistoAction} (const char $\ast$actionName, TString outFileBase, TString rigBinsFile)  \hyperlink{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d}{FluxHistoAction} (const char $\ast$actionName, TString outFileBase, TString rigBinsFile)
20  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21  \hyperlink{classFluxHistoAction_2a38b72b56859e2f6eef38d800ca5c10}{$\sim$FluxHistoAction} ()  \hypertarget{classFluxHistoAction_2a38b72b56859e2f6eef38d800ca5c10}{
22    \hyperlink{classFluxHistoAction_2a38b72b56859e2f6eef38d800ca5c10}{$\sim$FluxHistoAction} ()}
23    \label{classFluxHistoAction_2a38b72b56859e2f6eef38d800ca5c10}
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{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{OnGood} (PamLevel2 $\ast$event)  void \hyperlink{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{OnGood} (PamLevel2 $\ast$event)
27  \begin{CompactList}\small\item\em Fills histogram with the selected event. \item\end{CompactList}\item  \begin{CompactList}\small\item\em Fills histogram with the selected event. \item\end{CompactList}\item
28  void \hyperlink{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{Finalize} ()  void \hyperlink{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{Finalize} ()
29  \begin{CompactList}\small\item\em Writes the histogram to the output files (ASCII and ROOT). \item\end{CompactList}\end{CompactItemize}  \begin{CompactList}\small\item\em Writes the histogram to the output files (ASCII and ROOT). \item\end{CompactList}\end{CompactItemize}
 \subsection*{Private Attributes}  
 \begin{CompactItemize}  
 \item  
 TString \hyperlink{classFluxHistoAction_aa222dff82e9c14a330f95a9fc51d142}{\_\-outFileBase}  
 \item  
 vector$<$ float $>$ \hyperlink{classFluxHistoAction_c739385ec91f9a66caa36af6da127aa1}{\_\-bins}  
 \item  
 TH1I \hyperlink{classFluxHistoAction_ece98abe4d37ec7b9e872143203bc613}{\_\-rootHisto}  
 \item  
 vector$<$ uint64\_\-t $>$ \hyperlink{classFluxHistoAction_39cb52b179b2d169f39d692ca3f077ce}{\_\-textHisto}  
 \end{CompactItemize}  
30    
31    
32  \subsection{Detailed Description}  \subsection{Detailed Description}
# Line 42  An action that fills a flux histogram. Line 34  An action that fills a flux histogram.
34    
35  This action reads a rigidity binning from a file and fills a flux histogram (text and ROOT format). Currently, it fills an event-count histogram: in future implementations, it could also read live time, efficiency and geometrical factor from external files and fill a true flux histogram.  This action reads a rigidity binning from a file and fills a flux histogram (text and ROOT format). Currently, it fills an event-count histogram: in future implementations, it could also read live time, efficiency and geometrical factor from external files and fill a true flux histogram.
36    
 Definition at line 24 of file FluxHistoAction.h.  
   
37  \subsection{Constructor \& Destructor Documentation}  \subsection{Constructor \& Destructor Documentation}
38  \hypertarget{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d}{  \hypertarget{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d}{
39  \index{FluxHistoAction@{FluxHistoAction}!FluxHistoAction@{FluxHistoAction}}  \index{FluxHistoAction@{FluxHistoAction}!FluxHistoAction@{FluxHistoAction}}
# Line 63  outFileBase is the base name for output Line 53  outFileBase is the base name for output
53  \end{Desc}  \end{Desc}
54    
55    
 Definition at line 12 of file FluxHistoAction.cpp.  
   
 References \_\-bins, \_\-rootHisto, and \_\-textHisto.\hypertarget{classFluxHistoAction_2a38b72b56859e2f6eef38d800ca5c10}{  
 \index{FluxHistoAction@{FluxHistoAction}!$\sim$FluxHistoAction@{$\sim$FluxHistoAction}}  
 \index{$\sim$FluxHistoAction@{$\sim$FluxHistoAction}!FluxHistoAction@{FluxHistoAction}}  
 \subsubsection[{$\sim$FluxHistoAction}]{\setlength{\rightskip}{0pt plus 5cm}FluxHistoAction::$\sim$FluxHistoAction ()\hspace{0.3cm}{\tt  \mbox{[}inline\mbox{]}}}}  
 \label{classFluxHistoAction_2a38b72b56859e2f6eef38d800ca5c10}  
   
   
 Destructor.  
   
   
   
 Definition at line 43 of file FluxHistoAction.h.  
   
56  \subsection{Member Function Documentation}  \subsection{Member Function Documentation}
57  \hypertarget{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{  \hypertarget{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{
58  \index{FluxHistoAction@{FluxHistoAction}!Finalize@{Finalize}}  \index{FluxHistoAction@{FluxHistoAction}!Finalize@{Finalize}}
# Line 90  Writes the histogram to the output files Line 65  Writes the histogram to the output files
65    
66  The output consists of a text file and of a ROOT file where the 1-dimensional rigidity histogram (TH1F) is saved. The format of the text output is: (lower bin limit) (upper bin limit) (\# of events).  The output consists of a text file and of a ROOT file where the 1-dimensional rigidity histogram (TH1F) is saved. The format of the text output is: (lower bin limit) (upper bin limit) (\# of events).
67    
68  Implements \hyperlink{classCollectionAction_c32b42fc08bc1be7b003579b633de041}{CollectionAction}.  Reimplemented from \hyperlink{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}{CollectionAction}.\hypertarget{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{
   
 Definition at line 79 of file FluxHistoAction.cpp.  
   
 References \_\-bins, \_\-outFileBase, \_\-rootHisto, \_\-textHisto, and CollectionAction::GetName().\hypertarget{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{  
69  \index{FluxHistoAction@{FluxHistoAction}!OnGood@{OnGood}}  \index{FluxHistoAction@{FluxHistoAction}!OnGood@{OnGood}}
70  \index{OnGood@{OnGood}!FluxHistoAction@{FluxHistoAction}}  \index{OnGood@{OnGood}!FluxHistoAction@{FluxHistoAction}}
71  \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void FluxHistoAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}  \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void FluxHistoAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt  \mbox{[}virtual\mbox{]}}}}
# Line 110  Fills histogram with the selected event. Line 81  Fills histogram with the selected event.
81  \end{Desc}  \end{Desc}
82    
83    
84  Implements \hyperlink{classCollectionAction_801dd664020b71e8a3232e5a584d96a0}{CollectionAction}.  Reimplemented from \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{CollectionAction}.
   
 Definition at line 50 of file FluxHistoAction.cpp.  
   
 References \_\-bins, \_\-rootHisto, and \_\-textHisto.  
   
 \subsection{Member Data Documentation}  
 \hypertarget{classFluxHistoAction_c739385ec91f9a66caa36af6da127aa1}{  
 \index{FluxHistoAction@{FluxHistoAction}!\_\-bins@{\_\-bins}}  
 \index{\_\-bins@{\_\-bins}!FluxHistoAction@{FluxHistoAction}}  
 \subsubsection[{\_\-bins}]{\setlength{\rightskip}{0pt plus 5cm}vector$<$float$>$ {\bf FluxHistoAction::\_\-bins}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classFluxHistoAction_c739385ec91f9a66caa36af6da127aa1}  
   
   
   
   
 Definition at line 62 of file FluxHistoAction.h.  
   
 Referenced by Finalize(), FluxHistoAction(), and OnGood().\hypertarget{classFluxHistoAction_aa222dff82e9c14a330f95a9fc51d142}{  
 \index{FluxHistoAction@{FluxHistoAction}!\_\-outFileBase@{\_\-outFileBase}}  
 \index{\_\-outFileBase@{\_\-outFileBase}!FluxHistoAction@{FluxHistoAction}}  
 \subsubsection[{\_\-outFileBase}]{\setlength{\rightskip}{0pt plus 5cm}TString {\bf FluxHistoAction::\_\-outFileBase}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classFluxHistoAction_aa222dff82e9c14a330f95a9fc51d142}  
   
   
   
   
 Definition at line 61 of file FluxHistoAction.h.  
   
 Referenced by Finalize().\hypertarget{classFluxHistoAction_ece98abe4d37ec7b9e872143203bc613}{  
 \index{FluxHistoAction@{FluxHistoAction}!\_\-rootHisto@{\_\-rootHisto}}  
 \index{\_\-rootHisto@{\_\-rootHisto}!FluxHistoAction@{FluxHistoAction}}  
 \subsubsection[{\_\-rootHisto}]{\setlength{\rightskip}{0pt plus 5cm}TH1I {\bf FluxHistoAction::\_\-rootHisto}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classFluxHistoAction_ece98abe4d37ec7b9e872143203bc613}  
   
   
   
   
 Definition at line 63 of file FluxHistoAction.h.  
   
 Referenced by Finalize(), FluxHistoAction(), and OnGood().\hypertarget{classFluxHistoAction_39cb52b179b2d169f39d692ca3f077ce}{  
 \index{FluxHistoAction@{FluxHistoAction}!\_\-textHisto@{\_\-textHisto}}  
 \index{\_\-textHisto@{\_\-textHisto}!FluxHistoAction@{FluxHistoAction}}  
 \subsubsection[{\_\-textHisto}]{\setlength{\rightskip}{0pt plus 5cm}vector$<$uint64\_\-t$>$ {\bf FluxHistoAction::\_\-textHisto}\hspace{0.3cm}{\tt  \mbox{[}private\mbox{]}}}}  
 \label{classFluxHistoAction_39cb52b179b2d169f39d692ca3f077ce}  
   
   
   
   
 Definition at line 64 of file FluxHistoAction.h.  
   
 Referenced by Finalize(), FluxHistoAction(), and OnGood().  
85    
86  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}
87  \item  \item
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.23