Removing useless flag.
[u/mrichter/AliRoot.git] / PHOS / AliPHOSRawDigiProducer.cxx
1 /**************************************************************************
2  * Copyright(c) 2007, 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
18 //This class produces PHOS digits of one event
19 //using AliPHOSRawFitter. 
20 //
21 //   For example:
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);
28 //   }
29
30 // Author: Boris Polichtchouk
31
32 // --- ROOT system ---
33 #include "TClonesArray.h"
34
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"
43 #include "AliLog.h"
44
45 ClassImp(AliPHOSRawDigiProducer)
46
47 AliPHOSCalibData * AliPHOSRawDigiProducer::fgCalibData  = 0 ; 
48
49 //--------------------------------------------------------------------------------------
50 AliPHOSRawDigiProducer::AliPHOSRawDigiProducer():
51   TObject(),
52   fEmcMinE(0.),
53   fCpvMinE(0.),
54   fSampleQualityCut(1.),
55   fSampleToSec(0.),
56   fEmcCrystals(0),
57   fGeom(0),
58   fPulseGenerator(0),
59   fRawReader(0),
60   fRawStream(0),
61   fADCValuesLG(0),
62   fADCValuesHG(0)
63 {
64   // Default constructor
65
66   fGeom=AliPHOSGeometry::GetInstance() ;
67   if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
68
69   fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
70   fPulseGenerator = new AliPHOSPulseGenerator();
71   GetCalibrationParameters() ; 
72
73 }
74 //--------------------------------------------------------------------------------------
75 AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(AliRawReader *rawReader,
76                                                AliAltroMapping **mapping):
77   TObject(),
78   fEmcMinE(0.),
79   fCpvMinE(0.),
80   fSampleQualityCut(1.),
81   fSampleToSec(0.),
82   fEmcCrystals(0),
83   fGeom(0),
84   fPulseGenerator(0),
85   fRawReader(rawReader),
86   fRawStream(0),
87   fADCValuesLG(0),
88   fADCValuesHG(0)
89 {
90   // Default constructor
91
92   fGeom=AliPHOSGeometry::GetInstance() ;
93   if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
94
95   fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
96   fPulseGenerator = new AliPHOSPulseGenerator();
97   GetCalibrationParameters() ; 
98
99   fRawStream = new AliCaloRawStreamV3(rawReader,"PHOS",mapping);
100
101 }
102 //--------------------------------------------------------------------------------------
103 AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(const AliPHOSRawDigiProducer &dp):
104   TObject(),
105   fEmcMinE(0.),
106   fCpvMinE(0.),
107   fSampleQualityCut(1.),
108   fSampleToSec(0.),
109   fEmcCrystals(0),
110   fGeom(0),
111   fPulseGenerator(0),
112   fRawReader(0),
113   fRawStream(0),
114   fADCValuesLG(0),
115   fADCValuesHG(0)
116
117 {                                                          
118   // Copy constructor
119
120   fEmcMinE = dp.fEmcMinE ;
121   fCpvMinE = dp.fCpvMinE ;
122   fSampleQualityCut = dp.fSampleQualityCut;
123   fSampleToSec = dp.fSampleToSec ;
124   fEmcCrystals = dp.fEmcCrystals ;
125   fPulseGenerator = new AliPHOSPulseGenerator();
126   fGeom = dp.fGeom ;
127 }
128 //--------------------------------------------------------------------------------------
129 AliPHOSRawDigiProducer& AliPHOSRawDigiProducer::operator= (const AliPHOSRawDigiProducer &dp)
130 {
131   // Assign operator
132
133   if(&dp == this) return *this;
134
135   fEmcMinE = dp.fEmcMinE ;
136   fCpvMinE = dp.fCpvMinE ;
137   fSampleQualityCut = dp.fSampleQualityCut ;
138   fSampleToSec = dp.fSampleToSec ;
139   fEmcCrystals = dp.fEmcCrystals ;
140   fGeom = dp.fGeom ;
141   if(fPulseGenerator) delete fPulseGenerator ;
142   fPulseGenerator = new AliPHOSPulseGenerator();
143   return  *this;
144
145 //--------------------------------------------------------------------------------------
146 AliPHOSRawDigiProducer::~AliPHOSRawDigiProducer()
147 {
148   // Destructor
149   if(fPulseGenerator) delete fPulseGenerator ;
150   fPulseGenerator=0 ;
151   delete fRawStream;
152   delete [] fADCValuesLG;
153   delete [] fADCValuesHG;
154 }
155 //--------------------------------------------------------------------------------------
156 void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, AliPHOSRawFitterv0* fitter) 
157 {
158   // Create a temporary array of LG digits and then make digits from raw data
159
160   TClonesArray *tmpLG = new TClonesArray("AliPHOSDigit",10000) ;
161   MakeDigits(digits, tmpLG, fitter);
162   tmpLG->Delete();
163   delete tmpLG;
164 }
165 //--------------------------------------------------------------------------------------
166 void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, TClonesArray *tmpDigLG, AliPHOSRawFitterv0* fitter) 
167 {
168   //Makes the job.
169   //TClonesArray *digits, *tmpDigLG and raw data fitter should be provided by calling function.
170
171   digits->Clear();
172  
173   Int_t iDigit=0 ;
174   Int_t relId[4], absId=-1, caloFlag=-1;
175   
176   const Double_t baseLine=1. ; //Minimal energy of digit in ADC ch. 
177
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() ;
183   else
184     fSampleToSec=fRawStream->GetTSample() ;
185   
186   // Clear a temporary array for LowGain digits
187   tmpDigLG->Clear();
188   Int_t ilgDigit=0 ;
189
190   //Let fitter subtract pedestals in case of ZS
191   fitter->SetCalibData(fgCalibData) ;
192   
193   while (fRawStream->NextDDL()) {
194     while (fRawStream->NextChannel()) {
195       relId[0] = 5 - fRawStream->GetModule() ; // counts from 1 to 5
196       relId[1] = 0;
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
200       
201       if(caloFlag!=0 && caloFlag!=1) continue; //TRU data!
202       
203       fitter->SetChannelGeo(relId[0],relId[2],relId[3],caloFlag);
204
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);
214         }
215       }
216       
217       fGeom->RelToAbsNumbering(relId, absId);
218       
219       fitter->SetNBunches(0);
220       Int_t sigStart =0 ;
221       Int_t sigLength=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];
232         }
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];
238         }
239       } // End of NextBunch()
240
241       
242       Double_t energy = fitter->GetEnergy() ; 
243       Double_t time   = fitter->GetTime() ;
244       if(energy<=baseLine) //in ADC channels
245         continue ;
246
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
252
253       if(fitter->GetSignalQuality() > fSampleQualityCut && !(fitter->IsOverflow()))
254         continue ;
255       
256       energy = CalibrateE(energy,relId,!caloFlag) ;
257
258       //convert time from sample bin units to s
259       time*=fSampleToSec ;
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       //Very strange behaviour of electronics, but cross-checkes several times...
264       if( fRawStream->GetL1Phase()<55.*1.e-9 ) //for phase=0,25,50
265         time -= fRawStream->GetL1Phase();
266       else //for phase 75
267         time += 25.*1.e-9 ;
268       
269       if(energy <= 0.) 
270         continue;
271       
272       if (caloFlag == AliCaloRawStreamV3::kLowGain) {
273         new((*tmpDigLG)[ilgDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
274         if (sigLength>0 && fADCValuesLG!=0)
275           static_cast<AliPHOSDigit*>(tmpDigLG->At(ilgDigit))->SetALTROSamplesLG(sigLength,fADCValuesLG);
276         ilgDigit++ ; 
277       }
278       else if (caloFlag == AliCaloRawStreamV3::kHighGain) {
279         if(fitter->IsOverflow()) //Keep this digit to replace it by Low Gain later.
280           //If there is no LogGain it wil be removed by cut on Min E
281           new((*digits)[iDigit]) AliPHOSDigit(-1,absId,-1.f,(Float_t)time);
282         else
283           new((*digits)[iDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
284         if (sigLength>0 && fADCValuesHG!=0)
285           static_cast<AliPHOSDigit*>(digits->At(iDigit))->SetALTROSamplesHG(sigLength,fADCValuesHG);
286         iDigit++;
287       }
288     } // End of NextChannel()
289
290     //Now scan created LG and HG digits and keep only those which appeared in both lists 
291     //replace energy of HighGain digits only if there is overflow
292     //negative energy (overflow)
293     digits->Sort() ;
294     tmpDigLG->Sort() ;
295     Int_t iLG = 0;
296     Int_t nLG1 = tmpDigLG->GetEntriesFast()-1 ;
297     
298     for(Int_t iDig=0 ; iDig < digits->GetEntriesFast() ; iDig++) { 
299       AliPHOSDigit * digHG = dynamic_cast<AliPHOSDigit*>(digits->At(iDig)) ;
300       if (!digHG) continue;
301       AliPHOSDigit * digLG = dynamic_cast<AliPHOSDigit*>(tmpDigLG->At(iLG)) ;
302       while(digLG && iLG<nLG1 && digHG->GetId()> digLG->GetId()){
303         iLG++ ;
304         digLG = dynamic_cast<AliPHOSDigit*>(tmpDigLG->At(iLG)) ;
305       }
306       absId=digHG->GetId() ;
307       fGeom->AbsToRelNumbering(absId,relId) ;
308  
309       if(digLG && digHG->GetId() == digLG->GetId()){ //we found pair
310         if(digHG->GetEnergy()<0.){ //This is overflow in HG
311           digHG->SetTime(digLG->GetTime()) ;
312           digHG->SetEnergy(digLG->GetEnergy()) ;
313           digHG->SetLG(kTRUE) ;
314         }
315       }
316       else{ //no pair - remove
317         if(digHG->GetEnergy()<0.) //no pair, in saturation
318           digits->RemoveAt(iDig) ;                                                          
319       }
320     }
321   } // End of NextDDL()
322
323   CleanDigits(digits) ;
324   
325 }
326 //____________________________________________________________________________
327 Double_t AliPHOSRawDigiProducer::CalibrateE(Double_t amp, Int_t* relId, Bool_t isLowGain)
328 {
329   // Convert EMC LG amplitude to HG (multipli by ~16)
330   // Calibration parameters are taken from calibration data base 
331   if(fgCalibData){ 
332     Int_t   module = relId[0];  
333     Int_t   column = relId[3];
334     Int_t   row    = relId[2];
335     if(relId[1]==0) { // this is EMC 
336       if(isLowGain){
337         amp*= fgCalibData->GetHighLowRatioEmc(module,column,row);
338       }
339       return amp ;         
340     }         
341   }          
342   return 0;        
343 }
344 //____________________________________________________________________________
345 Double_t AliPHOSRawDigiProducer::CalibrateT(Double_t time, Int_t * relId, Bool_t /* isLowGain */)
346 {
347   //Calibrate time
348   if(fgCalibData){
349     Int_t   module = relId[0];
350     Int_t   column = relId[3];
351     Int_t   row    = relId[2];
352     if(relId[1]==0) { // this is EMC
353       time += fgCalibData->GetTimeShiftEmc(module,column,row);                   
354       return time ;             
355     }
356   }
357  
358   return -999.;
359 }
360 //____________________________________________________________________________
361 void AliPHOSRawDigiProducer::CleanDigits(TClonesArray * digits)
362 {
363   // remove digits with amplitudes below threshold.
364   // remove digits in bad channels
365   // sort digits with icreasing AbsId
366   
367   //remove digits in bad map and below threshold
368   Bool_t isBadMap = 0 ;
369   if(fgCalibData->GetNumOfEmcBadChannels()){
370     isBadMap=1 ;
371   }
372   
373   for(Int_t i=0; i<digits->GetEntriesFast(); i++){
374     AliPHOSDigit * digit = static_cast<AliPHOSDigit*>(digits->At(i)) ;
375     if(!digit)
376       continue  ;
377     if ( (IsInEMC(digit) && digit->GetEnergy() < fEmcMinE) ||
378          (IsInCPV(digit) && digit->GetEnergy() < fCpvMinE) ){
379       digits->RemoveAt(i) ;
380       continue ;
381     }
382     if(isBadMap){ //check bad map now
383       Int_t relid[4] ;
384       fGeom->AbsToRelNumbering(digit->GetId(), relid) ; 
385       if(fgCalibData->IsBadChannelEmc(relid[0],relid[3],relid[2])){
386         digits->RemoveAt(i) ;
387       }
388     }
389   }
390
391   //Compress, sort and set indexes
392   digits->Compress() ;
393 //  digits->Sort(); already sorted earlier
394   for (Int_t i = 0 ; i < digits->GetEntriesFast() ; i++) { 
395     AliPHOSDigit *digit = static_cast<AliPHOSDigit*>( digits->At(i) ) ; 
396     digit->SetIndexInList(i) ;     
397   }
398 }
399 //____________________________________________________________________________
400 Bool_t AliPHOSRawDigiProducer::IsInEMC(AliPHOSDigit * digit) const
401 {
402   // Tells if (true) or not (false) the digit is in a PHOS-EMC module
403   return digit->GetId() <= fEmcCrystals ;
404
405 }
406
407 //____________________________________________________________________________
408 Bool_t AliPHOSRawDigiProducer::IsInCPV(AliPHOSDigit * digit) const
409 {
410   // Tells if (true) or not (false) the digit is in a PHOS-CPV module
411   return digit->GetId() > fEmcCrystals ;
412 }
413 //____________________________________________________________________________
414 void AliPHOSRawDigiProducer::GetCalibrationParameters() 
415 {
416   // Set calibration parameters:
417   // if calibration database exists, they are read from database,
418   // otherwise, reconstruction stops in the constructor of AliPHOSCalibData
419   //
420   // It is a user responsilibity to open CDB before reconstruction, for example: 
421   // AliCDBStorage* storage = AliCDBManager::Instance()->GetStorage("local://CalibDB");
422
423   if (!fgCalibData){
424     fgCalibData = new AliPHOSCalibData(-1); //use AliCDBManager's run number
425   }
426   if (fgCalibData->GetCalibDataEmc() == 0)
427     AliFatal("Calibration parameters for PHOS EMC not found. Stop reconstruction.\n");
428   if (fgCalibData->GetCalibDataCpv() == 0)
429     AliFatal("Calibration parameters for PHOS CPV not found. Stop reconstruction.\n");
430 }