1 /**************************************************************************
2 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * Author: The ALICE Off-line Project. *
5 * Contributors are mentioned in the code where appropriate. *
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 **************************************************************************/
18 //_________________________________________________________________________
19 // Utility Class for handling Raw data
20 // Does all transitions from Digits to Raw and vice versa,
21 // for simu and reconstruction
23 // Note: the current version is still simplified. Only
24 // one raw signal per digit is generated; either high-gain or low-gain
25 // Need to add concurrent high and low-gain info in the future
26 // No pedestal is added to the raw signal.
27 //*-- Author: Marco van Leeuwen (LBL)
29 #include "AliEMCALRawUtils.h"
37 #include "AliRunLoader.h"
38 class AliCaloAltroMapping;
39 #include "AliAltroBuffer.h"
40 #include "AliRawReader.h"
41 #include "AliCaloRawStreamV3.h"
44 #include "AliEMCALRecParam.h"
45 #include "AliEMCALLoader.h"
46 #include "AliEMCALGeometry.h"
47 class AliEMCALDigitizer;
48 #include "AliEMCALDigit.h"
51 ClassImp(AliEMCALRawUtils)
53 // Signal shape parameters
54 Double_t AliEMCALRawUtils::fgTimeBinWidth = 100E-9 ; // each sample is 100 ns
55 Double_t AliEMCALRawUtils::fgTimeTrigger = 1.5E-6 ; // 15 time bins ~ 1.5 musec
57 // some digitization constants
58 Int_t AliEMCALRawUtils::fgThreshold = 1;
59 Int_t AliEMCALRawUtils::fgDDLPerSuperModule = 2; // 2 ddls per SuperModule
60 Int_t AliEMCALRawUtils::fgPedestalValue = 32; // pedestal value for digits2raw
61 Double_t AliEMCALRawUtils::fgFEENoise = 3.; // 3 ADC channels of noise (sampled)
63 AliEMCALRawUtils::AliEMCALRawUtils()
64 : fHighLowGainFactor(0.), fOrder(0), fTau(0.), fNoiseThreshold(0),
65 fNPedSamples(0), fGeom(0), fOption("")
68 //These are default parameters.
69 //Can be re-set from without with setter functions
70 fHighLowGainFactor = 16. ; // adjusted for a low gain range of 82 GeV (10 bits)
71 fOrder = 2; // order of gamma fn
72 fTau = 2.35; // in units of timebin, from CERN 2007 testbeam
76 //Get Mapping RCU files from the AliEMCALRecParam
77 const TObjArray* maps = AliEMCALRecParam::GetMappings();
78 if(!maps) AliFatal("Cannot retrieve ALTRO mappings!!");
80 for(Int_t i = 0; i < 4; i++) {
81 fMapping[i] = (AliAltroMapping*)maps->At(i);
84 //To make sure we match with the geometry in a simulation file,
85 //let's try to get it first. If not, take the default geometry
86 AliRunLoader *rl = AliRunLoader::Instance();
87 if(!rl) AliError("Cannot find RunLoader!");
88 if (rl->GetAliRun() && rl->GetAliRun()->GetDetector("EMCAL")) {
89 fGeom = dynamic_cast<AliEMCAL*>(rl->GetAliRun()->GetDetector("EMCAL"))->GetGeometry();
91 AliInfo(Form("Using default geometry in raw reco"));
92 fGeom = AliEMCALGeometry::GetInstance(AliEMCALGeometry::GetDefaultGeometryName());
95 if(!fGeom) AliFatal(Form("Could not get geometry!"));
99 //____________________________________________________________________________
100 AliEMCALRawUtils::AliEMCALRawUtils(AliEMCALGeometry *pGeometry)
101 : fHighLowGainFactor(0.), fOrder(0), fTau(0.), fNoiseThreshold(0),
102 fNPedSamples(0), fGeom(pGeometry), fOption("")
105 // Initialize with the given geometry - constructor required by HLT
106 // HLT does not use/support AliRunLoader(s) instances
107 // This is a minimum intervention solution
108 // Comment by MPloskon@lbl.gov
111 //These are default parameters.
112 //Can be re-set from without with setter functions
113 fHighLowGainFactor = 16. ; // adjusted for a low gain range of 82 GeV (10 bits)
114 fOrder = 2; // order of gamma fn
115 fTau = 2.35; // in units of timebin, from CERN 2007 testbeam
119 //Get Mapping RCU files from the AliEMCALRecParam
120 const TObjArray* maps = AliEMCALRecParam::GetMappings();
121 if(!maps) AliFatal("Cannot retrieve ALTRO mappings!!");
123 for(Int_t i = 0; i < 4; i++) {
124 fMapping[i] = (AliAltroMapping*)maps->At(i);
127 if(!fGeom) AliFatal(Form("Could not get geometry!"));
131 //____________________________________________________________________________
132 AliEMCALRawUtils::AliEMCALRawUtils(const AliEMCALRawUtils& rawU)
134 fHighLowGainFactor(rawU.fHighLowGainFactor),
137 fNoiseThreshold(rawU.fNoiseThreshold),
138 fNPedSamples(rawU.fNPedSamples),
140 fOption(rawU.fOption)
143 fMapping[0] = rawU.fMapping[0];
144 fMapping[1] = rawU.fMapping[1];
145 fMapping[2] = rawU.fMapping[2];
146 fMapping[3] = rawU.fMapping[3];
149 //____________________________________________________________________________
150 AliEMCALRawUtils& AliEMCALRawUtils::operator =(const AliEMCALRawUtils &rawU)
152 //assignment operator
155 fHighLowGainFactor = rawU.fHighLowGainFactor;
156 fOrder = rawU.fOrder;
158 fNoiseThreshold = rawU.fNoiseThreshold;
159 fNPedSamples = rawU.fNPedSamples;
161 fOption = rawU.fOption;
162 fMapping[0] = rawU.fMapping[0];
163 fMapping[1] = rawU.fMapping[1];
164 fMapping[2] = rawU.fMapping[2];
165 fMapping[3] = rawU.fMapping[3];
172 //____________________________________________________________________________
173 AliEMCALRawUtils::~AliEMCALRawUtils() {
178 //____________________________________________________________________________
179 void AliEMCALRawUtils::Digits2Raw()
181 // convert digits of the current event to raw data
183 AliRunLoader *rl = AliRunLoader::Instance();
184 AliEMCALLoader *loader = dynamic_cast<AliEMCALLoader*>(rl->GetDetectorLoader("EMCAL"));
187 loader->LoadDigits("EMCAL");
189 TClonesArray* digits = loader->Digits() ;
192 Warning("Digits2Raw", "no digits found !");
196 static const Int_t nDDL = 12*2; // 12 SM hardcoded for now. Buffers allocated dynamically, when needed, so just need an upper limit here
197 AliAltroBuffer* buffers[nDDL];
198 for (Int_t i=0; i < nDDL; i++)
201 Int_t adcValuesLow[fgkTimeBins];
202 Int_t adcValuesHigh[fgkTimeBins];
204 // loop over digits (assume ordered digits)
205 for (Int_t iDigit = 0; iDigit < digits->GetEntries(); iDigit++) {
206 AliEMCALDigit* digit = dynamic_cast<AliEMCALDigit *>(digits->At(iDigit)) ;
207 if (digit->GetAmp() < fgThreshold)
217 fGeom->GetCellIndex(digit->GetId(), nSM, nModule, nIphi, nIeta);
218 fGeom->GetCellPhiEtaIndexInSModule(nSM, nModule, nIphi, nIeta,iphi, ieta) ;
220 //Check which is the RCU, 0 or 1, of the cell.
223 if (0<=iphi&&iphi<8) iRCU=0; // first cable row
224 else if (8<=iphi&&iphi<16 && 0<=ieta&&ieta<24) iRCU=0; // first half;
227 else if(8<=iphi&&iphi<16 && 24<=ieta&&ieta<48) iRCU=1; // second half;
229 else if(16<=iphi&&iphi<24) iRCU=1; // third cable row
231 if (nSM%2==1) iRCU = 1 - iRCU; // swap for odd=C side, to allow us to cable both sides the same
234 Fatal("Digits2Raw()","Non-existent RCU number: %d", iRCU);
237 Int_t iDDL = fgDDLPerSuperModule* nSM + iRCU;
239 Fatal("Digits2Raw()","Non-existent DDL board number: %d", iDDL);
241 if (buffers[iDDL] == 0) {
242 // open new file and write dummy header
243 TString fileName = AliDAQ::DdlFileName("EMCAL",iDDL);
244 //Select mapping file RCU0A, RCU0C, RCU1A, RCU1C
245 Int_t iRCUside=iRCU+(nSM%2)*2;
246 //iRCU=0 and even (0) SM -> RCU0A.data 0
247 //iRCU=1 and even (0) SM -> RCU1A.data 1
248 //iRCU=0 and odd (1) SM -> RCU0C.data 2
249 //iRCU=1 and odd (1) SM -> RCU1C.data 3
250 //cout<<" nSM "<<nSM<<"; iRCU "<<iRCU<<"; iRCUside "<<iRCUside<<endl;
251 buffers[iDDL] = new AliAltroBuffer(fileName.Data(),fMapping[iRCUside]);
252 buffers[iDDL]->WriteDataHeader(kTRUE, kFALSE); //Dummy;
255 // out of time range signal (?)
256 if (digit->GetTimeR() > GetRawFormatTimeMax() ) {
257 AliInfo("Signal is out of time range.\n");
258 buffers[iDDL]->FillBuffer((Int_t)digit->GetAmp());
259 buffers[iDDL]->FillBuffer(GetRawFormatTimeBins() ); // time bin
260 buffers[iDDL]->FillBuffer(3); // bunch length
261 buffers[iDDL]->WriteTrailer(3, ieta, iphi, nSM); // trailer
262 // calculate the time response function
264 Bool_t lowgain = RawSampledResponse(digit->GetTimeR(), digit->GetAmp(), adcValuesHigh, adcValuesLow) ;
266 buffers[iDDL]->WriteChannel(ieta, iphi, 0, GetRawFormatTimeBins(), adcValuesLow, fgThreshold);
268 buffers[iDDL]->WriteChannel(ieta,iphi, 1, GetRawFormatTimeBins(), adcValuesHigh, fgThreshold);
272 // write headers and close files
273 for (Int_t i=0; i < nDDL; i++) {
276 buffers[i]->WriteDataHeader(kFALSE, kFALSE);
281 loader->UnloadDigits();
284 //____________________________________________________________________________
285 void AliEMCALRawUtils::Raw2Digits(AliRawReader* reader,TClonesArray *digitsArr)
287 // convert raw data of the current event to digits
292 Error("Raw2Digits", "no digits found !");
296 Error("Raw2Digits", "no raw reader found !");
300 AliCaloRawStreamV3 in(reader,"EMCAL",fMapping);
301 // Select EMCAL DDL's;
302 reader->Select("EMCAL");
304 //Updated fitting routine from 2007 beam test takes into account
305 //possibility of two peaks in data and selects first one for fitting
306 //Also sets some of the starting parameters based on the shape of the
307 //given raw signal being fit
309 TF1 * signalF = new TF1("signal", RawResponseFunction, 0, GetRawFormatTimeBins(), 5);
310 signalF->SetParameters(10.,0.,fTau,fOrder,5.); //set all defaults once, just to be safe
311 signalF->SetParNames("amp","t0","tau","N","ped");
312 signalF->SetParameter(2,fTau); // tau in units of time bin
313 signalF->SetParLimits(2,2,-1);
314 signalF->SetParameter(3,fOrder); // order
315 signalF->SetParLimits(3,2,-1);
323 //Graph to hold data we will fit (should be converted to an array
324 //later to speed up processing
325 TGraph * gSig = new TGraph(GetRawFormatTimeBins());
328 Int_t caloFlag = 0; // low, high gain, or TRU, or LED ref.
330 // start loop over input stream
331 while (in.NextDDL()) {
332 while (in.NextChannel()) {
334 id = fGeom->GetAbsCellIdFromCellIndexes(in.GetModule(), in.GetRow(), in.GetColumn()) ;
335 caloFlag = in.GetCaloFlag();
336 lowGain = in.IsLowGain();
338 // There can be zero-suppression in the raw data,
339 // so set up the TGraph in advance
340 for (i=0; i < GetRawFormatTimeBins(); i++) {
341 gSig->SetPoint(i, i , 0);
346 while (in.NextBunch()) {
347 const UShort_t *sig = in.GetSignals();
348 startBin = in.GetStartTimeBin();
350 if (((UInt_t) maxTime) < in.GetStartTimeBin()) {
351 maxTime = in.GetStartTimeBin(); // timebins come in reverse order
354 if (maxTime < 0 || maxTime >= GetRawFormatTimeBins()) {
355 AliWarning(Form("Invalid time bin %d",maxTime));
356 maxTime = GetRawFormatTimeBins();
359 for (i = 0; i < in.GetBunchLength(); i++) {
361 gSig->SetPoint(time, time, sig[i]) ;
363 } // loop over bunches
365 gSig->Set(maxTime+1);
366 FitRaw(gSig, signalF, amp, time) ;
368 if (caloFlag == 0 || caloFlag == 1) { // low gain or high gain
369 if (amp > 0 && amp < 2000) { //check both high and low end of
370 //result, 2000 is somewhat arbitrary - not nice with magic numbers in the code..
371 AliDebug(2,Form("id %d lowGain %d amp %g", id, lowGain, amp));
373 AddDigit(digitsArr, id, lowGain, (Int_t)amp, time);
379 for (Int_t index = 0; index < gSig->GetN(); index++) {
380 gSig->SetPoint(index, index, 0) ;
382 // Reset starting parameters for fit function
383 signalF->SetParameters(10.,0.,fTau,fOrder,5.); //reset all defaults just to be safe
385 } // end while over channel
386 } //end while over DDL's, of input stream
394 //____________________________________________________________________________
395 void AliEMCALRawUtils::AddDigit(TClonesArray *digitsArr, Int_t id, Int_t lowGain, Int_t amp, Float_t time) {
398 // This routine checks whether a digit exists already for this tower
399 // and then decides whether to use the high or low gain info
401 // Called by Raw2Digits
403 AliEMCALDigit *digit = 0, *tmpdigit = 0;
405 TIter nextdigit(digitsArr);
406 while (digit == 0 && (tmpdigit = (AliEMCALDigit*) nextdigit())) {
407 if (tmpdigit->GetId() == id)
411 if (!digit) { // no digit existed for this tower; create one
413 amp = Int_t(fHighLowGainFactor * amp);
414 Int_t idigit = digitsArr->GetEntries();
415 new((*digitsArr)[idigit]) AliEMCALDigit( -1, -1, id, amp, time, idigit) ;
417 else { // a digit already exists, check range
418 // (use high gain if signal < cut value, otherwise low gain)
419 if (lowGain) { // new digit is low gain
420 if (digit->GetAmp() > fgkOverflowCut) { // use if stored digit is out of range
421 digit->SetAmp(Int_t(fHighLowGainFactor * amp));
422 digit->SetTime(time);
425 else if (amp < fgkOverflowCut) { // new digit is high gain; use if not out of range
427 digit->SetTime(time);
432 //____________________________________________________________________________
433 void AliEMCALRawUtils::FitRaw(TGraph * gSig, TF1* signalF, Float_t & amp, Float_t & time) const
435 // Fits the raw signal time distribution; from AliEMCALGetter
441 for (Int_t index = 0; index < fNPedSamples; index++) {
442 Double_t ttime, signal;
443 gSig->GetPoint(index, ttime, signal) ;
453 AliWarning("Could not determine pedestal");
454 ped = 10; // put some small value as first guess
460 Float_t maxFit = gSig->GetN();
461 Float_t minAfterSig = 9999;
462 Int_t tminAfterSig = gSig->GetN();
463 Int_t nPedAfterSig = 0;
464 Int_t plateauWidth = 0;
465 Int_t plateauStart = 9999;
468 for (Int_t i=fNPedSamples; i < gSig->GetN(); i++) {
469 Double_t ttime, signal;
470 gSig->GetPoint(i, ttime, signal) ;
471 if (!maxFound && signal > max) {
475 else if ( max > ped + fNoiseThreshold ) {
477 minAfterSig = signal;
481 if ( signal < minAfterSig) {
482 minAfterSig = signal;
485 if (i > tminAfterSig + 5) { // Two close peaks; end fit at minimum
486 maxFit = tminAfterSig;
489 if ( signal < cut*max){ //stop fit at 30% amplitude(avoid the pulse shape falling edge)
493 if ( signal < ped + fNoiseThreshold)
495 if (nPedAfterSig >= 5) { // include 5 pedestal bins after peak
500 //Add check on plateau
501 if (signal >= fgkRawSignalOverflow - fNoiseThreshold) {
502 if(plateauWidth == 0) plateauStart = i;
507 if(plateauWidth > 0) {
508 for(int j = 0; j < plateauWidth; j++) {
509 //Note, have to remove the same point N times because after each
510 //remove, the positions of all subsequent points have shifted down
511 gSig->RemovePoint(plateauStart);
515 if ( max - ped > fNoiseThreshold ) { // else its noise
516 AliDebug(2,Form("Fitting max %d ped %d", max, ped));
517 signalF->SetRange(0,maxFit);
520 signalF->SetParLimits(2,1,3);
522 signalF->SetParameter(4, ped) ;
523 signalF->SetParameter(1, iMax);
524 signalF->SetParameter(0, max);
526 gSig->Fit(signalF, "QROW"); // Note option 'W': equal errors on all points
527 amp = signalF->GetParameter(0);
528 time = signalF->GetParameter(1)*GetRawFormatTimeBinWidth() - fgTimeTrigger;
532 //__________________________________________________________________
533 Double_t AliEMCALRawUtils::RawResponseFunction(Double_t *x, Double_t *par)
535 // Matches version used in 2007 beam test
537 // Shape of the electronics raw reponse:
538 // It is a semi-gaussian, 2nd order Gamma function of the general form
540 // t' = (t - t0 + tau) / tau
541 // F = A * t**N * exp( N * ( 1 - t) ) for t >= 0
545 // A: par[0] // Amplitude = peak value
552 Double_t tau =par[2];
554 Double_t ped = par[4];
555 Double_t xx = ( x[0] - par[1] + tau ) / tau ;
560 signal = ped + par[0] * TMath::Power(xx , n) * TMath::Exp(n * (1 - xx )) ;
565 //__________________________________________________________________
566 Bool_t AliEMCALRawUtils::RawSampledResponse(
567 const Double_t dtime, const Double_t damp, Int_t * adcH, Int_t * adcL) const
569 // for a start time dtime and an amplitude damp given by digit,
570 // calculates the raw sampled response AliEMCAL::RawResponseFunction
572 Bool_t lowGain = kFALSE ;
574 // A: par[0] // Amplitude = peak value
580 TF1 signalF("signal", RawResponseFunction, 0, GetRawFormatTimeBins(), 5);
581 signalF.SetParameter(0, damp) ;
582 signalF.SetParameter(1, (dtime + fgTimeTrigger)/fgTimeBinWidth) ;
583 signalF.SetParameter(2, fTau) ;
584 signalF.SetParameter(3, fOrder);
585 signalF.SetParameter(4, fgPedestalValue);
587 for (Int_t iTime = 0; iTime < GetRawFormatTimeBins(); iTime++) {
588 Double_t signal = signalF.Eval(iTime) ;
590 //According to Terry Awes, 13-Apr-2008
591 //add gaussian noise in quadrature to each sample
592 //Double_t noise = gRandom->Gaus(0.,fgFEENoise);
593 //signal = sqrt(signal*signal + noise*noise);
595 adcH[iTime] = static_cast<Int_t>(signal + 0.5) ;
596 if ( adcH[iTime] > fgkRawSignalOverflow ){ // larger than 10 bits
597 adcH[iTime] = fgkRawSignalOverflow ;
601 signal /= fHighLowGainFactor;
603 adcL[iTime] = static_cast<Int_t>(signal + 0.5) ;
604 if ( adcL[iTime] > fgkRawSignalOverflow) // larger than 10 bits
605 adcL[iTime] = fgkRawSignalOverflow ;