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

Contents of /PamCut/doc/Doxygen/latex/classRigFillCut.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1.1.1 - (show annotations) (download) (as text) (vendor branch)
Wed May 27 13:30:02 2009 UTC (15 years, 6 months ago) by pam-fi
Branch: DEV
CVS Tags: v0r00
Changes since 1.1: +0 -0 lines
File MIME type: application/x-tex
First import

1 \hypertarget{classRigFillCut}{
2 \section{RigFillCut Class Reference}
3 \label{classRigFillCut}\index{RigFillCut@{RigFillCut}}
4 }
5 The rigidity vs threshold rigidity histogram filling.
6
7
8 {\tt \#include $<$RigFillCut.h$>$}
9
10 Inheritance diagram for RigFillCut::\begin{figure}[H]
11 \begin{center}
12 \leavevmode
13 \includegraphics[height=2cm]{classRigFillCut}
14 \end{center}
15 \end{figure}
16 \subsection*{Public Member Functions}
17 \begin{CompactItemize}
18 \item
19 \hyperlink{classRigFillCut_db50b4fec5f11499db9039baea8a4392}{RigFillCut} (const char $\ast$cutName, std::vector$<$ float $>$ binning, float thresholdCoeff)
20 \begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item
21 \hyperlink{classRigFillCut_3e1f3f9df6e8c684060ccd76da9edaad}{$\sim$RigFillCut} ()
22 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
23 int \hyperlink{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}{Check} (PamLevel2 $\ast$event)
24 \begin{CompactList}\small\item\em The rigidity and cutoff rigidity check. \item\end{CompactList}\item
25 void \hyperlink{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}{OnGood} (PamLevel2 $\ast$event)
26 \begin{CompactList}\small\item\em The histogram filling. \item\end{CompactList}\item
27 \hyperlink{classSimpleMatrix}{SimpleMatrix}$<$ UInt\_\-t $>$ \& \hyperlink{classRigFillCut_532f3bb2e39f3c9da3a70e72eae8389d}{GetHisto} ()
28 \begin{CompactList}\small\item\em Returns the histogram. \item\end{CompactList}\end{CompactItemize}
29 \subsection*{Private Attributes}
30 \begin{CompactItemize}
31 \item
32 std::vector$<$ float $>$ \hyperlink{classRigFillCut_24c7fece1b02c4222dc2fd9d0d13bcc0}{\_\-binning}
33 \item
34 \hyperlink{classSimpleMatrix}{SimpleMatrix}$<$ UInt\_\-t $>$ \hyperlink{classRigFillCut_9c0b18d019325388ab4d99cd304a5909}{\_\-histogram}
35 \item
36 float \hyperlink{classRigFillCut_5634e95eb75291fd866f995a324a3a0a}{\_\-thresholdCoeff}
37 \end{CompactItemize}
38
39
40 \subsection{Detailed Description}
41 The rigidity vs threshold rigidity histogram filling.
42
43 This class checks the events and builds a 2D histogram binned in rigidity modulus and threshold rigidity. Each 2D bin will contain the number of events whose rigidity modulus and threshold rigidity (eg., Stoermer cutoff rigidity times a threshold coefficient) lie in that bin. Note that the meaning of this threshold coefficient is the same as in \hyperlink{classTrkRigGeoCut}{TrkRigGeoCut}, so it must have the same value used for \hyperlink{classTrkRigGeoCut}{TrkRigGeoCut} (consider using \hyperlink{classTrkRigGeoCut_5b3e2d3037d140ae852bd02975842eb4}{TrkRigGeoCut::GetThresholdCoeff()} to retrieve its value). Events are discarded only if their rigidity modulus or cutoff rigidity lies outside the histogram bounds.
44
45 CUT DEPENDECIES: \hyperlink{classTrkPhSinCut}{TrkPhSinCut} for single physical track, \hyperlink{classTrkRigGeoCut}{TrkRigGeoCut} for galactic event.
46
47 Definition at line 37 of file RigFillCut.h.
48
49 \subsection{Constructor \& Destructor Documentation}
50 \hypertarget{classRigFillCut_db50b4fec5f11499db9039baea8a4392}{
51 \index{RigFillCut@{RigFillCut}!RigFillCut@{RigFillCut}}
52 \index{RigFillCut@{RigFillCut}!RigFillCut@{RigFillCut}}
53 \subsubsection[{RigFillCut}]{\setlength{\rightskip}{0pt plus 5cm}RigFillCut::RigFillCut (const char $\ast$ {\em cutName}, \/ std::vector$<$ float $>$ {\em binning}, \/ float {\em thresholdCoeff})\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
54 \label{classRigFillCut_db50b4fec5f11499db9039baea8a4392}
55
56
57 Constructor.
58
59 The binning vectors must contain both the upper and lower limits, and the elements must be ordered (ie., lowest value in the first element and so on) and positive, so that charge sign will be irrelevant.
60
61 \begin{Desc}
62 \item[Parameters:]
63 \begin{description}
64 \item[{\em cutName}]The cut's name. \item[{\em binning}]A vector containing the histogram binning in rigidity modulus (X axis) and cutoff rigidity (Y axis). \item[{\em thresholdCoeff}]The threshold rigidity coefficient for the event selection. \end{description}
65 \end{Desc}
66
67
68 Definition at line 51 of file RigFillCut.h.\hypertarget{classRigFillCut_3e1f3f9df6e8c684060ccd76da9edaad}{
69 \index{RigFillCut@{RigFillCut}!$\sim$RigFillCut@{$\sim$RigFillCut}}
70 \index{$\sim$RigFillCut@{$\sim$RigFillCut}!RigFillCut@{RigFillCut}}
71 \subsubsection[{$\sim$RigFillCut}]{\setlength{\rightskip}{0pt plus 5cm}RigFillCut::$\sim$RigFillCut ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
72 \label{classRigFillCut_3e1f3f9df6e8c684060ccd76da9edaad}
73
74
75 Destructor.
76
77
78
79 Definition at line 57 of file RigFillCut.h.
80
81 \subsection{Member Function Documentation}
82 \hypertarget{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}{
83 \index{RigFillCut@{RigFillCut}!Check@{Check}}
84 \index{Check@{Check}!RigFillCut@{RigFillCut}}
85 \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int RigFillCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
86 \label{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}
87
88
89 The rigidity and cutoff rigidity check.
90
91 The event is discarded if its rigidity modulus or threshold rigidity are outside the limits of the binnings. Please note that only absolute rigidity is considered.
92
93 \begin{Desc}
94 \item[Parameters:]
95 \begin{description}
96 \item[{\em event}]The event to analyze. \end{description}
97 \end{Desc}
98 \begin{Desc}
99 \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if both rigidity modulus and threshold rigidity is contained in the histogram limits.
100
101 0 otherwise. \end{Desc}
102
103
104 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.
105
106 Definition at line 12 of file RigFillCut.cpp.
107
108 References \_\-binning, \_\-thresholdCoeff, CUTOK, RIGOUT, and THRESHRIGOUT.\hypertarget{classRigFillCut_532f3bb2e39f3c9da3a70e72eae8389d}{
109 \index{RigFillCut@{RigFillCut}!GetHisto@{GetHisto}}
110 \index{GetHisto@{GetHisto}!RigFillCut@{RigFillCut}}
111 \subsubsection[{GetHisto}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SimpleMatrix}$<$UInt\_\-t$>$\& RigFillCut::GetHisto ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
112 \label{classRigFillCut_532f3bb2e39f3c9da3a70e72eae8389d}
113
114
115 Returns the histogram.
116
117 This method returns a \hyperlink{classSimpleMatrix}{SimpleMatrix}. Its \mbox{[}i\mbox{]}\mbox{[}j\mbox{]} element contain the number of analyzed events whose rigidity modulus falls in the i-th rigidity bin and whose threshold rigidity falls in the j-th rigidity bin.
118
119 \begin{Desc}
120 \item[Returns:]The rigidity modulus - threshold rigidity 2D histogram \end{Desc}
121
122
123 Definition at line 86 of file RigFillCut.h.
124
125 References \_\-histogram.\hypertarget{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}{
126 \index{RigFillCut@{RigFillCut}!OnGood@{OnGood}}
127 \index{OnGood@{OnGood}!RigFillCut@{RigFillCut}}
128 \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void RigFillCut::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
129 \label{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}
130
131
132 The histogram filling.
133
134 The method fills the histogram with the currently selected event.
135
136 \begin{Desc}
137 \item[Parameters:]
138 \begin{description}
139 \item[{\em event}]The currently selected event. \end{description}
140 \end{Desc}
141
142
143 Reimplemented from \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCut}.
144
145 Definition at line 29 of file RigFillCut.cpp.
146
147 References \_\-binning, \_\-histogram, and \_\-thresholdCoeff.
148
149 \subsection{Member Data Documentation}
150 \hypertarget{classRigFillCut_24c7fece1b02c4222dc2fd9d0d13bcc0}{
151 \index{RigFillCut@{RigFillCut}!\_\-binning@{\_\-binning}}
152 \index{\_\-binning@{\_\-binning}!RigFillCut@{RigFillCut}}
153 \subsubsection[{\_\-binning}]{\setlength{\rightskip}{0pt plus 5cm}std::vector$<$float$>$ {\bf RigFillCut::\_\-binning}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
154 \label{classRigFillCut_24c7fece1b02c4222dc2fd9d0d13bcc0}
155
156
157
158
159 Definition at line 92 of file RigFillCut.h.
160
161 Referenced by Check(), and OnGood().\hypertarget{classRigFillCut_9c0b18d019325388ab4d99cd304a5909}{
162 \index{RigFillCut@{RigFillCut}!\_\-histogram@{\_\-histogram}}
163 \index{\_\-histogram@{\_\-histogram}!RigFillCut@{RigFillCut}}
164 \subsubsection[{\_\-histogram}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SimpleMatrix}$<$UInt\_\-t$>$ {\bf RigFillCut::\_\-histogram}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
165 \label{classRigFillCut_9c0b18d019325388ab4d99cd304a5909}
166
167
168
169
170 Definition at line 93 of file RigFillCut.h.
171
172 Referenced by GetHisto(), and OnGood().\hypertarget{classRigFillCut_5634e95eb75291fd866f995a324a3a0a}{
173 \index{RigFillCut@{RigFillCut}!\_\-thresholdCoeff@{\_\-thresholdCoeff}}
174 \index{\_\-thresholdCoeff@{\_\-thresholdCoeff}!RigFillCut@{RigFillCut}}
175 \subsubsection[{\_\-thresholdCoeff}]{\setlength{\rightskip}{0pt plus 5cm}float {\bf RigFillCut::\_\-thresholdCoeff}\hspace{0.3cm}{\tt \mbox{[}private\mbox{]}}}}
176 \label{classRigFillCut_5634e95eb75291fd866f995a324a3a0a}
177
178
179
180
181 Definition at line 94 of file RigFillCut.h.
182
183 Referenced by Check(), and OnGood().
184
185 The documentation for this class was generated from the following files:\begin{CompactItemize}
186 \item
187 TrkCuts/RigFillCut/\hyperlink{RigFillCut_8h}{RigFillCut.h}\item
188 TrkCuts/RigFillCut/\hyperlink{RigFillCut_8cpp}{RigFillCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23