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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.3 - (hide annotations) (download) (as text)
Fri Sep 25 15:43:38 2009 UTC (15 years, 2 months ago) by pam-fi
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +0 -0 lines
File MIME type: application/x-tex
FILE REMOVED
Removed from repository.

1 pam-fi 1.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 pam-fi 1.2 \hypertarget{classRigFillCut_3e1f3f9df6e8c684060ccd76da9edaad}{
22     \hyperlink{classRigFillCut_3e1f3f9df6e8c684060ccd76da9edaad}{$\sim$RigFillCut} ()}
23     \label{classRigFillCut_3e1f3f9df6e8c684060ccd76da9edaad}
24    
25 pam-fi 1.1 \begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item
26     int \hyperlink{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}{Check} (PamLevel2 $\ast$event)
27     \begin{CompactList}\small\item\em The rigidity and cutoff rigidity check. \item\end{CompactList}\item
28     void \hyperlink{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}{OnGood} (PamLevel2 $\ast$event)
29     \begin{CompactList}\small\item\em The histogram filling. \item\end{CompactList}\item
30     \hyperlink{classSimpleMatrix}{SimpleMatrix}$<$ UInt\_\-t $>$ \& \hyperlink{classRigFillCut_532f3bb2e39f3c9da3a70e72eae8389d}{GetHisto} ()
31     \begin{CompactList}\small\item\em Returns the histogram. \item\end{CompactList}\end{CompactItemize}
32    
33    
34     \subsection{Detailed Description}
35     The rigidity vs threshold rigidity histogram filling.
36    
37     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.
38    
39     CUT DEPENDECIES: \hyperlink{classTrkPhSinCut}{TrkPhSinCut} for single physical track, \hyperlink{classTrkRigGeoCut}{TrkRigGeoCut} for galactic event.
40    
41     \subsection{Constructor \& Destructor Documentation}
42     \hypertarget{classRigFillCut_db50b4fec5f11499db9039baea8a4392}{
43     \index{RigFillCut@{RigFillCut}!RigFillCut@{RigFillCut}}
44     \index{RigFillCut@{RigFillCut}!RigFillCut@{RigFillCut}}
45     \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{]}}}}
46     \label{classRigFillCut_db50b4fec5f11499db9039baea8a4392}
47    
48    
49     Constructor.
50    
51     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.
52    
53     \begin{Desc}
54     \item[Parameters:]
55     \begin{description}
56     \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}
57     \end{Desc}
58    
59    
60     \subsection{Member Function Documentation}
61     \hypertarget{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}{
62     \index{RigFillCut@{RigFillCut}!Check@{Check}}
63     \index{Check@{Check}!RigFillCut@{RigFillCut}}
64     \subsubsection[{Check}]{\setlength{\rightskip}{0pt plus 5cm}int RigFillCut::Check (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
65     \label{classRigFillCut_5441206a7a24f1f5d19dc1a64685fcd4}
66    
67    
68     The rigidity and cutoff rigidity check.
69    
70     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.
71    
72     \begin{Desc}
73     \item[Parameters:]
74     \begin{description}
75     \item[{\em event}]The event to analyze. \end{description}
76     \end{Desc}
77     \begin{Desc}
78     \item[Returns:]\hyperlink{CommonDefs_8h_c857f4b76ae431837cbf61fd74863b6c}{CUTOK} if both rigidity modulus and threshold rigidity is contained in the histogram limits.
79    
80     0 otherwise. \end{Desc}
81    
82    
83 pam-fi 1.2 Implements \hyperlink{classPamCut_a874600461950d1f2b75ce3938f91cbe}{PamCut}.\hypertarget{classRigFillCut_532f3bb2e39f3c9da3a70e72eae8389d}{
84 pam-fi 1.1 \index{RigFillCut@{RigFillCut}!GetHisto@{GetHisto}}
85     \index{GetHisto@{GetHisto}!RigFillCut@{RigFillCut}}
86     \subsubsection[{GetHisto}]{\setlength{\rightskip}{0pt plus 5cm}{\bf SimpleMatrix}$<$UInt\_\-t$>$\& RigFillCut::GetHisto ()\hspace{0.3cm}{\tt \mbox{[}inline\mbox{]}}}}
87     \label{classRigFillCut_532f3bb2e39f3c9da3a70e72eae8389d}
88    
89    
90     Returns the histogram.
91    
92     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.
93    
94     \begin{Desc}
95     \item[Returns:]The rigidity modulus - threshold rigidity 2D histogram \end{Desc}
96 pam-fi 1.2 \hypertarget{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}{
97 pam-fi 1.1 \index{RigFillCut@{RigFillCut}!OnGood@{OnGood}}
98     \index{OnGood@{OnGood}!RigFillCut@{RigFillCut}}
99     \subsubsection[{OnGood}]{\setlength{\rightskip}{0pt plus 5cm}void RigFillCut::OnGood (PamLevel2 $\ast$ {\em event})\hspace{0.3cm}{\tt \mbox{[}virtual\mbox{]}}}}
100     \label{classRigFillCut_537f1b31f208ebe8f190f254be1fdc6c}
101    
102    
103     The histogram filling.
104    
105     The method fills the histogram with the currently selected event.
106    
107     \begin{Desc}
108     \item[Parameters:]
109     \begin{description}
110     \item[{\em event}]The currently selected event. \end{description}
111     \end{Desc}
112    
113    
114     Reimplemented from \hyperlink{classPamCut_56021e959232270c12528ddec3062985}{PamCut}.
115    
116     The documentation for this class was generated from the following files:\begin{CompactItemize}
117     \item
118     TrkCuts/RigFillCut/\hyperlink{RigFillCut_8h}{RigFillCut.h}\item
119     TrkCuts/RigFillCut/\hyperlink{RigFillCut_8cpp}{RigFillCut.cpp}\end{CompactItemize}

  ViewVC Help
Powered by ViewVC 1.1.23