PHOS/PHOSbase/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   Int_t iDigit=0 ;
 172   Int_t relId[4], absId=-1, caloFlag=-1;
 173
 174   const Double_t baseLine=1. ; //Minimal energy of digit in ADC ch.
 175
 176   //Calculate conversion coeff. from Sample time step to seconds
 177   //If OCDB contains negative or zero value - use one from RCU trailer
 178   //Negative value in OCDB is used only for simulation of raw digits
 179   if(fgCalibData->GetSampleTimeStep()>0.)
 180     fSampleToSec=fgCalibData->GetSampleTimeStep() ;
 181   else
 182     fSampleToSec=fRawStream->GetTSample() ;
 183
 184   // Clear a temporary array for LowGain digits
 185   tmpDigLG->Clear();
 186   Int_t ilgDigit=0 ;
 187
 188   //Let fitter subtract pedestals in case of ZS
 189   fitter->SetCalibData(fgCalibData) ;
 190
 191   while (fRawStream->NextDDL()) {
 192     while (fRawStream->NextChannel()) {
 193       relId[0] = 5 - fRawStream->GetModule() ; // counts from 1 to 5
 194       relId[1] = 0;                            // 0=EMC
 195       relId[2] = fRawStream->GetCellX()  + 1;  // counts from 1 to 64
 196       relId[3] = fRawStream->GetCellZ()  + 1;  // counts from 1 to 56
 197       caloFlag = fRawStream->GetCaloFlag();    // 0=LG, 1=HG, 2=TRU
 198
 199       if(caloFlag!=0 && caloFlag!=1) continue; //TRU data!
 200
 201       fitter->SetChannelGeo(relId[0],relId[2],relId[3],caloFlag);
 202
 203       if(fitter->GetAmpOffset()==0 && fitter->GetAmpThreshold()==0) {
 204         short value = fRawStream->GetAltroCFG1();
 205         bool ZeroSuppressionEnabled = (value >> 15) & 0x1;
 206         if(ZeroSuppressionEnabled) {
 207           short offset = (value >> 10) & 0xf;
 208           short threshold = value & 0x3ff;
 209           fitter->SubtractPedestals(kFALSE);
 210           fitter->SetAmpOffset(offset);
 211           fitter->SetAmpThreshold(threshold);
 212         }
 213       }
 214
 215       fGeom->RelToAbsNumbering(relId, absId);
 216
 217       fitter->SetNBunches(0);
 218       Int_t sigStart =0 ;
 219       Int_t sigLength=0 ;
 220       while (fRawStream->NextBunch()) { //Take the first in time bunch
 221         const UShort_t *sig = fRawStream->GetSignals();
 222         sigStart  = fRawStream->GetStartTimeBin();
 223         sigLength = fRawStream->GetBunchLength();
 224         fitter->Eval(sig,sigStart,sigLength);
 225         if      (caloFlag == AliCaloRawStreamV3::kLowGain) {
 226           delete [] fADCValuesLG;
 227           fADCValuesLG = new Int_t[sigLength];
 228           for (Int_t i=0; i<sigLength; i++)
 229             fADCValuesLG[sigLength-i-1] = sig[i];
 230         }
 231         else if (caloFlag == AliCaloRawStreamV3::kHighGain) {
 232           delete [] fADCValuesHG;
 233           fADCValuesHG = new Int_t[sigLength];
 234           for (Int_t i=0; i<sigLength; i++)
 235             fADCValuesHG[sigLength-i-1] = sig[i];
 236         }
 237       } // End of NextBunch()
 238
 239
 240       Double_t energy = fitter->GetEnergy() ;
 241       Double_t time   = fitter->GetTime() ;
 242       if(energy<=baseLine) //in ADC channels
 243         continue ;
 244
 245       //remove digits with bad shape. Fitter should calculate quality so that
 246       //in default case quality [0,1], while larger values of quality mean somehow
 247       //corrupted samples, 999 means obviously corrupted sample.
 248       //It is difficult to fit samples with overflow (even setting cut on overflow values)
 249       //because too few points are left to fit. So we do not evaluate samples with overflow
 250
 251       if(fitter->GetSignalQuality() > fSampleQualityCut && !(fitter->IsOverflow()))
 252         continue ;
 253
 254       energy = CalibrateE(energy,relId,!caloFlag) ;
 255
 256       //convert time from sample bin units to s
 257       time*=fSampleToSec ;
 258 //CalibrateT moved to Clusterizer
 259 //      time = CalibrateT(time,relId,!caloFlag) ;
 260       // subtract RCU L1 phase (L1Phase is in seconds) w.r.t. L0:
 261       //Very strange behaviour of electronics, but cross-checkes several times...
 262       if( fRawStream->GetL1Phase()<55.*1.e-9 ) //for phase=0,25,50
 263         time -= fRawStream->GetL1Phase();
 264       else //for phase 75
 265         time += 25.*1.e-9 ;
 266
 267       if(energy <= 0.)
 268         continue;
 269
 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);
 274         ilgDigit++ ;
 275       }
 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);
 280         else
 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);
 284         iDigit++;
 285       }
 286     } // End of NextChannel()
 287
 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)
 291     digits->Sort() ;
 292     tmpDigLG->Sort() ;
 293     Int_t iLG = 0;
 294     Int_t nLG1 = tmpDigLG->GetEntriesFast()-1 ;
 295
 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()){
 301         iLG++ ;
 302         digLG = dynamic_cast<AliPHOSDigit*>(tmpDigLG->At(iLG)) ;
 303       }
 304       absId=digHG->GetId() ;
 305       fGeom->AbsToRelNumbering(absId,relId) ;
 306
 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()) ;
 311           digHG->SetLG(kTRUE) ;
 312         }
 313       }
 314       else{ //no pair - remove
 315         if(digHG->GetEnergy()<0.) //no pair, in saturation
 316           digits->RemoveAt(iDig) ;
 317       }
 318     }
 319   } // End of NextDDL()
 320
 321   CleanDigits(digits) ;
 322
 323 }
 324 //____________________________________________________________________________
 325 Double_t AliPHOSRawDigiProducer::CalibrateE(Double_t amp, Int_t* relId, Bool_t isLowGain)
 326 {
 327   // Convert EMC LG amplitude to HG (multipli by ~16)
 328   // Calibration parameters are taken from calibration data base
 329   if(fgCalibData){
 330     Int_t   module = relId[0];
 331     Int_t   column = relId[3];
 332     Int_t   row    = relId[2];
 333     if(relId[1]==0) { // this is EMC
 334       if(isLowGain){
 335         amp*= fgCalibData->GetHighLowRatioEmc(module,column,row);
 336       }
 337       return amp ;
 338     }
 339   }
 340   return 0;
 341 }
 342 //____________________________________________________________________________
 343 Double_t AliPHOSRawDigiProducer::CalibrateT(Double_t time, Int_t * relId, Bool_t /* isLowGain */)
 344 {
 345   //Calibrate time
 346   if(fgCalibData){
 347     Int_t   module = relId[0];
 348     Int_t   column = relId[3];
 349     Int_t   row    = relId[2];
 350     if(relId[1]==0) { // this is EMC
 351       time += fgCalibData->GetTimeShiftEmc(module,column,row);
 352       return time ;
 353     }
 354   }
 355
 356   return -999.;
 357 }
 358 //____________________________________________________________________________
 359 void AliPHOSRawDigiProducer::CleanDigits(TClonesArray * digits)
 360 {
 361   // remove digits with amplitudes below threshold.
 362   // remove digits in bad channels
 363   // sort digits with icreasing AbsId
 364
 365   //remove digits in bad map and below threshold
 366   Bool_t isBadMap = 0 ;
 367   if(fgCalibData->GetNumOfEmcBadChannels()){
 368     isBadMap=1 ;
 369   }
 370
 371   for(Int_t i=0; i<digits->GetEntriesFast(); i++){
 372     AliPHOSDigit * digit = static_cast<AliPHOSDigit*>(digits->At(i)) ;
 373     if(!digit)
 374       continue  ;
 375     if ( (IsInEMC(digit) && digit->GetEnergy() < fEmcMinE) ||
 376          (IsInCPV(digit) && digit->GetEnergy() < fCpvMinE) ){
 377       digits->RemoveAt(i) ;
 378       continue ;
 379     }
 380     if(isBadMap){ //check bad map now
 381       Int_t relid[4] ;
 382       fGeom->AbsToRelNumbering(digit->GetId(), relid) ;
 383       if(fgCalibData->IsBadChannelEmc(relid[0],relid[3],relid[2])){
 384         digits->RemoveAt(i) ;
 385       }
 386     }
 387   }
 388
 389   //Compress, sort and set indexes
 390   digits->Compress() ;
 391 //  digits->Sort(); already sorted earlier
 392   for (Int_t i = 0 ; i < digits->GetEntriesFast() ; i++) {
 393     AliPHOSDigit *digit = static_cast<AliPHOSDigit*>( digits->At(i) ) ;
 394     digit->SetIndexInList(i) ;
 395   }
 396 }
 397 //____________________________________________________________________________
 398 Bool_t AliPHOSRawDigiProducer::IsInEMC(AliPHOSDigit * digit) const
 399 {
 400   // Tells if (true) or not (false) the digit is in a PHOS-EMC module
 401   return digit->GetId() <= fEmcCrystals ;
 402
 403 }
 404
 405 //____________________________________________________________________________
 406 Bool_t AliPHOSRawDigiProducer::IsInCPV(AliPHOSDigit * digit) const
 407 {
 408   // Tells if (true) or not (false) the digit is in a PHOS-CPV module
 409   return digit->GetId() > fEmcCrystals ;
 410 }
 411 //____________________________________________________________________________
 412 void AliPHOSRawDigiProducer::GetCalibrationParameters()
 413 {
 414   // Set calibration parameters:
 415   // if calibration database exists, they are read from database,
 416   // otherwise, reconstruction stops in the constructor of AliPHOSCalibData
 417   //
 418   // It is a user responsilibity to open CDB before reconstruction, for example:
 419   // AliCDBStorage* storage = AliCDBManager::Instance()->GetStorage("local://CalibDB");
 420
 421   if (!fgCalibData){
 422     fgCalibData = new AliPHOSCalibData(-1); //use AliCDBManager's run number
 423   }
 424   if (fgCalibData->GetCalibDataEmc() == 0)
 425     AliFatal("Calibration parameters for PHOS EMC not found. Stop reconstruction.\n");
 426   if (fgCalibData->GetCalibDataCpv() == 0)
 427     AliFatal("Calibration parameters for PHOS CPV not found. Stop reconstruction.\n");
 428 }