EMCAL/AliEMCALClusterizerNxN.cxx

   1 /**************************************************************************
   2  * Copyright(c) 1998-1999, 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 // This class derives from AliEMCALClustrerizer but also keeps the API of AliEMCALClusterizerv1
  17 // Algorithm:
  18 // 1. peek the most energetic cell
  19 // 2. assign it as a center of the cluster and add cells surrounding it: 3x3, 5x5...
  20 // 3. remove the cells contributing to the cluster
  21 // 4. start from 1 for the remaining clusters
  22 // 5. cluster splitting (not implemented yet) - use the shape analysis to resolve the energy sharing
  23 // - for high energy clusters check the surrounding of the 3x3 clusters for extra energy
  24 // (merge 3x3 clusters and resolve the internal energy sharing - case for 2 clusters merged)
  25 // Use Case:
  26 //  root [0] AliEMCALClusterizerNxN * cl = new AliEMCALClusterizerNxN("galice.root")
  27 //  Warning in <TDatabasePDG::TDatabasePDG>: object already instantiated
  28 //               //reads gAlice from header file "..."
  29 //  root [1] cl->ExecuteTask()
  30 //               //finds RecPoints in all events stored in galice.root
  31 //  root [2] cl->SetDigitsBranch("digits2")
  32 //               //sets another title for Digitis (input) branch
  33 //  root [3] cl->SetRecPointsBranch("recp2")
  34 //               //sets another title four output branches
  35 //  root [4] cl->SetTowerLocalMaxCut(0.03)
  36 //               //set clusterization parameters
  37 //  root [5] cl->ExecuteTask("deb all time")
  38 //               //once more finds RecPoints options are
  39 //               // deb - print number of found rec points
  40 //               // deb all - print number of found RecPoints and some their characteristics
  41 //               // time - print benchmarking results
  42
  43 // --- ROOT system ---
  44 #include <TMath.h>
  45 #include <TMinuit.h>
  46 #include <TTree.h>
  47 #include <TBenchmark.h>
  48 #include <TBrowser.h>
  49 #include <TROOT.h>
  50 #include <TClonesArray.h>
  51
  52 // --- Standard library ---
  53 #include <cassert>
  54
  55 // --- AliRoot header files ---
  56 #include "AliLog.h"
  57 #include "AliEMCALClusterizerNxN.h"
  58 #include "AliEMCALRecPoint.h"
  59 #include "AliEMCALDigit.h"
  60 #include "AliEMCALGeometry.h"
  61 #include "AliCaloCalibPedestal.h"
  62 #include "AliEMCALCalibData.h"
  63 #include "AliESDCaloCluster.h"
  64 #include "AliEMCALUnfolding.h"
  65
  66 ClassImp(AliEMCALClusterizerNxN)
  67
  68 Bool_t AliEMCALClusterizerNxN::fgkIsInputCalibrated = kFALSE;
  69
  70 //____________________________________________________________________________
  71 AliEMCALClusterizerNxN::AliEMCALClusterizerNxN()
  72   : AliEMCALClusterizer()
  73 {
  74   // ctor with the indication of the file where header Tree and digits Tree are stored
  75 }
  76
  77 //____________________________________________________________________________
  78 AliEMCALClusterizerNxN::AliEMCALClusterizerNxN(AliEMCALGeometry* geometry)
  79   : AliEMCALClusterizer(geometry)
  80 {
  81   // ctor with the indication of the file where header Tree and digits Tree are stored
  82   // use this contructor to avoid usage of Init() which uses runloader
  83   // change needed by HLT - MP
  84
  85 }
  86
  87 //____________________________________________________________________________
  88 AliEMCALClusterizerNxN::AliEMCALClusterizerNxN(AliEMCALGeometry* geometry, AliEMCALCalibData * calib, AliCaloCalibPedestal * caloped)
  89 : AliEMCALClusterizer(geometry, calib, caloped)
  90 {
  91         // ctor, geometry and calibration are initialized elsewhere.
  92
  93 }
  94
  95
  96 //____________________________________________________________________________
  97   AliEMCALClusterizerNxN::~AliEMCALClusterizerNxN()
  98 {
  99   // dtor
 100 }
 101
 102
 103 //____________________________________________________________________________
 104 void AliEMCALClusterizerNxN::Digits2Clusters(Option_t * option)
 105 {
 106   // Steering method to perform clusterization for the current event
 107   // in AliEMCALLoader
 108
 109   if(strstr(option,"tim"))
 110     gBenchmark->Start("EMCALClusterizer");
 111
 112   if(strstr(option,"print"))
 113     Print("") ;
 114
 115   //Get calibration parameters from file or digitizer default values.
 116   GetCalibrationParameters() ;
 117
 118   //Get dead channel map from file or digitizer default values.
 119   GetCaloCalibPedestal() ;
 120
 121   fNumberOfECAClusters = 0;
 122
 123   MakeClusters() ;  //only the real clusters
 124
 125   if(fToUnfold){
 126     fClusterUnfolding->SetInput(fNumberOfECAClusters,fRecPoints,fDigitsArr);
 127     fClusterUnfolding->MakeUnfolding();
 128   }
 129
 130   //Evaluate position, dispersion and other RecPoint properties for EC section
 131   Int_t index ;
 132   for(index = 0; index < fRecPoints->GetEntries(); index++)
 133   {
 134     AliEMCALRecPoint * rp = dynamic_cast<AliEMCALRecPoint *>(fRecPoints->At(index));
 135     if(rp){
 136       rp->EvalAll(fECAW0,fDigitsArr) ;
 137       AliDebug(5, Form("MAX INDEX %d ", rp->GetMaximalEnergyIndex()));
 138       //For each rec.point set the distance to the nearest bad crystal
 139       rp->EvalDistanceToBadChannels(fCaloPed);
 140     }
 141   }
 142
 143   fRecPoints->Sort() ;
 144
 145   for(index = 0; index < fRecPoints->GetEntries(); index++)
 146   {
 147     AliEMCALRecPoint * rp = dynamic_cast<AliEMCALRecPoint *>(fRecPoints->At(index));
 148     if(rp){
 149       rp->SetIndexInList(index) ;
 150       rp->Print();
 151     }
 152     else AliFatal("RecPoint NULL!!");
 153   }
 154
 155   fTreeR->Fill();
 156
 157   if(strstr(option,"deb") || strstr(option,"all"))
 158     PrintRecPoints(option) ;
 159
 160   AliDebug(1,Form("EMCAL Clusterizer found %d Rec Points",fRecPoints->GetEntriesFast()));
 161
 162   fRecPoints->Delete();
 163
 164   if(strstr(option,"tim")){
 165     gBenchmark->Stop("EMCALClusterizer");
 166     printf("Exec took %f seconds for Clusterizing",
 167            gBenchmark->GetCpuTime("EMCALClusterizer"));
 168   }
 169 }
 170
 171 //____________________________________________________________________________
 172 Int_t AliEMCALClusterizerNxN::AreNeighbours(AliEMCALDigit * d1, AliEMCALDigit * d2, Bool_t & shared) const
 173 {
 174   // Gives the neighbourness of two digits = 0 are not neighbour ; continue searching
 175   //                                       = 1 are neighbour
 176   //                                       = 2 is in different SM; continue searching
 177   // In case it is in different SM, but same phi rack, check if neigbours at eta=0
 178   // neighbours are defined as digits having at least a common side
 179   // The order of d1 and d2 is important: first (d1) should be a digit already in a cluster
 180   //                                      which is compared to a digit (d2)  not yet in a cluster
 181
 182   static Int_t nSupMod1=0, nModule1=0, nIphi1=0, nIeta1=0, iphi1=0, ieta1=0;
 183   static Int_t nSupMod2=0, nModule2=0, nIphi2=0, nIeta2=0, iphi2=0, ieta2=0;
 184   static Int_t rowdiff=0, coldiff=0;
 185
 186   shared = kFALSE;
 187
 188   fGeom->GetCellIndex(d1->GetId(), nSupMod1,nModule1,nIphi1,nIeta1);
 189   fGeom->GetCellIndex(d2->GetId(), nSupMod2,nModule2,nIphi2,nIeta2);
 190   fGeom->GetCellPhiEtaIndexInSModule(nSupMod1,nModule1,nIphi1,nIeta1, iphi1,ieta1);
 191   fGeom->GetCellPhiEtaIndexInSModule(nSupMod2,nModule2,nIphi2,nIeta2, iphi2,ieta2);
 192
 193   //If different SM, check if they are in the same phi, then consider cells close to eta=0 as neighbours; May 2010
 194   if(nSupMod1 != nSupMod2 )
 195     {
 196       //Check if the 2 SM are in the same PHI position (0,1), (2,3), ...
 197       Float_t smPhi1 = fGeom->GetEMCGeometry()->GetPhiCenterOfSM(nSupMod1);
 198       Float_t smPhi2 = fGeom->GetEMCGeometry()->GetPhiCenterOfSM(nSupMod2);
 199
 200       if(!TMath::AreEqualAbs(smPhi1, smPhi2, 1e-3)) return 2; //Not phi rack equal, not neighbours
 201
 202       // In case of a shared cluster, index of SM in C side, columns start at 48 and ends at 48*2
 203       // C Side impair SM, nSupMod%2=1; A side pair SM nSupMod%2=0
 204       if(nSupMod1%2) ieta1+=AliEMCALGeoParams::fgkEMCALCols;
 205       else           ieta2+=AliEMCALGeoParams::fgkEMCALCols;
 206
 207       shared = kTRUE; // maybe a shared cluster, we know this later, set it for the moment.
 208
 209     }//Different SM, same phi
 210
 211   rowdiff = TMath::Abs(iphi1 - iphi2);
 212   coldiff = TMath::Abs(ieta1 - ieta2) ;
 213
 214   // neighbours +-1 in col and row
 215   if ( TMath::Abs(coldiff) < 2 && TMath::Abs(rowdiff) < 2)
 216     {
 217
 218       AliDebug(9, Form("AliEMCALClusterizerNxN::AreNeighbours(): id1=%d, (row %d, col %d) ; id2=%d, (row %d, col %d), shared %d \n",
 219                        d1->GetId(), iphi1,ieta1, d2->GetId(), iphi2,ieta2, shared));
 220
 221       return 1;
 222     }//Neighbours
 223   else
 224     {
 225       AliDebug(9, Form("NOT AliEMCALClusterizerNxN::AreNeighbours(): id1=%d, (row %d, col %d) ; id2=%d, (row %d, col %d), shared %d \n",
 226                        d1->GetId(), iphi1,ieta1, d2->GetId(), iphi2,ieta2, shared));
 227       shared = kFALSE;
 228       return 2 ;
 229     }//Not neighbours
 230 }
 231
 232 //____________________________________________________________________________
 233 void AliEMCALClusterizerNxN::MakeClusters()
 234 {
 235   // Steering method to construct the clusters stored in a list of Reconstructed Points
 236   // A cluster is defined as a list of neighbour digits
 237   // Mar 03, 2007 by PAI
 238
 239   if (fGeom==0) AliFatal("Did not get geometry from EMCALLoader");
 240
 241   fRecPoints->Clear();
 242
 243   // Set up TObjArray with pointers to digits to work on
 244   //TObjArray *digitsC = new TObjArray();
 245   TObjArray digitsC;
 246   TIter nextdigit(fDigitsArr);
 247   AliEMCALDigit *digit = 0;
 248   while ( (digit = dynamic_cast<AliEMCALDigit*>(nextdigit())) ) {
 249     digitsC.AddLast(digit);
 250   }
 251
 252   TIter nextdigitC(&digitsC);
 253
 254   AliDebug(1,Form("MakeClusters: Number of digits %d  -> (e %f)\n",
 255                   fDigitsArr->GetEntries(),fMinECut));
 256
 257   Bool_t bDone = kFALSE;
 258   while ( bDone != kTRUE )
 259   {
 260     //first sort the digits:
 261     Int_t iMaxEnergyDigit = -1;
 262     Float_t dMaxEnergyDigit = -1;
 263     AliEMCALDigit *pMaxEnergyDigit = 0;
 264     nextdigitC.Reset();
 265     while ( (digit = dynamic_cast<AliEMCALDigit *>(nextdigitC())) )
 266     { // scan over the list of digitsC
 267       Float_t dEnergyCalibrated = Calibrate(digit->GetAmplitude(), digit->GetTime(),digit->GetId());
 268       //AliDebug(5, Form("-> Digit ENERGY: %1.5f", dEnergyCalibrated));
 269
 270       //if(fGeom->CheckAbsCellId(digit->GetId()) && dEnergyCalibrated > fECAClusteringThreshold  )
 271       if(fGeom->CheckAbsCellId(digit->GetId()) && dEnergyCalibrated > 0.0) // no threshold!
 272             {
 273               if (dEnergyCalibrated > dMaxEnergyDigit)
 274         {
 275           dMaxEnergyDigit = dEnergyCalibrated;
 276           iMaxEnergyDigit = digit->GetId();
 277           pMaxEnergyDigit = digit;
 278         }
 279             }
 280     }
 281
 282     if (iMaxEnergyDigit < 0 || digitsC.GetEntries() <= 0)
 283     {
 284       bDone = kTRUE;
 285       continue;
 286     }
 287
 288     AliDebug (2, Form("Max digit found: %1.2f AbsId: %d", dMaxEnergyDigit, iMaxEnergyDigit));
 289     AliDebug(5, Form("Max Digit ENERGY: %1.5f", dMaxEnergyDigit));
 290
 291     // keep the candidate digits in a list
 292     TList clusterDigitList;
 293     clusterDigitList.SetOwner(kFALSE);
 294     clusterDigitList.AddLast(pMaxEnergyDigit);
 295
 296     Double_t clusterCandidateEnergy = dMaxEnergyDigit;
 297
 298     // now loop over the resto of the digits and cluster into NxN cluster
 299     // we do not actually cluster yet: we keep them in the list clusterDigitList
 300     nextdigitC.Reset();
 301     while ( (digit = dynamic_cast<AliEMCALDigit *>(nextdigitC())) )
 302     { // scan over the list of digitsC
 303       if (digit == pMaxEnergyDigit) continue;
 304       Float_t dEnergyCalibrated = Calibrate(digit->GetAmplitude(), digit->GetTime(),digit->GetId());
 305       AliDebug(5, Form("-> Digit ENERGY: %1.5f", dEnergyCalibrated));
 306       //if(fGeom->CheckAbsCellId(digit->GetId()) && dEnergyCalibrated > fECAClusteringThreshold  )
 307       if(fGeom->CheckAbsCellId(digit->GetId()) && dEnergyCalibrated > 0.0  )
 308             {
 309               Float_t time = pMaxEnergyDigit->GetTime(); //Time or TimeR?
 310               if(TMath::Abs(time - digit->GetTime()) > fTimeCut ) continue; //Time or TimeR?
 311               Bool_t shared = kFALSE; //cluster shared by 2 SuperModules?
 312               if (AreNeighbours(pMaxEnergyDigit, digit, shared) == 1) // call (digit,digitN) in THAT order !!!!!
 313         {
 314           clusterDigitList.AddLast(digit) ;
 315           clusterCandidateEnergy += dEnergyCalibrated;
 316         }
 317             }
 318     }// loop over the next digits
 319
 320     // start a cluster here only if a cluster energy is larger than clustering threshold
 321     //if (clusterCandidateEnergy > 0.1)
 322     AliDebug(5, Form("Clusterization threshold is %f MeV", fECAClusteringThreshold));
 323     if (clusterCandidateEnergy > fECAClusteringThreshold)
 324     {
 325       if(fNumberOfECAClusters >= fRecPoints->GetSize()) fRecPoints->Expand(2*fNumberOfECAClusters+1) ;
 326
 327       AliEMCALRecPoint *recPoint = new  AliEMCALRecPoint("") ;
 328       fRecPoints->AddAt(recPoint, fNumberOfECAClusters) ;
 329       recPoint = dynamic_cast<AliEMCALRecPoint *>(fRecPoints->At(fNumberOfECAClusters)) ;
 330       if(recPoint){
 331         fNumberOfECAClusters++ ;
 332         recPoint->SetClusterType(AliVCluster::kEMCALClusterv1);
 333
 334         AliDebug(9, Form("Number of cells per cluster (max is 9!): %d", clusterDigitList.GetEntries()));
 335         for (Int_t idig = 0; idig < clusterDigitList.GetEntries(); idig++)
 336         {
 337
 338           digit = (AliEMCALDigit*)clusterDigitList.At(idig);
 339           Float_t dEnergyCalibrated = Calibrate(digit->GetAmplitude(), digit->GetTime(),digit->GetId());
 340           AliDebug(5, Form(" Adding digit %d", digit->GetId()));
 341           // note: this way the sharing info is lost!
 342           recPoint->AddDigit(*digit, dEnergyCalibrated, kFALSE) ; //Time or TimeR?
 343           digitsC.Remove(digit);
 344         }
 345       }// recpoint
 346     }
 347     else
 348     {
 349       // we do not want to start clustering in the same spot!
 350       // but in this case we may NOT reuse this seed for another cluster!
 351       // need a better bookeeping?
 352       digitsC.Remove(pMaxEnergyDigit);
 353     }
 354
 355     AliDebug (2, Form("Number of digits left: %d", digitsC.GetEntries()));
 356   } // while ! done
 357
 358   //delete digitsC ; //nope we use an object
 359
 360   AliDebug(1,Form("total no of clusters %d from %d digits",fNumberOfECAClusters,fDigitsArr->GetEntriesFast()));
 361 }
 362
 363 //___________________________________________________________________
 364 void   AliEMCALClusterizerNxN::SetInputCalibrated(Bool_t val)
 365 {
 366   //
 367   // input is calibrated - the case when we run already on ESD
 368   //
 369   AliEMCALClusterizerNxN::fgkIsInputCalibrated = val;
 370 }