HLT/PHOS/latex/classAliPHOSPulseGenerator.tex

   1 \section{Ali\-PHOSPulse\-Generator Class Reference}
   2 \label{classAliPHOSPulseGenerator}\index{AliPHOSPulseGenerator@{AliPHOSPulseGenerator}}
   3 {\tt \#include $<$Ali\-PHOSPulse\-Generator.h$>$}
   4
   5 \subsection*{Public Member Functions}
   6 \begin{CompactItemize}
   7 \item
   8 {\bf Ali\-PHOSPulse\-Generator} ()
   9 \item
  10 {\bf $\sim$Ali\-PHOSPulse\-Generator} ()
  11 \item
  12 {\bf Ali\-PHOSPulse\-Generator} (double a, double t0, const int N, const double t, const double f)
  13 \item
  14 void {\bf Add\-Baseline} (double baseline\-Level, double $\ast$samples)
  15 \item
  16 double $\ast$ {\bf Add\-Pretrigger\-Samples} (double basline\-Level, double $\ast$samples)
  17 \item
  18 void {\bf Add\-Noise} (double $\ast$data\-Ptr, double $\ast$sigma)
  19 \item
  20 void {\bf Add\-Noise} (double $\ast$data\-Ptr, double $\ast$sigma, double cutoff)
  21 \item
  22 double $\ast$ {\bf Get\-Pulse} ()
  23 \item
  24 double $\ast$ {\bf Get\-Pulse} (double a, double t0)
  25 \item
  26 void {\bf Quantisize} (double $\ast$data\-Ptr)
  27 \item
  28 void {\bf Set\-Amplitude} (double a)
  29 \item
  30 void {\bf Set\-DT} (double fs)
  31 \item
  32 void {\bf Set\-TZero} (double t0)
  33 \end{CompactItemize}
  34 \subsection*{Private Member Functions}
  35 \begin{CompactItemize}
  36 \item
  37 void {\bf Make\-Pulse} (double $\ast$dta\-Ptr)
  38 \item
  39 void {\bf Make\-Pulse} (double $\ast$dta\-Ptr, double ampl)
  40 \end{CompactItemize}
  41 \subsection*{Private Attributes}
  42 \begin{CompactItemize}
  43 \item
  44 double {\bf f\-Amplitude}
  45 \item
  46 int {\bf f\-NSamples}
  47 \item
  48 double {\bf f\-Tau}
  49 \item
  50 double {\bf f\-Sample\-Freq}
  51 \item
  52 double {\bf f\-TZero}
  53 \item
  54 double $\ast$ {\bf f\-Data\-Ptr}
  55 \item
  56 double {\bf f\-DT}
  57 \item
  58 double $\ast$ {\bf f\-Event}
  59 \end{CompactItemize}
  60
  61
  62 \subsection{Constructor \& Destructor Documentation}
  63 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!AliPHOSPulseGenerator@{AliPHOSPulseGenerator}}
  64 \index{AliPHOSPulseGenerator@{AliPHOSPulseGenerator}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
  65 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}Ali\-PHOSPulse\-Generator::Ali\-PHOSPulse\-Generator ()}\label{classAliPHOSPulseGenerator_a0}
  66
  67
  68 Default constructor \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!~AliPHOSPulseGenerator@{$\sim$AliPHOSPulseGenerator}}
  69 \index{~AliPHOSPulseGenerator@{$\sim$AliPHOSPulseGenerator}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
  70 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}Ali\-PHOSPulse\-Generator::$\sim${\bf Ali\-PHOSPulse\-Generator} ()}\label{classAliPHOSPulseGenerator_a1}
  71
  72
  73 Destructor \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!AliPHOSPulseGenerator@{AliPHOSPulseGenerator}}
  74 \index{AliPHOSPulseGenerator@{AliPHOSPulseGenerator}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
  75 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}Ali\-PHOSPulse\-Generator::Ali\-PHOSPulse\-Generator (double {\em a}, double {\em t0}, const int {\em N}, const double {\em t}, const double {\em f})}\label{classAliPHOSPulseGenerator_a2}
  76
  77
  78 Contruct a pulsegenrator object an initializes all necessary parameters \begin{Desc}
  79 \item[Parameters:]
  80 \begin{description}
  81 \item[{\em a}]Amplitude in ADC levels (0 -1023) \item[{\em t0}]Timedelay in nanoseconds of signal relative the first sample. This value should be between 0 and Ts where Ts is the sample interval \end{description}
  82 \end{Desc}
  83
  84
  85 \subsection{Member Function Documentation}
  86 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!AddBaseline@{AddBaseline}}
  87 \index{AddBaseline@{AddBaseline}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
  88 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Add\-Baseline (double {\em baseline\-Level}, double $\ast$ {\em samples})}\label{classAliPHOSPulseGenerator_a3}
  89
  90
  91 Adds a baseline offset to the signal \begin{Desc}
  92 \item[Parameters:]
  93 \begin{description}
  94 \item[{\em baseline\-Level}]The basline level to add \item[{\em $\ast$samples}]The sample array for which to add te basline offset \end{description}
  95 \end{Desc}
  96 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!AddNoise@{AddNoise}}
  97 \index{AddNoise@{AddNoise}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
  98 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Add\-Noise (double $\ast$ {\em data\-Ptr}, double $\ast$ {\em sigma}, double {\em cutoff})}\label{classAliPHOSPulseGenerator_a6}
  99
 100
 101 Adds correlated Gaussian noise with cutof frequency \char`\"{}cutoff\char`\"{} \begin{Desc}
 102 \item[Parameters:]
 103 \begin{description}
 104 \item[{\em data\-Ptr}]array of values \item[{\em sigma}]noise amplitude in entities of ADC levels \item[{\em -30DB}]cutoff frequency of the noise in entities of sampling frequency \end{description}
 105 \end{Desc}
 106 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!AddNoise@{AddNoise}}
 107 \index{AddNoise@{AddNoise}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 108 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Add\-Noise (double $\ast$ {\em data\-Ptr}, double $\ast$ {\em sigma})}\label{classAliPHOSPulseGenerator_a5}
 109
 110
 111 Adds Gaussian white noise to the sample array given by $\ast$data\-Ptr. \begin{Desc}
 112 \item[Parameters:]
 113 \begin{description}
 114 \item[{\em data\-Ptr}]array of samples \item[{\em sigma}]the noise amplitude in entities of ADC levels \end{description}
 115 \end{Desc}
 116 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!AddPretriggerSamples@{AddPretriggerSamples}}
 117 \index{AddPretriggerSamples@{AddPretriggerSamples}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 118 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double $\ast$ Ali\-PHOSPulse\-Generator::Add\-Pretrigger\-Samples (double {\em basline\-Level}, double $\ast$ {\em samples})}\label{classAliPHOSPulseGenerator_a4}
 119
 120
 121 Adds pretrigger samples to the sample array and returns a new array containing the pretrigger samples concatenatet in front of the samples given by \char`\"{}samples\char`\"{} \begin{Desc}
 122 \item[Parameters:]
 123 \begin{description}
 124 \item[{\em The}]baseline value of the pretrigger samples \item[{\em The}]sample array for which to add the pretrigger samples \end{description}
 125 \end{Desc}
 126 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!GetPulse@{GetPulse}}
 127 \index{GetPulse@{GetPulse}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 128 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ Ali\-PHOSPulse\-Generator::Get\-Pulse (double {\em a}, double {\em t0})}\label{classAliPHOSPulseGenerator_a8}
 129
 130
 131 Returns a Pulse with new amplidude and t0 \begin{Desc}
 132 \item[Parameters:]
 133 \begin{description}
 134 \item[{\em a}]new amplidude, overriding the one given in the constructor \end{description}
 135 \end{Desc}
 136 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!GetPulse@{GetPulse}}
 137 \index{GetPulse@{GetPulse}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 138 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double $\ast$ Ali\-PHOSPulse\-Generator::Get\-Pulse ()}\label{classAliPHOSPulseGenerator_a7}
 139
 140
 141 Returns the generated pulse with the parameters given in the constructor \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!MakePulse@{MakePulse}}
 142 \index{MakePulse@{MakePulse}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 143 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Make\-Pulse (double $\ast$ {\em dta\-Ptr}, double {\em ampl})\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_d1}
 144
 145
 146 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!MakePulse@{MakePulse}}
 147 \index{MakePulse@{MakePulse}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 148 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Make\-Pulse (double $\ast$ {\em dta\-Ptr})\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_d0}
 149
 150
 151 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!Quantisize@{Quantisize}}
 152 \index{Quantisize@{Quantisize}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 153 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Quantisize (double $\ast$ {\em data\-Ptr})}\label{classAliPHOSPulseGenerator_a9}
 154
 155
 156 Emulates the ADC. Rounds down to nearest Integerevalue all entries given by data\-Ptr \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!SetAmplitude@{SetAmplitude}}
 157 \index{SetAmplitude@{SetAmplitude}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 158 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Set\-Amplitude (double {\em a})}\label{classAliPHOSPulseGenerator_a10}
 159
 160
 161 sets the timedelay. Take as argument the timedelay in nanoseconds and sets in i entities of sample intervals \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!SetDT@{SetDT}}
 162 \index{SetDT@{SetDT}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 163 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Set\-DT (double {\em fs})}\label{classAliPHOSPulseGenerator_a11}
 164
 165
 166 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!SetTZero@{SetTZero}}
 167 \index{SetTZero@{SetTZero}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 168 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}void Ali\-PHOSPulse\-Generator::Set\-TZero (double {\em t0})}\label{classAliPHOSPulseGenerator_a12}
 169
 170
 171
 172
 173 \subsection{Member Data Documentation}
 174 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fAmplitude@{fAmplitude}}
 175 \index{fAmplitude@{fAmplitude}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 176 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double {\bf Ali\-PHOSPulse\-Generator::f\-Amplitude}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r0}
 177
 178
 179 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fDataPtr@{fDataPtr}}
 180 \index{fDataPtr@{fDataPtr}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 181 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ {\bf Ali\-PHOSPulse\-Generator::f\-Data\-Ptr}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r5}
 182
 183
 184 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fDT@{fDT}}
 185 \index{fDT@{fDT}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 186 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double {\bf Ali\-PHOSPulse\-Generator::f\-DT}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r6}
 187
 188
 189 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fEvent@{fEvent}}
 190 \index{fEvent@{fEvent}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 191 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double$\ast$ {\bf Ali\-PHOSPulse\-Generator::f\-Event}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r7}
 192
 193
 194 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fNSamples@{fNSamples}}
 195 \index{fNSamples@{fNSamples}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 196 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}int {\bf Ali\-PHOSPulse\-Generator::f\-NSamples}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r1}
 197
 198
 199 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fSampleFreq@{fSampleFreq}}
 200 \index{fSampleFreq@{fSampleFreq}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 201 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double {\bf Ali\-PHOSPulse\-Generator::f\-Sample\-Freq}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r3}
 202
 203
 204 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fTau@{fTau}}
 205 \index{fTau@{fTau}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 206 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double {\bf Ali\-PHOSPulse\-Generator::f\-Tau}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r2}
 207
 208
 209 \index{AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}!fTZero@{fTZero}}
 210 \index{fTZero@{fTZero}!AliPHOSPulseGenerator@{Ali\-PHOSPulse\-Generator}}
 211 \subsubsection{\setlength{\rightskip}{0pt plus 5cm}double {\bf Ali\-PHOSPulse\-Generator::f\-TZero}\hspace{0.3cm}{\tt  [private]}}\label{classAliPHOSPulseGenerator_r4}
 212
 213
 214
 215
 216 The documentation for this class was generated from the following files:\begin{CompactItemize}
 217 \item
 218 {\bf Ali\-PHOSPulse\-Generator.h}\item
 219 {\bf Ali\-PHOSPulse\-Generator.cxx}\end{CompactItemize}