1 /**************************************************************************
2 * Copyright(c) 2007, 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 //This class produces PHOS digits of one event
19 //using AliPHOSRawFitter.
22 // TClonesArray *digits = new TClonesArray("AliPHOSDigit",100);
23 // AliRawReader* rawReader = new AliRawReaderDate("2006run2211.raw");
24 // AliPHOSRawDecoder dc(rawReader);
25 // while (rawReader->NextEvent()) {
26 // AliPHOSRawDigiProducer producer;
27 // producer.MakeDigits(digits,&dc);
30 // Author: Boris Polichtchouk
32 // --- ROOT system ---
33 #include "TClonesArray.h"
35 // --- AliRoot header files ---
36 #include "AliPHOSRawDigiProducer.h"
37 #include "AliPHOSRawFitterv0.h"
38 #include "AliPHOSGeometry.h"
39 #include "AliPHOSDigit.h"
40 #include "AliPHOSCalibData.h"
41 #include "AliPHOSPulseGenerator.h"
42 #include "AliCaloRawStreamV3.h"
45 ClassImp(AliPHOSRawDigiProducer)
47 AliPHOSCalibData * AliPHOSRawDigiProducer::fgCalibData = 0 ;
49 //--------------------------------------------------------------------------------------
50 AliPHOSRawDigiProducer::AliPHOSRawDigiProducer():
54 fSampleQualityCut(1.),
64 // Default constructor
66 fGeom=AliPHOSGeometry::GetInstance() ;
67 if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
69 fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
70 fPulseGenerator = new AliPHOSPulseGenerator();
71 GetCalibrationParameters() ;
74 //--------------------------------------------------------------------------------------
75 AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(AliRawReader *rawReader,
76 AliAltroMapping **mapping):
80 fSampleQualityCut(1.),
85 fRawReader(rawReader),
90 // Default constructor
92 fGeom=AliPHOSGeometry::GetInstance() ;
93 if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
95 fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
96 fPulseGenerator = new AliPHOSPulseGenerator();
97 GetCalibrationParameters() ;
99 fRawStream = new AliCaloRawStreamV3(rawReader,"PHOS",mapping);
102 //--------------------------------------------------------------------------------------
103 AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(const AliPHOSRawDigiProducer &dp):
107 fSampleQualityCut(1.),
120 fEmcMinE = dp.fEmcMinE ;
121 fCpvMinE = dp.fCpvMinE ;
122 fSampleQualityCut = dp.fSampleQualityCut;
123 fSampleToSec = dp.fSampleToSec ;
124 fEmcCrystals = dp.fEmcCrystals ;
125 fPulseGenerator = new AliPHOSPulseGenerator();
128 //--------------------------------------------------------------------------------------
129 AliPHOSRawDigiProducer& AliPHOSRawDigiProducer::operator= (const AliPHOSRawDigiProducer &dp)
133 if(&dp == this) return *this;
135 fEmcMinE = dp.fEmcMinE ;
136 fCpvMinE = dp.fCpvMinE ;
137 fSampleQualityCut = dp.fSampleQualityCut ;
138 fSampleToSec = dp.fSampleToSec ;
139 fEmcCrystals = dp.fEmcCrystals ;
141 if(fPulseGenerator) delete fPulseGenerator ;
142 fPulseGenerator = new AliPHOSPulseGenerator();
145 //--------------------------------------------------------------------------------------
146 AliPHOSRawDigiProducer::~AliPHOSRawDigiProducer()
149 if(fPulseGenerator) delete fPulseGenerator ;
152 delete [] fADCValuesLG;
153 delete [] fADCValuesHG;
155 //--------------------------------------------------------------------------------------
156 void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, AliPHOSRawFitterv0* fitter)
158 // Create a temporary array of LG digits and then make digits from raw data
160 TClonesArray *tmpLG = new TClonesArray("AliPHOSDigit",10000) ;
161 MakeDigits(digits, tmpLG, fitter);
165 //--------------------------------------------------------------------------------------
166 void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, TClonesArray *tmpDigLG, AliPHOSRawFitterv0* fitter)
169 //TClonesArray *digits, *tmpDigLG and raw data fitter should be provided by calling function.
174 Int_t relId[4], absId=-1, caloFlag=-1;
176 const Double_t baseLine=1. ; //Minimal energy of digit in ADC ch.
178 //Calculate conversion coeff. from Sample time step to seconds
179 //If OCDB contains negative or zero value - use one from RCU trailer
180 //Negative value in OCDB is used only for simulation of raw digits
181 if(fgCalibData->GetSampleTimeStep()>0.)
182 fSampleToSec=fgCalibData->GetSampleTimeStep() ;
184 fSampleToSec=fRawStream->GetTSample() ;
186 // Clear a temporary array for LowGain digits
190 //Let fitter subtract pedestals in case of ZS
191 fitter->SetCalibData(fgCalibData) ;
193 while (fRawStream->NextDDL()) {
194 while (fRawStream->NextChannel()) {
195 relId[0] = 5 - fRawStream->GetModule() ; // counts from 1 to 5
197 relId[2] = fRawStream->GetCellX() + 1; // counts from 1 to 64
198 relId[3] = fRawStream->GetCellZ() + 1; // counts from 1 to 56
199 caloFlag = fRawStream->GetCaloFlag(); // 0=LG, 1=HG, 2=TRU
201 if(caloFlag!=0 && caloFlag!=1) continue; //TRU data!
203 fitter->SetChannelGeo(relId[0],relId[2],relId[3],caloFlag);
205 if(fitter->GetAmpOffset()==0 && fitter->GetAmpThreshold()==0) {
206 short value = fRawStream->GetAltroCFG1();
207 bool ZeroSuppressionEnabled = (value >> 15) & 0x1;
208 if(ZeroSuppressionEnabled) {
209 short offset = (value >> 10) & 0xf;
210 short threshold = value & 0x3ff;
211 fitter->SubtractPedestals(kFALSE);
212 fitter->SetAmpOffset(offset);
213 fitter->SetAmpThreshold(threshold);
217 fGeom->RelToAbsNumbering(relId, absId);
219 fitter->SetNBunches(0);
222 while (fRawStream->NextBunch()) { //Take the first in time bunch
223 const UShort_t *sig = fRawStream->GetSignals();
224 sigStart = fRawStream->GetStartTimeBin();
225 sigLength = fRawStream->GetBunchLength();
226 fitter->Eval(sig,sigStart,sigLength);
227 if (caloFlag == AliCaloRawStreamV3::kLowGain) {
228 delete [] fADCValuesLG;
229 fADCValuesLG = new Int_t[sigLength];
230 for (Int_t i=0; i<sigLength; i++)
231 fADCValuesLG[sigLength-i-1] = sig[i];
233 else if (caloFlag == AliCaloRawStreamV3::kHighGain) {
234 delete [] fADCValuesHG;
235 fADCValuesHG = new Int_t[sigLength];
236 for (Int_t i=0; i<sigLength; i++)
237 fADCValuesHG[sigLength-i-1] = sig[i];
239 } // End of NextBunch()
242 Double_t energy = fitter->GetEnergy() ;
243 Double_t time = fitter->GetTime() ;
244 if(energy<=baseLine) //in ADC channels
247 //remove digits with bad shape. Fitter should calculate quality so that
248 //in default case quality [0,1], while larger values of quality mean somehow
249 //corrupted samples, 999 means obviously corrupted sample.
250 //It is difficult to fit samples with overflow (even setting cut on overflow values)
251 //because too few points are left to fit. So we do not evaluate samples with overflow
253 if(fitter->GetSignalQuality() > fSampleQualityCut && !(fitter->IsOverflow()))
256 energy = CalibrateE(energy,relId,!caloFlag) ;
258 //convert time from sample bin units to s
260 //CalibrateT moved to Clusterizer
261 // time = CalibrateT(time,relId,!caloFlag) ;
262 // subtract RCU L1 phase (L1Phase is in seconds) w.r.t. L0:
263 time += fRawStream->GetL1Phase();
270 if (caloFlag == AliCaloRawStreamV3::kLowGain) {
271 new((*tmpDigLG)[ilgDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
272 if (sigLength>0 && fADCValuesLG!=0)
273 static_cast<AliPHOSDigit*>(tmpDigLG->At(ilgDigit))->SetALTROSamplesLG(sigLength,fADCValuesLG);
276 else if (caloFlag == AliCaloRawStreamV3::kHighGain) {
277 if(fitter->IsOverflow()) //Keep this digit to replace it by Low Gain later.
278 //If there is no LogGain it wil be removed by cut on Min E
279 new((*digits)[iDigit]) AliPHOSDigit(-1,absId,-1.f,(Float_t)time);
281 new((*digits)[iDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
282 if (sigLength>0 && fADCValuesHG!=0)
283 static_cast<AliPHOSDigit*>(digits->At(iDigit))->SetALTROSamplesHG(sigLength,fADCValuesHG);
286 } // End of NextChannel()
288 //Now scan created LG and HG digits and keep only those which appeared in both lists
289 //replace energy of HighGain digits only if there is overflow
290 //negative energy (overflow)
294 Int_t nLG1 = tmpDigLG->GetEntriesFast()-1 ;
296 for(Int_t iDig=0 ; iDig < digits->GetEntriesFast() ; iDig++) {
297 AliPHOSDigit * digHG = dynamic_cast<AliPHOSDigit*>(digits->At(iDig)) ;
298 if (!digHG) continue;
299 AliPHOSDigit * digLG = dynamic_cast<AliPHOSDigit*>(tmpDigLG->At(iLG)) ;
300 while(digLG && iLG<nLG1 && digHG->GetId()> digLG->GetId()){
302 digLG = dynamic_cast<AliPHOSDigit*>(tmpDigLG->At(iLG)) ;
304 absId=digHG->GetId() ;
305 fGeom->AbsToRelNumbering(absId,relId) ;
307 if(digLG && digHG->GetId() == digLG->GetId()){ //we found pair
308 if(digHG->GetEnergy()<0.){ //This is overflow in HG
309 digHG->SetTime(digLG->GetTime()) ;
310 digHG->SetEnergy(digLG->GetEnergy()) ;
313 else{ //no pair - remove
314 if(digHG->GetEnergy()<0.) //no pair, in saturation
315 digits->RemoveAt(iDig) ;
318 } // End of NextDDL()
320 CleanDigits(digits) ;
323 //____________________________________________________________________________
324 Double_t AliPHOSRawDigiProducer::CalibrateE(Double_t amp, Int_t* relId, Bool_t isLowGain)
326 // Convert EMC LG amplitude to HG (multipli by ~16)
327 // Calibration parameters are taken from calibration data base
329 Int_t module = relId[0];
330 Int_t column = relId[3];
331 Int_t row = relId[2];
332 if(relId[1]==0) { // this is EMC
334 amp*= fgCalibData->GetHighLowRatioEmc(module,column,row);
341 //____________________________________________________________________________
342 Double_t AliPHOSRawDigiProducer::CalibrateT(Double_t time, Int_t * relId, Bool_t /* isLowGain */)
346 Int_t module = relId[0];
347 Int_t column = relId[3];
348 Int_t row = relId[2];
349 if(relId[1]==0) { // this is EMC
350 time += fgCalibData->GetTimeShiftEmc(module,column,row);
357 //____________________________________________________________________________
358 void AliPHOSRawDigiProducer::CleanDigits(TClonesArray * digits)
360 // remove digits with amplitudes below threshold.
361 // remove digits in bad channels
362 // sort digits with icreasing AbsId
364 //remove digits in bad map and below threshold
365 Bool_t isBadMap = 0 ;
366 if(fgCalibData->GetNumOfEmcBadChannels()){
370 for(Int_t i=0; i<digits->GetEntriesFast(); i++){
371 AliPHOSDigit * digit = static_cast<AliPHOSDigit*>(digits->At(i)) ;
374 if ( (IsInEMC(digit) && digit->GetEnergy() < fEmcMinE) ||
375 (IsInCPV(digit) && digit->GetEnergy() < fCpvMinE) ){
376 digits->RemoveAt(i) ;
379 if(isBadMap){ //check bad map now
381 fGeom->AbsToRelNumbering(digit->GetId(), relid) ;
382 if(fgCalibData->IsBadChannelEmc(relid[0],relid[3],relid[2])){
383 digits->RemoveAt(i) ;
388 //Compress, sort and set indexes
390 // digits->Sort(); already sorted earlier
391 for (Int_t i = 0 ; i < digits->GetEntriesFast() ; i++) {
392 AliPHOSDigit *digit = static_cast<AliPHOSDigit*>( digits->At(i) ) ;
393 digit->SetIndexInList(i) ;
396 //____________________________________________________________________________
397 Bool_t AliPHOSRawDigiProducer::IsInEMC(AliPHOSDigit * digit) const
399 // Tells if (true) or not (false) the digit is in a PHOS-EMC module
400 return digit->GetId() <= fEmcCrystals ;
404 //____________________________________________________________________________
405 Bool_t AliPHOSRawDigiProducer::IsInCPV(AliPHOSDigit * digit) const
407 // Tells if (true) or not (false) the digit is in a PHOS-CPV module
408 return digit->GetId() > fEmcCrystals ;
410 //____________________________________________________________________________
411 void AliPHOSRawDigiProducer::GetCalibrationParameters()
413 // Set calibration parameters:
414 // if calibration database exists, they are read from database,
415 // otherwise, reconstruction stops in the constructor of AliPHOSCalibData
417 // It is a user responsilibity to open CDB before reconstruction, for example:
418 // AliCDBStorage* storage = AliCDBManager::Instance()->GetStorage("local://CalibDB");
421 fgCalibData = new AliPHOSCalibData(-1); //use AliCDBManager's run number
423 if (fgCalibData->GetCalibDataEmc() == 0)
424 AliFatal("Calibration parameters for PHOS EMC not found. Stop reconstruction.\n");
425 if (fgCalibData->GetCalibDataCpv() == 0)
426 AliFatal("Calibration parameters for PHOS CPV not found. Stop reconstruction.\n");