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