macros to produce new T0 Reco Param
[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
379c5c09 19//using AliPHOSRawFitter.
7bc140a5 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"
379c5c09 37#include "AliPHOSRawFitterv0.h"
88fb5e50 38#include "AliPHOSGeometry.h"
39#include "AliPHOSDigit.h"
c0394bfb 40#include "AliPHOSCalibData.h"
39569d36 41#include "AliPHOSPulseGenerator.h"
379c5c09 42#include "AliCaloRawStreamV3.h"
c0394bfb 43#include "AliLog.h"
88fb5e50 44
45ClassImp(AliPHOSRawDigiProducer)
46
c0394bfb 47AliPHOSCalibData * AliPHOSRawDigiProducer::fgCalibData = 0 ;
48
49//--------------------------------------------------------------------------------------
7e88424f 50AliPHOSRawDigiProducer::AliPHOSRawDigiProducer():
51 TObject(),
52 fEmcMinE(0.),
53 fCpvMinE(0.),
54 fSampleQualityCut(1.),
55 fEmcCrystals(0),
56 fGeom(0),
379c5c09 57 fPulseGenerator(0),
58 fRawReader(0),
59 fRawStream(0)
7e88424f 60{
61 // Default constructor
70d93620 62
c0394bfb 63 fGeom=AliPHOSGeometry::GetInstance() ;
64 if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
65
66 fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
39569d36 67 fPulseGenerator = new AliPHOSPulseGenerator();
c0394bfb 68 GetCalibrationParameters() ;
8be3a30a 69
c0394bfb 70}
379c5c09 71//--------------------------------------------------------------------------------------
72AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(AliRawReader *rawReader,
73 AliAltroMapping **mapping):
74 TObject(),
75 fEmcMinE(0.),
76 fCpvMinE(0.),
77 fSampleQualityCut(1.),
78 fEmcCrystals(0),
79 fGeom(0),
80 fPulseGenerator(0),
81 fRawReader(rawReader),
82 fRawStream(0)
83{
84 // Default constructor
85
86 fGeom=AliPHOSGeometry::GetInstance() ;
87 if(!fGeom) fGeom = AliPHOSGeometry::GetInstance("IHEP");
88
89 fEmcCrystals=fGeom->GetNCristalsInModule()*fGeom->GetNModules() ;
90 fPulseGenerator = new AliPHOSPulseGenerator();
91 GetCalibrationParameters() ;
92
93 fRawStream = new AliCaloRawStreamV3(rawReader,"PHOS",mapping);
94
95}
96//--------------------------------------------------------------------------------------
7e88424f 97AliPHOSRawDigiProducer::AliPHOSRawDigiProducer(const AliPHOSRawDigiProducer &dp):
98 TObject(),
99 fEmcMinE(0.),
100 fCpvMinE(0.),
101 fSampleQualityCut(1.),
102 fEmcCrystals(0),
103 fGeom(0),
379c5c09 104 fPulseGenerator(0),
105 fRawReader(0),
106 fRawStream(0)
7e88424f 107{
108 // Copy constructor
c0394bfb 109
110 fEmcMinE = dp.fEmcMinE ;
111 fCpvMinE = dp.fCpvMinE ;
f78c9781 112 fSampleQualityCut = dp.fSampleQualityCut;
c0394bfb 113 fEmcCrystals = dp.fEmcCrystals ;
39569d36 114 fPulseGenerator = new AliPHOSPulseGenerator();
c0394bfb 115 fGeom = dp.fGeom ;
116}
117//--------------------------------------------------------------------------------------
7e88424f 118AliPHOSRawDigiProducer& AliPHOSRawDigiProducer::operator= (const AliPHOSRawDigiProducer &dp)
119{
120 // Assign operator
121
c0394bfb 122 if(&dp == this) return *this;
123
124 fEmcMinE = dp.fEmcMinE ;
125 fCpvMinE = dp.fCpvMinE ;
70d93620 126 fSampleQualityCut = dp.fSampleQualityCut ;
c0394bfb 127 fEmcCrystals = dp.fEmcCrystals ;
128 fGeom = dp.fGeom ;
39569d36 129 if(fPulseGenerator) delete fPulseGenerator ;
130 fPulseGenerator = new AliPHOSPulseGenerator();
c0394bfb 131 return *this;
132}
379c5c09 133//--------------------------------------------------------------------------------------
7e88424f 134AliPHOSRawDigiProducer::~AliPHOSRawDigiProducer()
135{
379c5c09 136 // Destructor
7e88424f 137 if(fPulseGenerator) delete fPulseGenerator ;
138 fPulseGenerator=0 ;
379c5c09 139 delete fRawStream;
39569d36 140}
7bc140a5 141//--------------------------------------------------------------------------------------
379c5c09 142void AliPHOSRawDigiProducer::MakeDigits(TClonesArray *digits, AliPHOSRawFitterv0* fitter)
88fb5e50 143{
7bc140a5 144 //Makes the job.
379c5c09 145 //TClonesArray *digits and raw data fitter should be provided by calling function.
7bc140a5 146
88fb5e50 147 digits->Clear();
148
379c5c09 149 Int_t iDigit=0 ;
150 Int_t relId[4], absId=-1, caloFlag=-1;
fdd91c5a 151
c0394bfb 152 const Double_t baseLine=1. ; //Minimal energy of digit in ADC ch.
fdd91c5a 153
c0394bfb 154 //Temporary array for LowGain digits
155 TClonesArray tmpLG("AliPHOSDigit",10000) ;
156 Int_t ilgDigit=0 ;
bafc1087 157
379c5c09 158 //Let fitter subtract pedestals in case of ZS
159 fitter->SetCalibData(fgCalibData) ;
c0394bfb 160
379c5c09 161 while (fRawStream->NextDDL()) {
162 while (fRawStream->NextChannel()) {
1281504a 163 relId[0] = fRawStream->GetModule() + 1; // counts from 1 to 5
379c5c09 164 relId[1] = 0;
1281504a 165 relId[2] = fRawStream->GetCellX() + 1; // counts from 1 to 64
166 relId[3] = fRawStream->GetCellZ() + 1; // counts from 1 to 56
167 caloFlag = fRawStream->GetCaloFlag(); // 0=LG, 1=HG, 2=TRU
f4ca5622 168
169 if(caloFlag!=0 && caloFlag!=1) continue; //TRU data!
170
379c5c09 171 fGeom->RelToAbsNumbering(relId, absId);
f4ca5622 172
379c5c09 173 Int_t nBunches = 0;
174 while (fRawStream->NextBunch()) {
175 nBunches++;
176 if (nBunches > 1) continue;
177 const UShort_t *sig = fRawStream->GetSignals();
178 Int_t sigStart = fRawStream->GetStartTimeBin();
179 Int_t sigLength = fRawStream->GetBunchLength();
92236b27 180 fitter->SetChannelGeo(relId[0],relId[2],relId[3],caloFlag);
181 fitter->Eval(sig,sigStart,sigLength);
379c5c09 182 } // End of NextBunch()
70d93620 183
379c5c09 184 fitter->SetNBunches(nBunches);
379c5c09 185
186 Double_t energy = fitter->GetEnergy() ;
187 Double_t time = fitter->GetTime() ;
188 if(energy<=baseLine) //in ADC channels
189 continue ;
88fb5e50 190
379c5c09 191 //remove digits with bad shape. Fitter should calculate quality so that
192 //in default case quality [0,1], while larger values of quality mean somehow
193 //corrupted samples, 999 means obviously corrupted sample.
194 //It is difficult to fit samples with overflow (even setting cut on overflow values)
195 //because too few points are left to fit. So we do not evaluate samples with overflow
c0394bfb 196
379c5c09 197 if(fitter->GetSignalQuality() > fSampleQualityCut && !(fitter->IsOverflow()))
198 continue ;
199
200// energy = CalibrateE(energy,relId,lowGainFlag) ;
201// time = CalibrateT(time,relId,lowGainFlag) ;
202
203 if(energy <= 0.)
204 continue;
205
206 if (caloFlag == AliCaloRawStreamV3::kLowGain) {
207 new(tmpLG[ilgDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
208 ilgDigit++ ;
209 }
210 else if (caloFlag == AliCaloRawStreamV3::kHighGain) {
211 if(fitter->IsOverflow()) //Keep this digit to replace it by Low Gain later.
212 //If there is no LogGain it wil be removed by cut on Min E
213 new((*digits)[iDigit]) AliPHOSDigit(-1,absId,-1.f,(Float_t)time);
214 else
215 new((*digits)[iDigit]) AliPHOSDigit(-1,absId,(Float_t)energy,(Float_t)time);
216 iDigit++;
217 }
218 } // End of NextChannel()
c0394bfb 219
379c5c09 220 //Now scan created LG and HG digits and keep only those which appeared in both lists
221 //replace energy of HighGain digits only if there is overflow
222 //negative energy (overflow)
223 digits->Sort() ;
224 tmpLG.Sort() ;
225 Int_t iLG = 0;
226 Int_t nLG1 = tmpLG.GetEntriesFast()-1 ;
227
228 for(Int_t iDig=0 ; iDig < digits->GetEntriesFast() ; iDig++) {
229 AliPHOSDigit * digHG = dynamic_cast<AliPHOSDigit*>(digits->At(iDig)) ;
230 if (!digHG) continue;
231 AliPHOSDigit * digLG = dynamic_cast<AliPHOSDigit*>(tmpLG.At(iLG)) ;
232 while(digLG && iLG<nLG1 && digHG->GetId()> digLG->GetId()){
233 iLG++ ;
234 digLG = dynamic_cast<AliPHOSDigit*>(tmpLG.At(iLG)) ;
235 }
236 absId=digHG->GetId() ;
237 fGeom->AbsToRelNumbering(absId,relId) ;
a7c985dc 238
379c5c09 239 if(digLG && digHG->GetId() == digLG->GetId()){ //we found pair
240 if(digHG->GetEnergy()<0.){ //This is overflow in HG
241 digHG->SetTime(digLG->GetTime()) ;
242 digHG->SetEnergy(digLG->GetEnergy()) ;
243 }
379c5c09 244 }
245 else{ //no pair - remove
fdd91c5a 246 if(digHG->GetEnergy()<0.) //no pair, in saturation
247 digits->RemoveAt(iDig) ;
88fb5e50 248 }
88fb5e50 249 }
379c5c09 250 } // End of NextDDL()
c0394bfb 251
252 CleanDigits(digits) ;
379c5c09 253
c0394bfb 254}
255//____________________________________________________________________________
256Double_t AliPHOSRawDigiProducer::CalibrateE(Double_t amp, Int_t* relId, Bool_t isLowGain)
257{
634d2178 258 // Convert EMC LG amplitude to HG (multipli by ~16)
259 // Calibration parameters are taken from calibration data base
c0394bfb 260 if(fgCalibData){
261 Int_t module = relId[0];
262 Int_t column = relId[3];
263 Int_t row = relId[2];
264 if(relId[1]==0) { // this is EMC
265 if(isLowGain){
266 amp*= fgCalibData->GetHighLowRatioEmc(module,column,row);
88fb5e50 267 }
c0394bfb 268 return amp ;
269 }
270 }
271 return 0;
272}
273//____________________________________________________________________________
274Double_t AliPHOSRawDigiProducer::CalibrateT(Double_t time, Int_t * relId, Bool_t /* isLowGain */)
275{
276 //Calibrate time
39569d36 277 time*=fPulseGenerator->GetRawFormatTimeTrigger() ;
c0394bfb 278 if(fgCalibData){
279 Int_t module = relId[0];
280 Int_t column = relId[3];
281 Int_t row = relId[2];
282 if(relId[1]==0) { // this is EMC
283 time += fgCalibData->GetTimeShiftEmc(module,column,row);
284 return time ;
285 }
286 }
287
288 return -999.;
289}
290//____________________________________________________________________________
291void AliPHOSRawDigiProducer::CleanDigits(TClonesArray * digits)
292{
293 // remove digits with amplitudes below threshold.
294 // remove digits in bad channels
295 // sort digits with icreasing AbsId
296
297 //remove digits in bad map and below threshold
298 Bool_t isBadMap = 0 ;
299 if(fgCalibData->GetNumOfEmcBadChannels()){
300 isBadMap=1 ;
301 }
302
303 for(Int_t i=0; i<digits->GetEntriesFast(); i++){
304 AliPHOSDigit * digit = static_cast<AliPHOSDigit*>(digits->At(i)) ;
305 if(!digit)
306 continue ;
307 if ( (IsInEMC(digit) && digit->GetEnergy() < fEmcMinE) ||
308 (IsInCPV(digit) && digit->GetEnergy() < fCpvMinE) ){
309 digits->RemoveAt(i) ;
310 continue ;
311 }
312 if(isBadMap){ //check bad map now
313 Int_t relid[4] ;
314 fGeom->AbsToRelNumbering(digit->GetId(), relid) ;
a65517aa 315 if(fgCalibData->IsBadChannelEmc(relid[0],relid[3],relid[2])){
c0394bfb 316 digits->RemoveAt(i) ;
88fb5e50 317 }
318 }
88fb5e50 319 }
320
c0394bfb 321 //Compress, sort and set indexes
322 digits->Compress() ;
323// digits->Sort(); already sorted earlier
324 for (Int_t i = 0 ; i < digits->GetEntriesFast() ; i++) {
325 AliPHOSDigit *digit = static_cast<AliPHOSDigit*>( digits->At(i) ) ;
326 digit->SetIndexInList(i) ;
327 }
328}
329//____________________________________________________________________________
330Bool_t AliPHOSRawDigiProducer::IsInEMC(AliPHOSDigit * digit) const
331{
332 // Tells if (true) or not (false) the digit is in a PHOS-EMC module
333 return digit->GetId() <= fEmcCrystals ;
334
335}
336
337//____________________________________________________________________________
338Bool_t AliPHOSRawDigiProducer::IsInCPV(AliPHOSDigit * digit) const
339{
340 // Tells if (true) or not (false) the digit is in a PHOS-CPV module
341 return digit->GetId() > fEmcCrystals ;
342}
343//____________________________________________________________________________
344void AliPHOSRawDigiProducer::GetCalibrationParameters()
345{
346 // Set calibration parameters:
347 // if calibration database exists, they are read from database,
348 // otherwise, reconstruction stops in the constructor of AliPHOSCalibData
349 //
350 // It is a user responsilibity to open CDB before reconstruction, for example:
351 // AliCDBStorage* storage = AliCDBManager::Instance()->GetStorage("local://CalibDB");
352
353 if (!fgCalibData){
354 fgCalibData = new AliPHOSCalibData(-1); //use AliCDBManager's run number
355 }
356 if (fgCalibData->GetCalibDataEmc() == 0)
357 AliFatal("Calibration parameters for PHOS EMC not found. Stop reconstruction.\n");
358 if (fgCalibData->GetCalibDataCpv() == 0)
359 AliFatal("Calibration parameters for PHOS CPV not found. Stop reconstruction.\n");
88fb5e50 360}