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