PWG4/PartCorrBase/AliCalorimeterUtils.h

   1 #ifndef ALICALORIMETERUTILS_H
   2 #define ALICALORIMETERUTILS_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice     */
   5 /* $Id:  $ */
   6
   7 //_________________________________________________________________________
   8 // Class utility for Calorimeter specific selection methods                ///
   9 //
  10 //
  11 //
  12 //-- Author: Gustavo Conesa (LPSC-Grenoble)
  13 //////////////////////////////////////////////////////////////////////////////
  14
  15 // --- ROOT system ---
  16 #include "TObject.h"
  17 #include "TString.h"
  18 #include "TObjArray.h"
  19 class TArrayF;
  20 #include "TH2I.h"
  21
  22 //--- ANALYSIS system ---
  23 class AliVEvent;
  24 class AliAODPWG4Particle;
  25 class AliVCluster;
  26 class AliVCaloCells;
  27 #include "AliPHOSGeoUtils.h"
  28 #include "AliEMCALGeometry.h"
  29 #include "AliEMCALRecoUtils.h"
  30
  31 class AliCalorimeterUtils : public TObject {
  32
  33  public:
  34   AliCalorimeterUtils() ; // ctor
  35   virtual ~AliCalorimeterUtils() ;//virtual dtor
  36  private:
  37   AliCalorimeterUtils(const AliCalorimeterUtils & g) ; // cpy ctor
  38   AliCalorimeterUtils & operator = (const AliCalorimeterUtils & g) ;//cpy assignment
  39
  40  public:
  41
  42   virtual void InitParameters();
  43   virtual void Print(const Option_t * opt) const;
  44
  45   virtual Int_t GetDebug()         const { return fDebug ; }
  46   virtual void  SetDebug(Int_t d)        { fDebug = d ; }
  47
  48   //virtual void Init();
  49
  50   //Calorimeters Geometry Methods
  51   AliEMCALGeoUtils * GetEMCALGeometry() const { return fEMCALGeo;}
  52   TString  EMCALGeometryName()          const { return fEMCALGeoName ; }
  53   void  SetEMCALGeometryName(TString name)    { fEMCALGeoName = name ; }
  54   void InitEMCALGeometry() ;
  55   Bool_t IsEMCALGeoMatrixSet()          const { return fEMCALGeoMatrixSet; }
  56
  57   AliPHOSGeoUtils * GetPHOSGeometry() const { return fPHOSGeo;}
  58   TString  PHOSGeometryName()         const { return fPHOSGeoName ; }
  59   void  SetPHOSGeometryName(TString name)   { fPHOSGeoName = name ; }
  60   void InitPHOSGeometry() ;
  61   Bool_t IsPHOSGeoMatrixSet()         const {return fPHOSGeoMatrixSet ; }
  62
  63   void SetGeometryTransformationMatrices(AliVEvent* inputEvent) ;
  64
  65   // Bad channels
  66   Bool_t IsBadChannelsRemovalSwitchedOn()  const { return fRemoveBadChannels ; }
  67   void SwitchOnBadChannelsRemoval ()  {fRemoveBadChannels = kTRUE  ; fEMCALRecoUtils->SwitchOnBadChannelsRemoval(); InitPHOSBadChannelStatusMap();}
  68   void SwitchOffBadChannelsRemoval()  {fRemoveBadChannels = kFALSE ; fEMCALRecoUtils->SwitchOffBadChannelsRemoval();}
  69
  70   void InitPHOSBadChannelStatusMap () ;
  71
  72   Int_t GetEMCALChannelStatus(Int_t iSM , Int_t iCol, Int_t iRow) const {
  73     return fEMCALRecoUtils->GetEMCALChannelStatus(iSM,iCol,iRow); }//Channel is ok by default
  74
  75   Int_t GetPHOSChannelStatus (Int_t imod, Int_t iCol, Int_t iRow) const {
  76     if(fPHOSBadChannelMap)return (Int_t) ((TH2I*)fPHOSBadChannelMap->At(imod))->GetBinContent(iCol,iRow);
  77     else return 0;}//Channel is ok by default
  78
  79   void SetEMCALChannelStatus(Int_t iSM , Int_t iCol, Int_t iRow, Double_t c = 1) {
  80     fEMCALRecoUtils->SetEMCALChannelStatus(iSM,iCol,iRow,c);}
  81
  82   void SetPHOSChannelStatus (Int_t imod, Int_t iCol, Int_t iRow, Double_t c = 1) {
  83         if(!fPHOSBadChannelMap) InitPHOSBadChannelStatusMap() ;
  84         ((TH2I*)fPHOSBadChannelMap->At(imod))->SetBinContent(iCol,iRow,c);}
  85
  86   TH2I * GetEMCALChannelStatusMap(Int_t iSM) const {return fEMCALRecoUtils->GetEMCALChannelStatusMap(iSM);}
  87   TH2I * GetPHOSChannelStatusMap(Int_t imod) const {return (TH2I*)fPHOSBadChannelMap->At(imod);}
  88
  89   void SetEMCALChannelStatusMap(TObjArray *map) {fEMCALRecoUtils->SetEMCALChannelStatusMap(map);}
  90   void SetPHOSChannelStatusMap (TObjArray *map) {fPHOSBadChannelMap  = map;}
  91
  92   Bool_t ClusterContainsBadChannel(TString calorimeter,UShort_t* cellList, Int_t nCells);
  93
  94   //Calorimeter indexes information
  95   Int_t GetModuleNumber(AliAODPWG4Particle * particle, AliVEvent* inputEvent) const;
  96   Int_t GetModuleNumber(AliVCluster * cluster) const;
  97   Int_t GetModuleNumberCellIndexes(const Int_t absId, const TString calo, Int_t & icol, Int_t & irow, Int_t &iRCU) const ;
  98
  99   //Modules fiducial region
 100   Bool_t CheckCellFiducialRegion(AliVCluster* cluster, AliVCaloCells* cells, AliVEvent * event, Int_t iev=0) const ;
 101   void   SetNumberOfCellsFromPHOSBorder(Int_t n)  {fNCellsFromPHOSBorder = n; }
 102   Int_t  GetNumberOfCellsFromPHOSBorder()  const  {return fNCellsFromPHOSBorder; }
 103   void   SetNumberOfCellsFromEMCALBorder(Int_t n) {fEMCALRecoUtils->SetNumberOfCellsFromEMCALBorder(n)      ;}
 104   Int_t  GetNumberOfCellsFromEMCALBorder() const  {return fEMCALRecoUtils->GetNumberOfCellsFromEMCALBorder();}
 105   void   SwitchOnNoFiducialBorderInEMCALEta0()    {fEMCALRecoUtils->SwitchOnNoFiducialBorderInEMCALEta0()   ;}
 106   void   SwitchOffNoFiducialBorderInEMCALEta0()   {fEMCALRecoUtils->SwitchOffNoFiducialBorderInEMCALEta0()  ;}
 107   Bool_t IsEMCALNoBorderAtEta0()           const  {return fEMCALRecoUtils->IsEMCALNoBorderAtEta0()          ;}
 108
 109   // Recalibration
 110   Bool_t IsRecalibrationOn()  const { return fRecalibration ; }
 111   void SwitchOnRecalibration()    {fRecalibration = kTRUE ; InitPHOSRecalibrationFactors(); fEMCALRecoUtils->SwitchOnRecalibration();}
 112   void SwitchOffRecalibration()   {fRecalibration = kFALSE;fEMCALRecoUtils->SwitchOffRecalibration();}
 113
 114   void InitPHOSRecalibrationFactors () ;
 115
 116   Float_t GetEMCALChannelRecalibrationFactor(Int_t iSM , Int_t iCol, Int_t iRow) const { return fEMCALRecoUtils->GetEMCALChannelRecalibrationFactor(iSM , iCol, iRow);}
 117
 118   Float_t GetPHOSChannelRecalibrationFactor (Int_t imod, Int_t iCol, Int_t iRow) const {
 119     if(fPHOSRecalibrationFactors)return (Float_t) ((TH2F*)fPHOSRecalibrationFactors->At(imod))->GetBinContent(iCol,iRow);
 120     else return 1;}
 121
 122   void SetEMCALChannelRecalibrationFactor(Int_t iSM , Int_t iCol, Int_t iRow, Double_t c = 1) {
 123     fEMCALRecoUtils->SetEMCALChannelRecalibrationFactor(iSM,iCol,iRow,c);}
 124
 125   void SetPHOSChannelRecalibrationFactor (Int_t imod, Int_t iCol, Int_t iRow, Double_t c = 1) {
 126     if(!fPHOSRecalibrationFactors)  InitPHOSRecalibrationFactors();
 127     ((TH2F*)fPHOSRecalibrationFactors->At(imod))->SetBinContent(iCol,iRow,c);}
 128
 129   void SetEMCALChannelRecalibrationFactors(Int_t iSM , TH2F* h) {fEMCALRecoUtils->SetEMCALChannelRecalibrationFactors(iSM,h);}
 130   void SetPHOSChannelRecalibrationFactors(Int_t imod , TH2F* h) {fPHOSRecalibrationFactors ->AddAt(h,imod);}
 131
 132   TH2F * GetEMCALChannelRecalibrationFactors(Int_t iSM) const {return fEMCALRecoUtils->GetEMCALChannelRecalibrationFactors(iSM);}
 133   TH2F * GetPHOSChannelRecalibrationFactors(Int_t imod) const {return (TH2F*)fPHOSRecalibrationFactors->At(imod);}
 134
 135   void SetEMCALChannelRecalibrationFactors(TObjArray *map) {fEMCALRecoUtils->SetEMCALChannelRecalibrationFactors(map);}
 136   void SetPHOSChannelRecalibrationFactors (TObjArray *map) {fPHOSRecalibrationFactors  = map;}
 137
 138   Float_t RecalibrateClusterEnergy(AliVCluster* cluster, AliVCaloCells * cells);
 139
 140   //EMCAL specific utils for the moment
 141   void SetEMCALRecoUtils(AliEMCALRecoUtils * ru) {fEMCALRecoUtils = ru;}
 142   AliEMCALRecoUtils* GetEMCALRecoUtils() const {return fEMCALRecoUtils;}
 143
 144   Bool_t IsCorrectionOfClusterEnergyOn()  const    { return fCorrectELinearity ; }
 145   void SwitchOnCorrectClusterLinearity()         { fCorrectELinearity = kTRUE; }
 146   void SwitchOffCorrectClusterLinearity()        { fCorrectELinearity = kFALSE; }
 147   void CorrectClusterEnergy(AliVCluster *cl);
 148
 149   Bool_t IsRecalculationOfClusterPositionOn()  const { return fRecalculatePosition ; }
 150   void SwitchOnRecalculateClusterPosition()      { fRecalculatePosition = kTRUE; }
 151   void SwitchOffRecalculateClusterPosition()     { fRecalculatePosition = kFALSE; }
 152   void RecalculateClusterPosition(AliVCaloCells* cells, AliVCluster* clu);
 153   void RecalculateClusterShowerShapeParameters(AliVCaloCells* cells, AliVCluster* clu){
 154     fEMCALRecoUtils->RecalculateClusterShowerShapeParameters((AliEMCALGeometry*)fEMCALGeo, cells, clu);
 155   }
 156   void RecalculateClusterPID(AliVCluster* clu) {fEMCALRecoUtils->RecalculateClusterPID(clu);}
 157
 158   //Track matching recalculation
 159   void RecalculateClusterTrackMatching(AliVEvent * event)         {if (fRecalculateMatching) fEMCALRecoUtils->FindMatches(event);}
 160   void GetMatchedResiduals(Int_t index, Float_t &dR, Float_t &dZ) {if (fRecalculateMatching) fEMCALRecoUtils->GetMatchedResiduals(index,dR,dZ);}
 161   //This could be used for PHOS ...
 162   void SwitchOnRecalculateClusterTrackMatching()      { fRecalculateMatching = kTRUE; }
 163   void SwitchOffRecalculateClusterTrackMatching()     { fRecalculateMatching = kFALSE; }
 164   Bool_t IsRecalculationOfClusterTrackMatchingOn()  const { return fRecalculateMatching ; }
 165   Float_t GetCutR() const { return fCutR; }
 166   Float_t GetCutZ() const { return fCutZ; }
 167
 168   void SetCutR(Float_t cutR) { fCutR=cutR; fEMCALRecoUtils->SetCutR(cutR); }
 169   void SetCutZ(Float_t cutZ) { fCutZ=cutZ; fEMCALRecoUtils->SetCutZ(cutZ);}
 170
 171  private:
 172
 173   Int_t              fDebug;                 //  Debugging level
 174   TString            fEMCALGeoName;          //  Name of geometry to use for EMCAL.
 175   TString            fPHOSGeoName;           //  Name of geometry to use for PHOS.
 176   AliEMCALGeoUtils * fEMCALGeo ;             //! EMCAL geometry pointer
 177   AliPHOSGeoUtils  * fPHOSGeo  ;             //! PHOS  geometry pointer
 178   Bool_t             fEMCALGeoMatrixSet;     //  Check if the transformation matrix is set for EMCAL
 179   Bool_t             fPHOSGeoMatrixSet ;     //  Check if the transformation matrix is set for PHOS
 180   Bool_t             fRemoveBadChannels;     //  Check the channel status provided and remove clusters with bad channels
 181   TObjArray        * fPHOSBadChannelMap;     //  Array of histograms with map of bad channels, PHOS
 182   Int_t              fNCellsFromPHOSBorder;  //  Number of cells from PHOS  border the cell with maximum amplitude has to be.
 183   Bool_t             fRecalibration;         //  Switch on or off the recalibration
 184   TObjArray        * fPHOSRecalibrationFactors;  // Array of histograms with map of recalibration factors, PHOS
 185   AliEMCALRecoUtils* fEMCALRecoUtils;        //  EMCAL utils for cluster rereconstruction
 186   Bool_t             fRecalculatePosition;   // Recalculate cluster position
 187   Bool_t             fCorrectELinearity  ;   // Correct cluster energy linearity
 188   Bool_t             fRecalculateMatching;   // Recalculate cluster position
 189   Float_t            fCutR;                  // dR cut on matching
 190   Float_t            fCutZ;                  // dZ cut on matching
 191
 192   ClassDef(AliCalorimeterUtils,4)
 193 } ;
 194
 195
 196 #endif //ALICALORIMETERUTILS_H
 197
 198
 199