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

Annotation of /PamCut/doc/Doxygen/latex/classChargeHistosAction.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (hide annotations) (download) (as text)
Fri Jun 5 13:15:04 2009 UTC (15 years, 10 months ago) by pam-fi
Branch: MAIN
Changes since 1.1: +10 -397 lines
File MIME type: application/x-tex
Updated.

1 pam-fi 1.1 \hypertarget{classChargeHistosAction}{
2     \section{ChargeHistosAction Class Reference}
3     \label{classChargeHistosAction}\index{ChargeHistosAction@{ChargeHistosAction}}
4     }
5     An action that fills some charge histograms.
6    
7    
8     {\tt \#include $<$ChargeHistosAction.h$>$}
9    
10     Inheritance diagram for ChargeHistosAction::\begin{figure}[H]
11     \begin{center}
12     \leavevmode
13     \includegraphics[height=2cm]{classChargeHistosAction}
14     \end{center}
15     \end{figure}
16     \subsection*{Public Member Functions}
17     \begin{CompactItemize}
18     \item
19     \hyperlink{classChargeHistosAction_0d446a2a28970c231b84a85d321db00d}{ChargeHistosAction} (const char $\ast$actionName, TString outFileName)
20     \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 pam-fi 1.2 \hypertarget{classChargeHistosAction_990afb1de268c2e0e50f2d176b3abf6d}{
22     \hyperlink{classChargeHistosAction_990afb1de268c2e0e50f2d176b3abf6d}{$\sim$ChargeHistosAction} ()}
23     \label{classChargeHistosAction_990afb1de268c2e0e50f2d176b3abf6d}
24    
25 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26     void \hyperlink{classChargeHistosAction_315d81cbff24a228c85b648393d67107}{OnGood} (PamLevel2 $\ast$event)
27     \begin{CompactList}\small\item\em The histogram filling method. \item\end{CompactList}\item
28 pam-fi 1.2 \hypertarget{classChargeHistosAction_b0aa2e207eea6e8f80c89197f9705dbe}{
29     void \hyperlink{classChargeHistosAction_b0aa2e207eea6e8f80c89197f9705dbe}{Finalize} ()}
30     \label{classChargeHistosAction_b0aa2e207eea6e8f80c89197f9705dbe}
31    
32 pam-fi 1.1 \begin{CompactList}\small\item\em Saves the histograms and closes the file. \item\end{CompactList}\end{CompactItemize}
33    
34    
35     \subsection{Detailed Description}
36     An action that fills some charge histograms.
37    
38     This class uses ToFNuclei, TrkNuclei and CaloNuclei to compute the charge of the particle and fills various histograms. Note that if the Nuclei routines are not available in the environment it is possible to exclude the corresponding code by passing the appropriate flags to the compiler (see the EXCLUDEFLAGS variable in the PamCut's makefile). Currently, filled histograms are:\begin{itemize}
39     \item charge from TrkNuclei (Siegen method);\item charge from CaloNuclei (first plane dE/dx Vs. beta);\item charge from each ToF layer (dE/dx Vs. beta);\item charge correlation for each pair of ToF layers. \end{itemize}
40    
41    
42     \subsection{Constructor \& Destructor Documentation}
43     \hypertarget{classChargeHistosAction_0d446a2a28970c231b84a85d321db00d}{
44     \index{ChargeHistosAction@{ChargeHistosAction}!ChargeHistosAction@{ChargeHistosAction}}
45     \index{ChargeHistosAction@{ChargeHistosAction}!ChargeHistosAction@{ChargeHistosAction}}
46     \subsubsection[{ChargeHistosAction}]{\setlength{\rightskip}{0pt plus 5cm}ChargeHistosAction::ChargeHistosAction (const char $\ast$ {\em actionName}, \/ TString {\em outFileName})}}
47     \label{classChargeHistosAction_0d446a2a28970c231b84a85d321db00d}
48    
49    
50     Constructor.
51    
52     \begin{Desc}
53     \item[Parameters:]
54     \begin{description}
55     \item[{\em actionName}]The action's name. \item[{\em outFileName}]The output ROOT file name. \end{description}
56     \end{Desc}
57    
58    
59     \subsection{Member Function Documentation}
60 pam-fi 1.2 \hypertarget{classChargeHistosAction_315d81cbff24a228c85b648393d67107}{
61 pam-fi 1.1 \index{ChargeHistosAction@{ChargeHistosAction}!OnGood@{OnGood}}
62     \index{OnGood@{OnGood}!ChargeHistosAction@{ChargeHistosAction}}
63     \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void ChargeHistosAction::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
64     \label{classChargeHistosAction_315d81cbff24a228c85b648393d67107}
65    
66    
67     The histogram filling method.
68    
69     This routine fills the charge histograms for the selected event. \begin{Desc}
70     \item[Parameters:]
71     \begin{description}
72     \item[{\em event}]The selected event. \end{description}
73     \end{Desc}
74    
75    
76 pam-fi 1.2 Reimplemented from \hyperlink{classCollectionAction_077319900b1cde36b6baca9e6699ec5a}{CollectionAction}.
77 pam-fi 1.1
78     The documentation for this class was generated from the following files:\begin{CompactItemize}
79     \item
80     CollectionActions/ChargeHistosAction/\hyperlink{ChargeHistosAction_8h}{ChargeHistosAction.h}\item
81     CollectionActions/ChargeHistosAction/\hyperlink{ChargeHistosAction_8cpp}{ChargeHistosAction.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23