newRCU format used consistently in QA and reconstr.
[u/mrichter/AliRoot.git] / PHOS / AliPHOSRawDigiProducer.cxx
CommitLineData
7bc140a5 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 AliPHOSRawDecoder.
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 ---
88fb5e50 33#include "TClonesArray.h"
34
7bc140a5 35// --- AliRoot header files ---
88fb5e50 36#include "AliPHOSRawDigiProducer.h"
37#include "AliPHOSRawDecoder.h"
38#include "AliPHOSGeometry.h"
39#include "AliPHOSDigit.h"
c0394bfb 40#include "AliPHOSRecoParam.h"
41#include "AliPHOSCalibData.h"
39569d36 42#include "AliPHOSPulseGenerator.h"
c0394bfb 43#include "AliLog.h"
88fb5e50 44
45ClassImp(AliPHOSRawDigiProducer)
46
c0394bfb 47AliPHOSCalibData * AliPHOSRawDigiProducer::fgCalibData = 0 ;
48
49//--------------------------------------------------------------------------------------
50AliPHOSRawDigiProducer::AliPHOSRawDigiProducer():TObject(),
39569d36 51 fEmcMinE(0.),fCpvMinE(0.),fSampleQualityCut(1.),
52 fEmcCrystals(0),fGeom(0),fPulseGenerator(0){
c0394bfb 53
54}
55//--------------------------------------------------------------------------------------
56AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(const AliPHOSRecoParam* parEmc, const AliPHOSRecoParam* parCpv):TObject(),
39569d36 57 fEmcMinE(0.),fCpvMinE(0.),fSampleQualityCut(1.),fEmcCrystals(0),fGeom(0),fPulseGenerator(0){
c0394bfb 58
59 if(!parEmc) AliFatal("Reconstruction parameters for EMC not set!");
60 if(!parCpv) AliFatal("Reconstruction parameters for CPV not set!");
61
62 fEmcMinE = parEmc->GetMinE();
63 fCpvMinE = parCpv->GetMinE();
64
70d93620 65 fSampleQualityCut = parEmc->GetSampleQualityCut() ;
66
c0394bfb 67 fGeom=AliPHOSGeometry::GetInstance() ;
68 if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
69
70 fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
71
39569d36 72 fPulseGenerator = new AliPHOSPulseGenerator();
73
c0394bfb 74 GetCalibrationParameters() ;
75}
76//--------------------------------------------------------------------------------------
77AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(const AliPHOSRawDigiProducer &dp):TObject(),
39569d36 78 fEmcMinE(0.),fCpvMinE(0.),fSampleQualityCut(1.),fEmcCrystals(0),fGeom(0),fPulseGenerator(0){
c0394bfb 79
80 fEmcMinE = dp.fEmcMinE ;
81 fCpvMinE = dp.fCpvMinE ;
82 fEmcCrystals = dp.fEmcCrystals ;
39569d36 83 fPulseGenerator = new AliPHOSPulseGenerator();
c0394bfb 84 fGeom = dp.fGeom ;
85}
86//--------------------------------------------------------------------------------------
87AliPHOSRawDigiProducer& AliPHOSRawDigiProducer::operator= (const AliPHOSRawDigiProducer &dp){
88 if(&dp == this) return *this;
89
90 fEmcMinE = dp.fEmcMinE ;
91 fCpvMinE = dp.fCpvMinE ;
70d93620 92 fSampleQualityCut = dp.fSampleQualityCut ;
c0394bfb 93 fEmcCrystals = dp.fEmcCrystals ;
94 fGeom = dp.fGeom ;
39569d36 95 if(fPulseGenerator) delete fPulseGenerator ;
96 fPulseGenerator = new AliPHOSPulseGenerator();
c0394bfb 97 return *this;
98}
39569d36 99//--------------------------------------------------------------------------------------
100AliPHOSRawDigiProducer::~AliPHOSRawDigiProducer(){
101 if(fPulseGenerator) delete fPulseGenerator ;
102 fPulseGenerator=0 ;
103}
7bc140a5 104//--------------------------------------------------------------------------------------
88fb5e50 105void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, AliPHOSRawDecoder* decoder)
106{
7bc140a5 107 //Makes the job.
108 //TClonesArray *digits and raw data decoder should be provided by calling function.
109
88fb5e50 110 digits->Clear();
111
88fb5e50 112 Int_t iDigit = 0 ;
88fb5e50 113 Int_t relId[4], absId =0;
114
c0394bfb 115 const Double_t baseLine=1. ; //Minimal energy of digit in ADC ch.
116 const Double_t highLowDiff=2. ; //Maximal difference between High and Low channels in LG adc channels
88fb5e50 117
c0394bfb 118 //Temporary array for LowGain digits
119 TClonesArray tmpLG("AliPHOSDigit",10000) ;
120 Int_t ilgDigit=0 ;
121
122 while (decoder->NextDigit()) {
34827459 123
c0394bfb 124 Double_t energy=decoder->GetEnergy() ;
125 if(energy<=baseLine) //in ADC channels
126 continue ;
1267d56d 127
70d93620 128 //remove digits with bas shape. Decoder should calculate quality so that
129 //in default case quality [0,1], while larger values of quality mean somehow
130 //corrupted samples, 999 means obviously corrupted sample.
131 if(decoder->GetSampleQuality() > fSampleQualityCut )
132 continue ;
133
c0394bfb 134 Bool_t lowGainFlag = decoder->IsLowGain();
88fb5e50 135
136 relId[0] = decoder->GetModule();
137 relId[1] = 0;
138 relId[2] = decoder->GetRow();
139 relId[3] = decoder->GetColumn();
c0394bfb 140 fGeom->RelToAbsNumbering(relId, absId);
141
142 Double_t time = decoder->GetTime() ;
143 time = CalibrateT(time,relId,lowGainFlag) ;
144
145 energy = CalibrateE(energy,relId,lowGainFlag) ;
146
147 if(energy <= 0.)
148 continue;
149
150 if(lowGainFlag){
7899109f 151 new(tmpLG[ilgDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
c0394bfb 152 ilgDigit++ ;
153 }
154 else{
155 if(decoder->IsOverflow()) //Keep this digit to replace it by Low Gain later.
156 //If there is no LogGain it wil be removed by cut on Min E
7899109f 157 new((*digits)[iDigit]) AliPHOSDigit(-1,absId,-1.f,(Float_t)time);
c0394bfb 158 else
7899109f 159 new((*digits)[iDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
160 iDigit++;
c0394bfb 161 }
162 }
163
164 //Now scan created LG and HG digits and keep only those which appeared in both lists
165 //replace energy of HighGain digits only if there is overflow
166 //negative energy (overflow)
167 digits->Sort() ;
168 tmpLG.Sort() ;
169 Int_t iLG = 0;
170 Int_t nLG1 = tmpLG.GetEntriesFast()-1 ;
39569d36 171
c0394bfb 172 for(Int_t iDig=0 ; iDig < digits->GetEntriesFast() ; iDig++) {
173 AliPHOSDigit * digHG = dynamic_cast<AliPHOSDigit*>(digits->At(iDig)) ;
7899109f 174 if (!digHG) continue;
c0394bfb 175 AliPHOSDigit * digLG = dynamic_cast<AliPHOSDigit*>(tmpLG.At(iLG)) ;
176 while(iLG<nLG1 && digHG->GetId()> digLG->GetId()){
177 iLG++ ;
178 digLG = dynamic_cast<AliPHOSDigit*>(tmpLG.At(iLG)) ;
179 }
7899109f 180 if(digLG && digHG->GetId() == digLG->GetId()){ //we found pair
c0394bfb 181 if(digHG->GetEnergy()<0.){ //This is overflow in HG
7899109f 182 digHG->SetTime(digLG->GetTime()) ;
183 digHG->SetEnergy(digLG->GetEnergy()) ;
c0394bfb 184 }
185 else{ //Make approximate comparison of HG and LG energies
186 Double_t de = (digHG->GetEnergy()-digLG->GetEnergy())/16./0.005 ; //aproximate difference in LG ADC ch.
187 if(TMath::Abs(de)>highLowDiff){ //too strong difference, remove digit
188 digits->RemoveAt(iDig) ;
88fb5e50 189 }
190 }
88fb5e50 191 }
c0394bfb 192 else{ //no pair - remove
193 // temporary fix for dead LG channels
194 Int_t absId=digHG->GetId() ;
195 Int_t relId[4] ;
196 fGeom->AbsToRelNumbering(absId,relId) ;
197 if(relId[2]%2==1 && relId[3]%16==4)
198 continue ;
39569d36 199 if(digHG->GetEnergy()>16*5*0.005) //LG too low to exist
200 digits->RemoveAt(iDig) ;
c0394bfb 201 }
202 }
203
204 CleanDigits(digits) ;
205
206}
207//____________________________________________________________________________
208Double_t AliPHOSRawDigiProducer::CalibrateE(Double_t amp, Int_t* relId, Bool_t isLowGain)
209{
210 // Convert EMC measured amplitude into real energy.
211 // Calibration parameters are taken from calibration data base for raw data,
212 // or from digitizer parameters for simulated data.
213 if(fgCalibData){
214 Int_t module = relId[0];
215 Int_t column = relId[3];
216 Int_t row = relId[2];
217 if(relId[1]==0) { // this is EMC
218 if(isLowGain){
219 amp*= fgCalibData->GetHighLowRatioEmc(module,column,row);
88fb5e50 220 }
c0394bfb 221 amp *= fgCalibData->GetADCchannelEmc(module,column,row);
222 return amp ;
223 }
224 }
225 return 0;
226}
227//____________________________________________________________________________
228Double_t AliPHOSRawDigiProducer::CalibrateT(Double_t time, Int_t * relId, Bool_t /* isLowGain */)
229{
230 //Calibrate time
39569d36 231 time*=fPulseGenerator->GetRawFormatTimeTrigger() ;
c0394bfb 232 if(fgCalibData){
233 Int_t module = relId[0];
234 Int_t column = relId[3];
235 Int_t row = relId[2];
236 if(relId[1]==0) { // this is EMC
237 time += fgCalibData->GetTimeShiftEmc(module,column,row);
238 return time ;
239 }
240 }
241
242 return -999.;
243}
244//____________________________________________________________________________
245void AliPHOSRawDigiProducer::CleanDigits(TClonesArray * digits)
246{
247 // remove digits with amplitudes below threshold.
248 // remove digits in bad channels
249 // sort digits with icreasing AbsId
250
251 //remove digits in bad map and below threshold
252 Bool_t isBadMap = 0 ;
253 if(fgCalibData->GetNumOfEmcBadChannels()){
254 isBadMap=1 ;
255 }
256
257 for(Int_t i=0; i<digits->GetEntriesFast(); i++){
258 AliPHOSDigit * digit = static_cast<AliPHOSDigit*>(digits->At(i)) ;
259 if(!digit)
260 continue ;
261 if ( (IsInEMC(digit) && digit->GetEnergy() < fEmcMinE) ||
262 (IsInCPV(digit) && digit->GetEnergy() < fCpvMinE) ){
263 digits->RemoveAt(i) ;
264 continue ;
265 }
266 if(isBadMap){ //check bad map now
267 Int_t relid[4] ;
268 fGeom->AbsToRelNumbering(digit->GetId(), relid) ;
269 if(fgCalibData->IsBadChannelEmc(relid[0],relid[2],relid[3])){
270 digits->RemoveAt(i) ;
88fb5e50 271 }
272 }
88fb5e50 273 }
274
c0394bfb 275 //Compress, sort and set indexes
276 digits->Compress() ;
277// digits->Sort(); already sorted earlier
278 for (Int_t i = 0 ; i < digits->GetEntriesFast() ; i++) {
279 AliPHOSDigit *digit = static_cast<AliPHOSDigit*>( digits->At(i) ) ;
280 digit->SetIndexInList(i) ;
281 }
282}
283//____________________________________________________________________________
284Bool_t AliPHOSRawDigiProducer::IsInEMC(AliPHOSDigit * digit) const
285{
286 // Tells if (true) or not (false) the digit is in a PHOS-EMC module
287 return digit->GetId() <= fEmcCrystals ;
288
289}
290
291//____________________________________________________________________________
292Bool_t AliPHOSRawDigiProducer::IsInCPV(AliPHOSDigit * digit) const
293{
294 // Tells if (true) or not (false) the digit is in a PHOS-CPV module
295 return digit->GetId() > fEmcCrystals ;
296}
297//____________________________________________________________________________
298void AliPHOSRawDigiProducer::GetCalibrationParameters()
299{
300 // Set calibration parameters:
301 // if calibration database exists, they are read from database,
302 // otherwise, reconstruction stops in the constructor of AliPHOSCalibData
303 //
304 // It is a user responsilibity to open CDB before reconstruction, for example:
305 // AliCDBStorage* storage = AliCDBManager::Instance()->GetStorage("local://CalibDB");
306
307 if (!fgCalibData){
308 fgCalibData = new AliPHOSCalibData(-1); //use AliCDBManager's run number
309 }
310 if (fgCalibData->GetCalibDataEmc() == 0)
311 AliFatal("Calibration parameters for PHOS EMC not found. Stop reconstruction.\n");
312 if (fgCalibData->GetCalibDataCpv() == 0)
313 AliFatal("Calibration parameters for PHOS CPV not found. Stop reconstruction.\n");
88fb5e50 314}