Fix Coverity
[u/mrichter/AliRoot.git] / TRD / AliTRDmcmSim.h
CommitLineData
ab9f7002 1#ifndef ALITRDMCMSIM_H
2#define ALITRDMCMSIM_H
dfd03fc3 3/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * See cxx source for full Copyright notice */
5
6/* $Id$ */
7
8///////////////////////////////////////////////////////
9// //
10// Multi Chip Module Simulation Class //
11// //
12///////////////////////////////////////////////////////
13
ce4786b9 14#include <iostream>
ab9f7002 15
ce4786b9 16class TObject;
ab9f7002 17class TClonesArray;
4ff7ed2b 18class TH2F;
dfd03fc3 19
b0a41e80 20class AliRunLoader;
dfd03fc3 21class AliTRDfeeParam;
b0a41e80 22class AliTRDtrapConfig;
b65e5048 23class AliTRDarrayADC;
ce4786b9 24class AliTRDarrayDictionary;
40bd6ee4 25class AliTRDdigitsManager;
dfd03fc3 26
27class AliTRDmcmSim : public TObject {
dfd03fc3 28 public:
ecf39416 29 AliTRDmcmSim();
30 virtual ~AliTRDmcmSim();
dfd03fc3 31
5f006bd7 32 void Init(Int_t det, Int_t rob, Int_t mcm, Bool_t newEvent = kFALSE);
ce4786b9 33 // Initialize MCM by the position parameters
34
5f006bd7 35 void Reset();
ce4786b9 36 // clears filter registers and internal data
b0a41e80 37
ab9f7002 38 Bool_t LoadMCM(AliRunLoader* const runloader, Int_t det, Int_t rob, Int_t mcm);
ce4786b9 39
b0a41e80 40 void NoiseTest(Int_t nsamples, Int_t mean, Int_t sigma, Int_t inputGain = 1, Int_t inputTail = 2);
dfd03fc3 41
5f006bd7 42 Int_t GetDataRaw(Int_t iadc, Int_t timebin) const { return (fADCR[iadc][timebin] >> 2); }
43 // Get unfiltered ADC data
44 Int_t GetDataFiltered(Int_t iadc, Int_t timebin) const { return (fADCF[iadc][timebin] >> 2); }
ce4786b9 45 // Get filtered ADC data
46
5f006bd7 47 void SetData(Int_t iadc, Int_t *adc); // Set ADC data with array
ce4786b9 48 void SetData(Int_t iadc, Int_t it, Int_t adc); // Set ADC data
5f006bd7 49 void SetData(AliTRDarrayADC * const adcArray,
6b094867 50 AliTRDdigitsManager * const digitsManager = 0x0); // Set ADC data from adcArray
5f006bd7 51 void SetDataByPad(AliTRDarrayADC *const adcArray,
6b094867 52 AliTRDdigitsManager * const digitsManager = 0x0); // Set ADC data from adcArray
ce4786b9 53 void SetDataPedestal(Int_t iadc); // Fill ADC data with pedestal values
dfd03fc3 54
ce4786b9 55 static Bool_t GetApplyCut() { return fgApplyCut; }
56 static void SetApplyCut(Bool_t applyCut) { fgApplyCut = applyCut; }
4ff7ed2b 57
5f006bd7 58 static Int_t GetAddBaseline() { return fgAddBaseline; }
59 static void SetAddBaseline(Int_t baseline) { fgAddBaseline = baseline; }
60 // Additional baseline which is added for the processing
61 // in the TRAP and removed when writing back the data.
62 // This is needed to run with TRAP parameters set for a
63 // different baseline but it will not change the baseline
64 // of the output.
4ff7ed2b 65
b0a41e80 66 Int_t GetDetector() const { return fDetector; }; // Returns Chamber ID (0-539)
ce4786b9 67 Int_t GetRobPos() const { return fRobPos; }; // Returns ROB position (0-7)
68 Int_t GetMcmPos() const { return fMcmPos; }; // Returns MCM position (0-17) (16,17 are mergers)
69 Int_t GetRow() const { return fRow; }; // Returns Row number on chamber where the MCM is sitting
70 Int_t GetCol( Int_t iadc ); // Get corresponding column (0-143) from for ADC channel iadc = [0:20]
ecf39416 71 // for the ADC/Col mapping, see: http://wiki.kip.uni-heidelberg.de/ti/TRD/index.php/Image:ROB_MCM_numbering.pdf
dfd03fc3 72
4ff7ed2b 73 void WriteData(AliTRDarrayADC *digits);
74 Bool_t StoreTracklets(); // Stores tracklets via runloader
6b094867 75 TString GetTrklBranchName() { return fTrklBranchName; }
76 void SetTrklBranchName(TString name) { fTrklBranchName = name; }
1d93b218 77
ce4786b9 78 Int_t ProduceRawStream( UInt_t *buf, Int_t bufsize, UInt_t iEv = 0 ) const; // Produce raw data stream - Real data format
1d93b218 79 Int_t ProduceTrackletStream( UInt_t *buf, Int_t bufsize ); // produce the tracklet stream for this MCM
5f006bd7 80
b0a41e80 81 // different stages of processing in the TRAP
82 void Filter(); // Apply digital filters for existing data (according to configuration)
ecf39416 83 void ZSMapping(); // Do ZS mapping for existing data
b0a41e80 84 void Tracklet(); // Run tracklet preprocessor and perform tracklet fit
dfd03fc3 85
b0a41e80 86 // apply individual filters to all channels and timebins
87 void FilterPedestal(); // Apply pedestal filter
88 void FilterGain(); // Apply gain filter
89 void FilterTail(); // Apply tail filter
dfd03fc3 90
b0a41e80 91 // filter initialization (resets internal registers)
ce4786b9 92 void FilterPedestalInit(Int_t baseline = 10);
b0a41e80 93 void FilterGainInit();
5f006bd7 94 void FilterTailInit(Int_t baseline = -1);
ecf39416 95
b0a41e80 96 // feed single sample to individual filter
97 // this changes the internal registers
ce4786b9 98 // all filters operate on (10+2)-bit values!
b0a41e80 99 UShort_t FilterPedestalNextSample(Int_t adc, Int_t timebin, UShort_t value);
100 UShort_t FilterGainNextSample(Int_t adc, UShort_t value);
101 UShort_t FilterTailNextSample(Int_t adc, UShort_t value);
1d93b218 102
b0a41e80 103 // tracklet calculation
25b41f6f 104 void AddHitToFitreg(Int_t adc, UShort_t timebin, UShort_t qtot, Short_t ypos, Int_t label[]);
b0a41e80 105 void CalcFitreg();
106 void TrackletSelection();
107 void FitTracklet();
1d93b218 108
ce4786b9 109 Int_t GetNHits() const { return fNHits; }
110 Bool_t GetHit(Int_t index, Int_t &channel, Int_t &timebin, Int_t &qtot, Int_t &ypos, Float_t &y, Int_t &label) const;
ab9f7002 111 TClonesArray* GetTrackletArray() const { return fTrackletArray; }
dfd03fc3 112
b0a41e80 113 // data display
ab9f7002 114 void Print(Option_t* const option="") const; // print stored data to stdout
115 void Draw(Option_t* const option =""); // draw data (ADC data, hits and tracklets)
ce4786b9 116
117 friend std::ostream& operator<<(std::ostream &os, const AliTRDmcmSim &mcm); // data output using ostream (e.g. cout << mcm;)
59f78ad5 118 static ostream& Cfdat(ostream &os); // manipulator to activate cfdat output
119 static ostream& Raw (ostream &os); // manipulator to activate raw output
120 static ostream& Text (ostream &os); // manipulator to activate text output
dfd03fc3 121
8ea391e3 122 // PID
123 Int_t GetPID(Int_t q0, Int_t q1);
124 void PrintPidLutHuman();
8ea391e3 125
126 // I/O
127 void PrintFitRegXml(ostream& os) const;
128 void PrintTrackletsXml(ostream& os) const;
129 void PrintAdcDatHuman(ostream& os) const;
130 void PrintAdcDatXml(ostream& os) const;
a10c6981 131 void PrintAdcDatDatx(ostream& os, Bool_t broadcast=kFALSE, Int_t timeBinOffset = -1) const;
8ea391e3 132
b0a41e80 133 protected:
ce4786b9 134 Bool_t CheckInitialized() const; // Check whether the class is initialized
5f006bd7 135
ce4786b9 136 void SetNTimebins(Int_t ntimebins); // allocate data arrays corr. to the no. of timebins
137
138 static const Int_t fgkFormatIndex; // index for format settings in stream
139
5f006bd7 140 static const Int_t fgkNADC; // Number of ADC
ce4786b9 141 static const Int_t fgkMaxTracklets = 4; // maximum number of tracklet-words submitted per MCM (one per CPU)
142 static const Int_t fgkAddDigits = 2; // additional digits used for internal representation of ADC data
143 // all internal data as after data control block (i.e. 12 bit), s. TRAP manual
144 static const Int_t fgkNCPU = 4; // Number of CPUs in the TRAP
145 static const Int_t fgkNHitsMC = 100; // maximum number of hits for which MC information is kept
146
147 static const UShort_t fgkFPshifts[4]; // shifts for pedestal filter
148
149
150 Bool_t fInitialized; // memory is allocated if initialized
151 Int_t fDetector; // Chamber ID
5f006bd7 152 Int_t fRobPos; // ROB Position on chamber
153 Int_t fMcmPos; // MCM Position on chamber
b0a41e80 154 Int_t fRow; // Pad row number (0-11 or 0-15) of the MCM on chamber
ce4786b9 155 Int_t fNTimeBin; // Number of timebins currently allocated
b0a41e80 156 Int_t **fADCR; // Array with MCM ADC values (Raw, 12 bit)
157 Int_t **fADCF; // Array with MCM ADC values (Filtered, 12 bit)
5f006bd7 158 UInt_t *fMCMT; // tracklet word for one mcm/trap-chip
b0a41e80 159 TClonesArray *fTrackletArray; // Array of AliTRDtrackletMCM which contains MC information in addition to the tracklet word
ce4786b9 160 Int_t *fZSMap; // Zero suppression map (1 dimensional projection)
dfd03fc3 161
b0a41e80 162 Int_t fFitPtr[fgkNCPU]; // pointer to the tracklet to be calculated by CPU i
dfd03fc3 163
6b094867 164 TString fTrklBranchName; // name of the tracklet branch to right to
165
b0a41e80 166 // Parameter classes
167 AliTRDfeeParam *fFeeParam; // FEE parameters
168 AliTRDtrapConfig *fTrapConfig; // TRAP config
b0a41e80 169
40bd6ee4 170 AliTRDdigitsManager *fDigitsManager; // pointer to digits manager used for MC label calculation
ce4786b9 171 AliTRDarrayDictionary* fDict[3]; // pointers to label dictionaries
172
40bd6ee4 173
b0a41e80 174 // internal filter registers
175 UInt_t* fPedAcc; // Accumulator for pedestal filter
176 UInt_t* fGainCounterA; // Counter for values above FGTA in the gain filter
177 UInt_t* fGainCounterB; // Counter for values above FGTB in the gain filter
178 UShort_t* fTailAmplLong; // Amplitude of the long component in the tail filter
179 UShort_t* fTailAmplShort; // Amplitude of the short component in the tail filter
180
181 // hit detection
182 // individual hits can be stored as MC info
ab9f7002 183 struct Hit_t { // Array of detected hits (only available in MC)
54d34aac 184 Hit_t() : fChannel(0), fTimebin(0), fQtot(0), fYpos(0) { fLabel[0] = 0; fLabel[1] = 0; fLabel[2] = 0; }
ab9f7002 185 Int_t fChannel; // ADC channel of the hit
186 Int_t fTimebin; // timebin of the hit
187 Int_t fQtot; // total charge of the hit
188 Int_t fYpos; // calculated y-position
25b41f6f 189 Int_t fLabel[3]; // up to 3 labels (only in MC)
ab9f7002 190 } fHits[fgkNHitsMC];
b0a41e80 191 Int_t fNHits; // Number of detected hits
192
193 // tracklet calculation
5f006bd7 194 struct FitReg_t { // pointer to the 18 fit registers
ce4786b9 195 Int_t fNhits; // number of hits
ab9f7002 196 UInt_t fQ0; // charge accumulated in first window
197 UInt_t fQ1; // charge accumulated in second window
198 UInt_t fSumX; // sum x
5f006bd7 199 Int_t fSumY; // sum y
ab9f7002 200 UInt_t fSumX2; // sum x**2
201 UInt_t fSumY2; // sum y**2
ce4786b9 202 Int_t fSumXY; // sum x*y
ab9f7002 203 } *fFitReg;
b0a41e80 204
ce4786b9 205 // Sort functions as in TRAP
5f006bd7 206 void Sort2(UShort_t idx1i, UShort_t idx2i, UShort_t val1i, UShort_t val2i,
6b094867 207 UShort_t * const idx1o, UShort_t * const idx2o, UShort_t * const val1o, UShort_t * const val2o) const;
5f006bd7 208 void Sort3(UShort_t idx1i, UShort_t idx2i, UShort_t idx3i,
209 UShort_t val1i, UShort_t val2i, UShort_t val3i,
210 UShort_t * const idx1o, UShort_t * const idx2o, UShort_t * const idx3o,
6b094867 211 UShort_t * const val1o, UShort_t * const val2o, UShort_t * const val3o);
5f006bd7 212 void Sort6To4(UShort_t idx1i, UShort_t idx2i, UShort_t idx3i, UShort_t idx4i, UShort_t idx5i, UShort_t idx6i,
213 UShort_t val1i, UShort_t val2i, UShort_t val3i, UShort_t val4i, UShort_t val5i, UShort_t val6i,
214 UShort_t * const idx1o, UShort_t * const idx2o, UShort_t * const idx3o, UShort_t * const idx4o,
6b094867 215 UShort_t * const val1o, UShort_t * const val2o, UShort_t * const val3o, UShort_t * const val4o);
5f006bd7 216 void Sort6To2Worst(UShort_t idx1i, UShort_t idx2i, UShort_t idx3i, UShort_t idx4i, UShort_t idx5i, UShort_t idx6i,
217 UShort_t val1i, UShort_t val2i, UShort_t val3i, UShort_t val4i, UShort_t val5i, UShort_t val6i,
6b094867 218 UShort_t * const idx5o, UShort_t * const idx6o);
b0a41e80 219
5f006bd7 220 UInt_t AddUintClipping(UInt_t a, UInt_t b, UInt_t nbits) const;
ce4786b9 221 // Add a and b (unsigned) with clipping to the maximum value representable by nbits
b0a41e80 222
223 private:
224 AliTRDmcmSim(const AliTRDmcmSim &m); // not implemented
225 AliTRDmcmSim &operator=(const AliTRDmcmSim &m); // not implemented
226
36dc3337 227 static Bool_t fgApplyCut; // apply cut on deflection length
4ff7ed2b 228
5f006bd7 229 static Int_t fgAddBaseline; // add baseline to the ADC values
4ff7ed2b 230
ce4786b9 231 ClassDef(AliTRDmcmSim,6)
dfd03fc3 232};
233
ce4786b9 234std::ostream& operator<<(std::ostream& os, const AliTRDmcmSim& mcm);
235
dfd03fc3 236#endif