349148f6cbb5c137ef323f2d48b6a86f63cdc58d
[u/mrichter/AliRoot.git] / EMCAL / AliEMCALRawUtils.cxx
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17 /* History of cvs commits:
18  *
19  * $Log$
20  * Revision 1.10  2007/12/06 13:58:11  hristov
21  * Additional pritection. Do not delete the mapping, it is owned by another class
22  *
23  * Revision 1.9  2007/12/06 02:19:51  jklay
24  * incorporated fitting procedure from testbeam analysis into AliRoot
25  *
26  * Revision 1.8  2007/12/05 02:30:51  jklay
27  * modification to read Altro mappings into AliEMCALRecParam and pass to AliEMCALRawUtils from AliEMCALReconstructor; add option to AliEMCALRawUtils to set old RCU format (for testbeam) or not
28  *
29  * Revision 1.7  2007/11/14 15:51:46  gustavo
30  * Take out few unnecessary prints
31  *
32  * Revision 1.6  2007/11/01 01:23:51  mvl
33  * Removed call to SetOldRCUFormat, which is only needed for testbeam data
34  *
35  * Revision 1.5  2007/11/01 01:20:33  mvl
36  * Further improvement of peak finding; more robust fit
37  *
38  * Revision 1.4  2007/10/31 17:15:24  mvl
39  * Fixed bug in raw data unpacking; Added pedestal to signal fit; Added logic to deal with high/low gain
40  *
41  * Revision 1.3  2007/09/27 08:36:46  mvl
42  * More robust setting of fit range in FitRawSignal (P. Hristov)
43  *
44  * Revision 1.2  2007/09/03 20:55:35  jklay
45  * EMCAL e-by-e reconstruction methods from Cvetan
46  *
47  * Revision 1.1  2007/03/17 19:56:38  mvl
48  * Moved signal shape routines from AliEMCAL to separate class AliEMCALRawUtils to streamline raw data reconstruction code.
49  * */
50
51 //*-- Author: Marco van Leeuwen (LBL)
52 #include "AliEMCALRawUtils.h"
53
54 #include "TF1.h"
55 #include "TGraph.h"
56 #include "TSystem.h"
57
58 #include "AliLog.h"
59 #include "AliRun.h"
60 #include "AliRunLoader.h"
61 #include "AliCaloAltroMapping.h"
62 #include "AliAltroBuffer.h"
63 #include "AliRawReader.h"
64 #include "AliCaloRawStream.h"
65 #include "AliDAQ.h"
66
67 #include "AliEMCALRecParam.h"
68 #include "AliEMCALLoader.h"
69 #include "AliEMCALGeometry.h"
70 #include "AliEMCALDigitizer.h"
71 #include "AliEMCALDigit.h"
72
73
74 ClassImp(AliEMCALRawUtils)
75
76 // Signal shape parameters
77 Double_t AliEMCALRawUtils::fgTimeBinWidth  = 100E-9 ; // each sample is 100 ns
78 Double_t AliEMCALRawUtils::fgTimeTrigger = 1.5E-6 ;   // 15 time bins ~ 1.5 musec
79
80 // some digitization constants
81 Int_t    AliEMCALRawUtils::fgThreshold = 1;
82 Int_t    AliEMCALRawUtils::fgDDLPerSuperModule = 2;  // 2 ddls per SuperModule
83
84 AliEMCALRawUtils::AliEMCALRawUtils()
85   : fHighLowGainFactor(0.), fOrder(0), fTau(0.), fNoiseThreshold(0),
86     fNPedSamples(0), fGeom(0), fOption("")
87 {
88
89   //These are default parameters.  
90   //Can be re-set from without with setter functions
91   fHighLowGainFactor = 16. ;          // adjusted for a low gain range of 82 GeV (10 bits) 
92   fOrder = 2;                         // order of gamma fn
93   fTau = 2.35;                        // in units of timebin, from CERN 2007 testbeam
94   fNoiseThreshold = 3;
95   fNPedSamples = 5;
96
97   //Get Mapping RCU files from the AliEMCALRecParam                                 
98   const TObjArray* maps = AliEMCALRecParam::GetMappings();
99   if(!maps) AliFatal("Cannot retrieve ALTRO mappings!!");
100
101   for(Int_t i = 0; i < 2; i++) {
102     fMapping[i] = (AliAltroMapping*)maps->At(i);
103   }
104
105   //To make sure we match with the geometry in a simulation file,
106   //let's try to get it first.  If not, take the default geometry
107   AliRunLoader *rl = AliRunLoader::GetRunLoader();
108   if (rl->GetAliRun() && rl->GetAliRun()->GetDetector("EMCAL")) {
109     fGeom = dynamic_cast<AliEMCAL*>(rl->GetAliRun()->GetDetector("EMCAL"))->GetGeometry();
110   } else {
111     AliInfo(Form("Using default geometry in raw reco"));
112     fGeom =  AliEMCALGeometry::GetInstance(AliEMCALGeometry::GetDefaultGeometryName());
113   }
114
115   if(!fGeom) AliFatal(Form("Could not get geometry!"));
116
117 }
118
119 //____________________________________________________________________________
120 AliEMCALRawUtils::AliEMCALRawUtils(const AliEMCALRawUtils& rawU)
121   : TObject(),
122     fHighLowGainFactor(rawU.fHighLowGainFactor), 
123     fOrder(rawU.fOrder),
124     fTau(rawU.fTau),
125     fNoiseThreshold(rawU.fNoiseThreshold),
126     fNPedSamples(rawU.fNPedSamples),
127     fGeom(rawU.fGeom), 
128     fOption(rawU.fOption)
129 {
130   //copy ctor
131   fMapping[0] = rawU.fMapping[0];
132   fMapping[1] = rawU.fMapping[1];
133 }
134
135 //____________________________________________________________________________
136 AliEMCALRawUtils& AliEMCALRawUtils::operator =(const AliEMCALRawUtils &rawU)
137 {
138   //assignment operator
139
140   if(this != &rawU) {
141     fHighLowGainFactor = rawU.fHighLowGainFactor;
142     fOrder = rawU.fOrder;
143     fTau = rawU.fTau;
144     fNoiseThreshold = rawU.fNoiseThreshold;
145     fNPedSamples = rawU.fNPedSamples;
146     fGeom = rawU.fGeom;
147     fOption = rawU.fOption;
148     fMapping[0] = rawU.fMapping[0];
149     fMapping[1] = rawU.fMapping[1];
150   }
151
152   return *this;
153
154 }
155
156 //____________________________________________________________________________
157 AliEMCALRawUtils::~AliEMCALRawUtils() {
158
159 }
160
161 //____________________________________________________________________________
162 void AliEMCALRawUtils::Digits2Raw()
163 {
164   // convert digits of the current event to raw data
165   
166   AliRunLoader *rl = AliRunLoader::GetRunLoader();
167   AliEMCALLoader *loader = dynamic_cast<AliEMCALLoader*>(rl->GetDetectorLoader("EMCAL"));
168
169   // get the digits
170   loader->LoadDigits("EMCAL");
171   loader->GetEvent();
172   TClonesArray* digits = loader->Digits() ;
173   
174   if (!digits) {
175     Warning("Digits2Raw", "no digits found !");
176     return;
177   }
178
179   static const Int_t nDDL = 12*2; // 12 SM hardcoded for now. Buffers allocated dynamically, when needed, so just need an upper limit here
180   AliAltroBuffer* buffers[nDDL];
181   for (Int_t i=0; i < nDDL; i++)
182     buffers[i] = 0;
183
184   Int_t adcValuesLow[fgkTimeBins];
185   Int_t adcValuesHigh[fgkTimeBins];
186
187   // loop over digits (assume ordered digits)
188   for (Int_t iDigit = 0; iDigit < digits->GetEntries(); iDigit++) {
189     AliEMCALDigit* digit = dynamic_cast<AliEMCALDigit *>(digits->At(iDigit)) ;
190     if (digit->GetAmp() < fgThreshold) 
191       continue;
192
193     //get cell indices
194     Int_t nSM = 0;
195     Int_t nIphi = 0;
196     Int_t nIeta = 0;
197     Int_t iphi = 0;
198     Int_t ieta = 0;
199     Int_t nModule = 0;
200     fGeom->GetCellIndex(digit->GetId(), nSM, nModule, nIphi, nIeta);
201     fGeom->GetCellPhiEtaIndexInSModule(nSM, nModule, nIphi, nIeta,iphi, ieta) ;
202     
203     //Check which is the RCU of the cell.
204     Int_t iRCU = -111;
205     //RCU0
206     if (0<=iphi&&iphi<8) iRCU=0; // first cable row
207     else if (8<=iphi&&iphi<16 && 0<=ieta&&ieta<24) iRCU=0; // first half; 
208     //second cable row
209     //RCU1
210     else if(8<=iphi&&iphi<16 && 24<=ieta&&ieta<48) iRCU=1; // second half; 
211     //second cable row
212     else if(16<=iphi&&iphi<24) iRCU=1; // third cable row
213     if (iRCU<0) 
214       Fatal("Digits2Raw()","Non-existent RCU number: %d", iRCU);
215     
216     //Which DDL?
217     Int_t iDDL = fgDDLPerSuperModule* nSM + iRCU;
218     if (iDDL >= nDDL)
219       Fatal("Digits2Raw()","Non-existent DDL board number: %d", iDDL);
220
221     if (buffers[iDDL] == 0) {      
222       // open new file and write dummy header
223       TString fileName = AliDAQ::DdlFileName("EMCAL",iDDL);
224       buffers[iDDL] = new AliAltroBuffer(fileName.Data(),fMapping[iRCU]);
225       buffers[iDDL]->WriteDataHeader(kTRUE, kFALSE);  //Dummy;
226     }
227     
228     // out of time range signal (?)
229     if (digit->GetTimeR() > GetRawFormatTimeMax() ) {
230       AliInfo("Signal is out of time range.\n");
231       buffers[iDDL]->FillBuffer((Int_t)digit->GetAmp());
232       buffers[iDDL]->FillBuffer(GetRawFormatTimeBins() );  // time bin
233       buffers[iDDL]->FillBuffer(3);          // bunch length      
234       buffers[iDDL]->WriteTrailer(3, ieta, iphi, nSM);  // trailer
235       // calculate the time response function
236     } else {
237       Bool_t lowgain = RawSampledResponse(digit->GetTimeR(), digit->GetAmp(), adcValuesHigh, adcValuesLow) ; 
238       if (lowgain) 
239         buffers[iDDL]->WriteChannel(ieta, iphi, 0, GetRawFormatTimeBins(), adcValuesLow, fgThreshold);
240       else 
241         buffers[iDDL]->WriteChannel(ieta,iphi, 1, GetRawFormatTimeBins(), adcValuesHigh, fgThreshold);
242     }
243   }
244   
245   // write headers and close files
246   for (Int_t i=0; i < nDDL; i++) {
247     if (buffers[i]) {
248       buffers[i]->Flush();
249       buffers[i]->WriteDataHeader(kFALSE, kFALSE);
250       delete buffers[i];
251     }
252   }
253
254   loader->UnloadDigits();
255 }
256
257 //____________________________________________________________________________
258 void AliEMCALRawUtils::Raw2Digits(AliRawReader* reader,TClonesArray *digitsArr)
259 {
260   // convert raw data of the current event to digits                                                                                     
261
262   digitsArr->Clear(); 
263
264   if (!digitsArr) {
265     Error("Raw2Digits", "no digits found !");
266     return;
267   }
268   if (!reader) {
269     Error("Raw2Digits", "no raw reader found !");
270     return;
271   }
272
273   AliCaloRawStream in(reader,"EMCAL",fMapping);
274   // Select EMCAL DDL's;
275   reader->Select("EMCAL");
276
277   TString option = GetOption();
278   if (option.Contains("OldRCUFormat"))
279     in.SetOldRCUFormat(kTRUE); // Needed for testbeam data
280   else
281     in.SetOldRCUFormat(kFALSE);
282
283
284   //Updated fitting routine from 2007 beam test takes into account
285   //possibility of two peaks in data and selects first one for fitting
286   //Also sets some of the starting parameters based on the shape of the
287   //given raw signal being fit
288
289   TF1 * signalF = new TF1("signal", RawResponseFunction, 0, GetRawFormatTimeBins(), 5);
290   signalF->SetParameters(10.,0.,fTau,fOrder,5.); //set all defaults once, just to be safe
291   signalF->SetParNames("amp","t0","tau","N","ped");
292   signalF->SetParameter(2,fTau); // tau in units of time bin
293   signalF->SetParLimits(2,2,-1);
294   signalF->SetParameter(3,fOrder); // order
295   signalF->SetParLimits(3,2,-1);
296   
297   Int_t id =  -1;
298   Float_t time = 0. ; 
299   Float_t amp = 0. ; 
300
301   //Graph to hold data we will fit (should be converted to an array
302   //later to speed up processing
303   TGraph * gSig = new TGraph(GetRawFormatTimeBins()); 
304
305   Int_t readOk = 1;
306   Int_t lowGain = 0;
307
308   while (readOk && in.GetModule() < 0) 
309     readOk = in.Next();  // Go to first digit
310
311   Int_t col = 0;
312   Int_t row = 0;
313
314   while (readOk) { 
315     id =  fGeom->GetAbsCellIdFromCellIndexes(in.GetModule(), in.GetRow(), in.GetColumn()) ;
316     lowGain = in.IsLowGain();
317     Int_t maxTime = in.GetTime();  // timebins come in reverse order
318     if (maxTime < 0 || maxTime >= GetRawFormatTimeBins()) {
319       AliWarning(Form("Invalid time bin %d",maxTime));
320       maxTime = GetRawFormatTimeBins();
321     }
322     gSig->Set(maxTime+1);
323     // There is some kind of zero-suppression in the raw data, 
324     // so set up the TGraph in advance
325     for (Int_t i=0; i < maxTime; i++) {
326       gSig->SetPoint(i, i , 0);
327     }
328
329     Int_t iTime = 0;
330     do {
331       if (in.GetTime() >= gSig->GetN()) {
332           AliWarning("Too many time bins");
333           gSig->Set(in.GetTime());
334       }
335       col = in.GetColumn();
336       row = in.GetRow();
337       
338       gSig->SetPoint(in.GetTime(), in.GetTime(), in.GetSignal()) ;
339       if (in.GetTime() > maxTime)
340         maxTime = in.GetTime();
341       iTime++;
342     } while ((readOk = in.Next()) && !in.IsNewHWAddress());
343
344     FitRaw(gSig, signalF, amp, time) ; 
345     
346     if (amp > 0) {
347       AliDebug(2,Form("id %d lowGain %d amp %g", id, lowGain, amp));
348       //cout << "col " << col-40 << " row " << row-8 << " lowGain " << lowGain << " amp " << amp << endl;
349       AddDigit(digitsArr, id, lowGain, (Int_t)amp, time);
350     }
351         
352     // Reset graph
353     for (Int_t index = 0; index < gSig->GetN(); index++) {
354       gSig->SetPoint(index, index, 0) ;  
355     } 
356     // Reset starting parameters for fit function
357     signalF->SetParameters(10.,0.,fTau,fOrder,5.); //reset all defaults just to be safe
358
359   }; // EMCAL entries loop
360   
361   delete signalF ; 
362   delete gSig;
363   
364   return ; 
365 }
366
367 //____________________________________________________________________________ 
368 void AliEMCALRawUtils::AddDigit(TClonesArray *digitsArr, Int_t id, Int_t lowGain, Int_t amp, Float_t time) {
369   //
370   // Add a new digit. 
371   // This routine checks whether a digit exists already for this tower 
372   // and then decides whether to use the high or low gain info
373   //
374   // Called by Raw2Digits
375   
376   AliEMCALDigit *digit = 0, *tmpdigit = 0;
377   
378   TIter nextdigit(digitsArr);
379   while (digit == 0 && (tmpdigit = (AliEMCALDigit*) nextdigit())) {
380     if (tmpdigit->GetId() == id)
381       digit = tmpdigit;
382   }
383
384   if (!digit) { // no digit existed for this tower; create one
385     if (lowGain) 
386       amp = Int_t(fHighLowGainFactor * amp); 
387     Int_t idigit = digitsArr->GetEntries();
388     new((*digitsArr)[idigit]) AliEMCALDigit( -1, -1, id, amp, time, idigit) ;   
389   }
390   else { // a digit already exists, check range 
391          // (use high gain if signal < cut value, otherwise low gain)
392     if (lowGain) { // new digit is low gain
393       if (digit->GetAmp() > fgkOverflowCut) {  // use if stored digit is out of range
394         digit->SetAmp(Int_t(fHighLowGainFactor * amp));
395         digit->SetTime(time);
396       }
397     }
398     else if (amp < fgkOverflowCut) { // new digit is high gain; use if not out of range
399       digit->SetAmp(amp);
400       digit->SetTime(time);
401     }
402   }
403 }
404
405 //____________________________________________________________________________ 
406 void AliEMCALRawUtils::FitRaw(TGraph * gSig, TF1* signalF, Float_t & amp, Float_t & time)
407 {
408   // Fits the raw signal time distribution; from AliEMCALGetter 
409
410   amp = time = 0. ; 
411   Double_t ped = 0;
412   Int_t nPed = 0;
413
414   for (Int_t index = 0; index < fNPedSamples; index++) {
415     Double_t ttime, signal;
416     gSig->GetPoint(index, ttime, signal) ; 
417     if (signal > 0) {
418       ped += signal;
419       nPed++;
420     }
421   }
422
423   if (nPed > 0)
424     ped /= nPed;
425   else {
426     AliWarning("Could not determine pedestal");   
427     ped = 10; // put some small value as first guess
428   }
429
430   Int_t max_found = 0;
431   Int_t i_max = 0;
432   Float_t max = -1;
433   Float_t max_fit = gSig->GetN();
434   Float_t min_after_sig = 9999;
435   Int_t tmin_after_sig = gSig->GetN();
436   Int_t n_ped_after_sig = 0;
437
438   for (Int_t i=fNPedSamples; i < gSig->GetN(); i++) {
439     Double_t ttime, signal;
440     gSig->GetPoint(i, ttime, signal) ; 
441     if (!max_found && signal > max) {
442       i_max = i;
443       max = signal;
444     }
445     else if ( max > ped + fNoiseThreshold ) {
446       max_found = 1;
447       min_after_sig = signal;
448       tmin_after_sig = i;
449     }
450     if (max_found) {
451       if ( signal < min_after_sig) {
452         min_after_sig = signal;
453         tmin_after_sig = i;
454       }
455       if (i > tmin_after_sig + 5) {  // Two close peaks; end fit at minimum
456         max_fit = tmin_after_sig;
457         break;
458       }
459       if ( signal < ped + fNoiseThreshold)
460         n_ped_after_sig++;
461       if (n_ped_after_sig >= 5) {  // include 5 pedestal bins after peak
462         max_fit = i;
463         break;
464       }
465     }
466   }
467
468   if ( max - ped > fNoiseThreshold ) { // else its noise 
469     AliDebug(2,Form("Fitting max %d ped %d", max, ped));
470     signalF->SetRange(0,max_fit);
471
472     if(max-ped > 50) 
473       signalF->SetParLimits(2,1,3);
474
475     signalF->SetParameter(4, ped) ; 
476     signalF->SetParameter(1, i_max);
477     signalF->SetParameter(0, max);
478     
479     gSig->Fit(signalF, "QROW"); // Note option 'W': equal errors on all points
480     amp = signalF->GetParameter(0); 
481     time = signalF->GetParameter(1)*GetRawFormatTimeBinWidth() - fgTimeTrigger;
482   }
483   return;
484 }
485 //__________________________________________________________________
486 Double_t AliEMCALRawUtils::RawResponseFunction(Double_t *x, Double_t *par)
487 {
488   // Matches version used in 2007 beam test
489   //
490   // Shape of the electronics raw reponse:
491   // It is a semi-gaussian, 2nd order Gamma function of the general form
492   //
493   // t' = (t - t0 + tau) / tau
494   // F = A * t**N * exp( N * ( 1 - t) )   for t >= 0
495   // F = 0                                for t < 0 
496   //
497   // parameters:
498   // A:   par[0]   // Amplitude = peak value
499   // t0:  par[1]
500   // tau: par[2]
501   // N:   par[3]
502   // ped: par[4]
503   //
504   Double_t signal ;
505   Double_t tau =par[2];
506   Double_t N =par[3];
507   Double_t ped = par[4];
508   Double_t xx = ( x[0] - par[1] + tau ) / tau ;
509
510   if (xx <= 0) 
511     signal = ped ;  
512   else {  
513     signal = ped + par[0] * TMath::Power(xx , N) * TMath::Exp(N * (1 - xx )) ; 
514   }
515   return signal ;  
516 }
517
518 //__________________________________________________________________
519 Bool_t AliEMCALRawUtils::RawSampledResponse(
520 const Double_t dtime, const Double_t damp, Int_t * adcH, Int_t * adcL) const 
521 {
522   // for a start time dtime and an amplitude damp given by digit, 
523   // calculates the raw sampled response AliEMCAL::RawResponseFunction
524
525   const Int_t pedVal = 32;
526   Bool_t lowGain = kFALSE ; 
527
528   // A:   par[0]   // Amplitude = peak value
529   // t0:  par[1]                            
530   // tau: par[2]                            
531   // N:   par[3]                            
532   // ped: par[4]
533
534   TF1 signalF("signal", RawResponseFunction, 0, GetRawFormatTimeMax(), 5);
535   signalF.SetParameter(0, damp) ; 
536   signalF.SetParameter(1, dtime + fgTimeTrigger) ; 
537   signalF.SetParameter(2, fTau) ; 
538   signalF.SetParameter(3, fOrder);
539   signalF.SetParameter(4, pedVal);
540
541   for (Int_t iTime = 0; iTime < GetRawFormatTimeBins(); iTime++) {
542     Double_t time = iTime * GetRawFormatTimeBinWidth() ;
543     Double_t signal = signalF.Eval(time) ;     
544     adcH[iTime] =  static_cast<Int_t>(signal + 0.5) ;
545     if ( adcH[iTime] > fgkRawSignalOverflow ){  // larger than 10 bits 
546       adcH[iTime] = fgkRawSignalOverflow ;
547       lowGain = kTRUE ; 
548     }
549
550     signal /= fHighLowGainFactor;
551
552     adcL[iTime] =  static_cast<Int_t>(signal + 0.5) ;
553     if ( adcL[iTime] > fgkRawSignalOverflow)  // larger than 10 bits 
554       adcL[iTime] = fgkRawSignalOverflow ;
555   }
556   return lowGain ; 
557 }