- feed data to mcmSim in pads, write back in channels
[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
ce4786b9 32 void Init(Int_t det, Int_t rob, Int_t mcm, Bool_t newEvent = kFALSE);
33 // Initialize MCM by the position parameters
34
35 void Reset();
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
ce4786b9 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); }
45 // Get filtered ADC data
46
dfd03fc3 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
40bd6ee4 49 void SetData(AliTRDarrayADC *adcArray,
50 AliTRDdigitsManager *digitsManager = 0x0); // Set ADC data from adcArray
ce51199c 51 void SetDataByPad(AliTRDarrayADC *adcArray,
52 AliTRDdigitsManager *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
ce4786b9 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
1d93b218 75
ce4786b9 76 Int_t ProduceRawStream( UInt_t *buf, Int_t bufsize, UInt_t iEv = 0 ) const; // Produce raw data stream - Real data format
1d93b218 77 Int_t ProduceTrackletStream( UInt_t *buf, Int_t bufsize ); // produce the tracklet stream for this MCM
b0a41e80 78
79 // different stages of processing in the TRAP
80 void Filter(); // Apply digital filters for existing data (according to configuration)
ecf39416 81 void ZSMapping(); // Do ZS mapping for existing data
b0a41e80 82 void Tracklet(); // Run tracklet preprocessor and perform tracklet fit
dfd03fc3 83
b0a41e80 84 // apply individual filters to all channels and timebins
85 void FilterPedestal(); // Apply pedestal filter
86 void FilterGain(); // Apply gain filter
87 void FilterTail(); // Apply tail filter
dfd03fc3 88
b0a41e80 89 // filter initialization (resets internal registers)
ce4786b9 90 void FilterPedestalInit(Int_t baseline = 10);
b0a41e80 91 void FilterGainInit();
ce4786b9 92 void FilterTailInit(Int_t baseline = -1);
ecf39416 93
b0a41e80 94 // feed single sample to individual filter
95 // this changes the internal registers
ce4786b9 96 // all filters operate on (10+2)-bit values!
b0a41e80 97 UShort_t FilterPedestalNextSample(Int_t adc, Int_t timebin, UShort_t value);
98 UShort_t FilterGainNextSample(Int_t adc, UShort_t value);
99 UShort_t FilterTailNextSample(Int_t adc, UShort_t value);
1d93b218 100
b0a41e80 101 // tracklet calculation
102 void AddHitToFitreg(Int_t adc, UShort_t timebin, UShort_t qtot, Short_t ypos, Int_t label);
103 void CalcFitreg();
104 void TrackletSelection();
105 void FitTracklet();
1d93b218 106
ce4786b9 107 Int_t GetNHits() const { return fNHits; }
108 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 109 TClonesArray* GetTrackletArray() const { return fTrackletArray; }
dfd03fc3 110
b0a41e80 111 // data display
ab9f7002 112 void Print(Option_t* const option="") const; // print stored data to stdout
113 void Draw(Option_t* const option =""); // draw data (ADC data, hits and tracklets)
ce4786b9 114
115 friend std::ostream& operator<<(std::ostream &os, const AliTRDmcmSim &mcm); // data output using ostream (e.g. cout << mcm;)
59f78ad5 116 static ostream& Cfdat(ostream &os); // manipulator to activate cfdat output
117 static ostream& Raw (ostream &os); // manipulator to activate raw output
118 static ostream& Text (ostream &os); // manipulator to activate text output
dfd03fc3 119
b0a41e80 120 protected:
ce4786b9 121 Bool_t CheckInitialized() const; // Check whether the class is initialized
b0a41e80 122
ce4786b9 123 void SetNTimebins(Int_t ntimebins); // allocate data arrays corr. to the no. of timebins
124
125 static const Int_t fgkFormatIndex; // index for format settings in stream
126
127 static const Int_t fgkNADC; // Number of ADC
128 static const Int_t fgkMaxTracklets = 4; // maximum number of tracklet-words submitted per MCM (one per CPU)
129 static const Int_t fgkAddDigits = 2; // additional digits used for internal representation of ADC data
130 // all internal data as after data control block (i.e. 12 bit), s. TRAP manual
131 static const Int_t fgkNCPU = 4; // Number of CPUs in the TRAP
132 static const Int_t fgkNHitsMC = 100; // maximum number of hits for which MC information is kept
133
134 static const UShort_t fgkFPshifts[4]; // shifts for pedestal filter
135
136
137 Bool_t fInitialized; // memory is allocated if initialized
138 Int_t fDetector; // Chamber ID
b0a41e80 139 Int_t fRobPos; // ROB Position on chamber
140 Int_t fMcmPos; // MCM Position on chamber
141 Int_t fRow; // Pad row number (0-11 or 0-15) of the MCM on chamber
ce4786b9 142 Int_t fNTimeBin; // Number of timebins currently allocated
b0a41e80 143 Int_t **fADCR; // Array with MCM ADC values (Raw, 12 bit)
144 Int_t **fADCF; // Array with MCM ADC values (Filtered, 12 bit)
ce4786b9 145 UInt_t *fMCMT; // tracklet word for one mcm/trap-chip
b0a41e80 146 TClonesArray *fTrackletArray; // Array of AliTRDtrackletMCM which contains MC information in addition to the tracklet word
ce4786b9 147 Int_t *fZSMap; // Zero suppression map (1 dimensional projection)
dfd03fc3 148
b0a41e80 149 Int_t fFitPtr[fgkNCPU]; // pointer to the tracklet to be calculated by CPU i
dfd03fc3 150
b0a41e80 151 // Parameter classes
152 AliTRDfeeParam *fFeeParam; // FEE parameters
153 AliTRDtrapConfig *fTrapConfig; // TRAP config
b0a41e80 154
40bd6ee4 155 AliTRDdigitsManager *fDigitsManager; // pointer to digits manager used for MC label calculation
ce4786b9 156 AliTRDarrayDictionary* fDict[3]; // pointers to label dictionaries
157
40bd6ee4 158
b0a41e80 159 // internal filter registers
160 UInt_t* fPedAcc; // Accumulator for pedestal filter
161 UInt_t* fGainCounterA; // Counter for values above FGTA in the gain filter
162 UInt_t* fGainCounterB; // Counter for values above FGTB in the gain filter
163 UShort_t* fTailAmplLong; // Amplitude of the long component in the tail filter
164 UShort_t* fTailAmplShort; // Amplitude of the short component in the tail filter
165
166 // hit detection
167 // individual hits can be stored as MC info
ab9f7002 168 struct Hit_t { // Array of detected hits (only available in MC)
169 Int_t fChannel; // ADC channel of the hit
170 Int_t fTimebin; // timebin of the hit
171 Int_t fQtot; // total charge of the hit
172 Int_t fYpos; // calculated y-position
173 Int_t fLabel; // label (only in MC)
174 } fHits[fgkNHitsMC];
b0a41e80 175 Int_t fNHits; // Number of detected hits
176
177 // tracklet calculation
ab9f7002 178 struct FitReg_t { // pointer to the 18 fit registers
ce4786b9 179 Int_t fNhits; // number of hits
ab9f7002 180 UInt_t fQ0; // charge accumulated in first window
181 UInt_t fQ1; // charge accumulated in second window
182 UInt_t fSumX; // sum x
ce4786b9 183 Int_t fSumY; // sum y
ab9f7002 184 UInt_t fSumX2; // sum x**2
185 UInt_t fSumY2; // sum y**2
ce4786b9 186 Int_t fSumXY; // sum x*y
ab9f7002 187 } *fFitReg;
b0a41e80 188
ce4786b9 189 // Sort functions as in TRAP
b0a41e80 190 void Sort2(UShort_t idx1i, UShort_t idx2i, UShort_t val1i, UShort_t val2i,
ab9f7002 191 UShort_t *idx1o, UShort_t *idx2o, UShort_t *val1o, UShort_t *val2o) const;
b0a41e80 192 void Sort3(UShort_t idx1i, UShort_t idx2i, UShort_t idx3i,
193 UShort_t val1i, UShort_t val2i, UShort_t val3i,
194 UShort_t *idx1o, UShort_t *idx2o, UShort_t *idx3o,
195 UShort_t *val1o, UShort_t *val2o, UShort_t *val3o);
196 void Sort6To4(UShort_t idx1i, UShort_t idx2i, UShort_t idx3i, UShort_t idx4i, UShort_t idx5i, UShort_t idx6i,
197 UShort_t val1i, UShort_t val2i, UShort_t val3i, UShort_t val4i, UShort_t val5i, UShort_t val6i,
198 UShort_t *idx1o, UShort_t *idx2o, UShort_t *idx3o, UShort_t *idx4o,
199 UShort_t *val1o, UShort_t *val2o, UShort_t *val3o, UShort_t *val4o);
200 void Sort6To2Worst(UShort_t idx1i, UShort_t idx2i, UShort_t idx3i, UShort_t idx4i, UShort_t idx5i, UShort_t idx6i,
201 UShort_t val1i, UShort_t val2i, UShort_t val3i, UShort_t val4i, UShort_t val5i, UShort_t val6i,
202 UShort_t *idx5o, UShort_t *idx6o);
203
ce4786b9 204 UInt_t AddUintClipping(UInt_t a, UInt_t b, UInt_t nbits) const;
205 // Add a and b (unsigned) with clipping to the maximum value representable by nbits
b0a41e80 206
207 private:
208 AliTRDmcmSim(const AliTRDmcmSim &m); // not implemented
209 AliTRDmcmSim &operator=(const AliTRDmcmSim &m); // not implemented
210
36dc3337 211 static Bool_t fgApplyCut; // apply cut on deflection length
4ff7ed2b 212
36dc3337 213 static Int_t fgAddBaseline; // add baseline to the ADC values
4ff7ed2b 214
ce4786b9 215 ClassDef(AliTRDmcmSim,6)
dfd03fc3 216};
217
ce4786b9 218std::ostream& operator<<(std::ostream& os, const AliTRDmcmSim& mcm);
219
dfd03fc3 220#endif