| 1 |
\hypertarget{classFluxHistoAction}{ |
| 2 |
\section{FluxHistoAction Class Reference} |
| 3 |
\label{classFluxHistoAction}\index{FluxHistoAction@{FluxHistoAction}} |
| 4 |
} |
| 5 |
An action that fills a flux histogram. |
| 6 |
|
| 7 |
|
| 8 |
{\tt \#include $<$FluxHistoAction.h$>$} |
| 9 |
|
| 10 |
Inheritance diagram for FluxHistoAction::\begin{figure}[H] |
| 11 |
\begin{center} |
| 12 |
\leavevmode |
| 13 |
\includegraphics[height=2cm]{classFluxHistoAction} |
| 14 |
\end{center} |
| 15 |
\end{figure} |
| 16 |
\subsection*{Public Member Functions} |
| 17 |
\begin{CompactItemize} |
| 18 |
\item |
| 19 |
\hyperlink{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d}{FluxHistoAction} (const char $\ast$actionName, TString outFileBase, TString rigBinsFile) |
| 20 |
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item |
| 21 |
\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 |
| 26 |
void \hyperlink{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{OnGood} (PamLevel2 $\ast$event) |
| 27 |
\begin{CompactList}\small\item\em Fills histogram with the selected event. \item\end{CompactList}\item |
| 28 |
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} |
| 30 |
|
| 31 |
|
| 32 |
\subsection{Detailed Description} |
| 33 |
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. |
| 36 |
|
| 37 |
\subsection{Constructor \& Destructor Documentation} |
| 38 |
\hypertarget{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d}{ |
| 39 |
\index{FluxHistoAction@{FluxHistoAction}!FluxHistoAction@{FluxHistoAction}} |
| 40 |
\index{FluxHistoAction@{FluxHistoAction}!FluxHistoAction@{FluxHistoAction}} |
| 41 |
\subsubsection[{FluxHistoAction}]{\setlength{\rightskip}{0pt plus 5cm}FluxHistoAction::FluxHistoAction (const char $\ast$ {\em actionName}, \/ TString {\em outFileBase}, \/ TString {\em rigBinsFile})}} |
| 42 |
\label{classFluxHistoAction_2f215089b4dc3b414b29a88e32df820d} |
| 43 |
|
| 44 |
|
| 45 |
Constructor. |
| 46 |
|
| 47 |
outFileBase is the base name for output file: \hyperlink{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{Finalize} will add .txt for ASCII output and .root for ROOT output. outFileBase has to contain the path (otherwise, files will be saved in the current directory). The file containing the rigidity bins must be a text file. It must contain both the lower and upper limits of the rigidity axis, so that if it contains N values it defines a set of N-1 bins. |
| 48 |
|
| 49 |
\begin{Desc} |
| 50 |
\item[Parameters:] |
| 51 |
\begin{description} |
| 52 |
\item[{\em actionName}]The action's name. \item[{\em outFileBase}]The output file base name. \item[{\em rigBinsFile}]The file containing the rigidity bins \end{description} |
| 53 |
\end{Desc} |
| 54 |
|
| 55 |
|
| 56 |
\subsection{Member Function Documentation} |
| 57 |
\hypertarget{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04}{ |
| 58 |
\index{FluxHistoAction@{FluxHistoAction}!Finalize@{Finalize}} |
| 59 |
\index{Finalize@{Finalize}!FluxHistoAction@{FluxHistoAction}} |
| 60 |
\subsubsection[{Finalize}]{\setlength{\rightskip}{0pt plus 5cm}void FluxHistoAction::Finalize ()\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}} |
| 61 |
\label{classFluxHistoAction_4565d0ea3ca0f895af489455dfd5ff04} |
| 62 |
|
| 63 |
|
| 64 |
Writes the histogram to the output files (ASCII and ROOT). |
| 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). |
| 67 |
|
| 68 |
Reimplemented from \hyperlink{classCollectionAction_3644c42bef3002c44202b6e9630bc1a4}{CollectionAction}.\hypertarget{classFluxHistoAction_363f9657ac69e1051449ec1907c04809}{ |
| 69 |
\index{FluxHistoAction@{FluxHistoAction}!OnGood@{OnGood}} |
| 70 |
\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{]}}}} |
| 72 |
\label{classFluxHistoAction_363f9657ac69e1051449ec1907c04809} |
| 73 |
|
| 74 |
|
| 75 |
Fills histogram with the selected event. |
| 76 |
|
| 77 |
\begin{Desc} |
| 78 |
\item[Parameters:] |
| 79 |
\begin{description} |
| 80 |
\item[{\em event}]The selected event. \end{description} |
| 81 |
\end{Desc} |
| 82 |
|
| 83 |
|
| 84 |
Reimplemented from \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{CollectionAction}. |
| 85 |
|
| 86 |
The documentation for this class was generated from the following files:\begin{CompactItemize} |
| 87 |
\item |
| 88 |
CollectionActions/FluxHistoAction/\hyperlink{FluxHistoAction_8h}{FluxHistoAction.h}\item |
| 89 |
CollectionActions/FluxHistoAction/\hyperlink{FluxHistoAction_8cpp}{FluxHistoAction.cpp}\end{CompactItemize} |
Parent Directory
| 
Revision Log