PWG4/PartCorrBase/AliAnaPartCorrBaseClass.h

   1 #ifndef ALIANAPARTCORRBASECLASS_H
   2 #define ALIANAPARTCORRBASECLASS_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   // Base class for analysis algorithms
   9   //-- Author: Gustavo Conesa (INFN-LNF)
  10 //-Add the possibality for event selection analysis based on vertex and multiplicity bins (Yaxian Mao, 10/10/2010)
  11 #include <cstdlib>
  12
  13   //ROOT
  14 class TClonesArray ;
  15 class TObjArray ;
  16 #include <TList.h>
  17 #include <TObject.h>
  18 class TObjString;
  19
  20   //Analysis
  21 class AliVCaloCells;
  22 #include "AliCaloTrackReader.h"
  23 #include "AliCaloPID.h"
  24 #include "AliFiducialCut.h"
  25 #include "AliIsolationCut.h"
  26 #include "AliMCAnalysisUtils.h"
  27 #include "AliNeutralMesonSelection.h"
  28 #include "AliCalorimeterUtils.h"
  29 class AliStack ;
  30 class AliHeader ;
  31 class AliGenEventHeader ;
  32 #include "AliAODPWG4ParticleCorrelation.h"
  33 class AliEMCALGeoUtils;
  34 class AliPHOSGeoUtils;
  35 #include "AliMixedEvent.h"
  36
  37 class AliAnaPartCorrBaseClass : public TObject {
  38
  39 public:
  40   AliAnaPartCorrBaseClass() ; // default ctor
  41   virtual ~AliAnaPartCorrBaseClass() ; //virtual dtor
  42
  43 private:
  44   AliAnaPartCorrBaseClass(const AliAnaPartCorrBaseClass & g) ; // cpy ctor
  45   AliAnaPartCorrBaseClass & operator = (const AliAnaPartCorrBaseClass & g) ;//cpy assignment
  46
  47 public:
  48
  49   virtual void AddAODParticle(AliAODPWG4Particle part) ;
  50
  51   virtual void ConnectInputOutputAODBranches();
  52
  53   virtual TList * GetCreateOutputObjects()      { return (new TList) ;}
  54
  55   virtual void AddToHistogramsName(TString add) { fAddToHistogramsName = add; }
  56   virtual TString GetAddedHistogramsStringToName() {return fAddToHistogramsName ;}
  57
  58   virtual void Init() {;}
  59   virtual void InitParameters() ;
  60
  61   virtual void Print(const Option_t * ) const ;
  62
  63   virtual void MakeAnalysisFillAOD()  {;}
  64
  65   virtual void MakeAnalysisFillHistograms() {;}
  66
  67   virtual TObjString * GetAnalysisCuts() {return 0x0;}
  68
  69   virtual Int_t GetDebug() const  { return fDebug ; }
  70   virtual void SetDebug(Int_t d)   { fDebug = d ; }
  71
  72   virtual Int_t GetEventNumber() const ;
  73
  74   virtual AliCaloTrackReader * GetReader() const {return fReader ; }
  75   virtual void SetReader(AliCaloTrackReader * const reader) { fReader = reader ; }
  76
  77   Int_t GetTrackMultiplicity() const {return fReader->GetTrackMultiplicity();}
  78
  79   //Calorimeter helper class access methods
  80   AliEMCALGeoUtils *  GetEMCALGeometry() const { return fCaloUtils->GetEMCALGeometry(); }
  81   AliPHOSGeoUtils  *  GetPHOSGeometry()  const { return fCaloUtils->GetPHOSGeometry() ; }
  82
  83   Int_t GetModuleNumberCellIndexes(const Int_t absId, const TString calo, Int_t & icol, Int_t & irow, Int_t &iRCU) const {
  84           return fCaloUtils->GetModuleNumberCellIndexes(absId, calo, icol, irow,iRCU);}
  85   Int_t GetModuleNumber(AliAODPWG4Particle * part) const {
  86           return fCaloUtils->GetModuleNumber(part, fReader->GetInputEvent());}
  87   Int_t GetModuleNumber(AliVCluster * cluster) const {
  88           return fCaloUtils->GetModuleNumber(cluster);}
  89
  90   virtual void Terminate(TList * /*outputList*/) {;}
  91
  92   //analysis AOD branch
  93   virtual TClonesArray * GetCreateOutputAODBranch() ;
  94   virtual TString GetInputAODName() const {return fInputAODName ; }
  95   virtual void SetInputAODName(TString name)   { fInputAODName = name; }
  96   virtual TString GetOutputAODName()  const {return fOutputAODName ; }
  97   virtual void SetOutputAODName(TString name)   { fNewAOD = kTRUE ; fOutputAODName = name; }
  98   virtual Bool_t NewOutputAOD() const {return fNewAOD;}
  99   virtual TString GetOutputAODClassName() const {return fOutputAODClassName;}
 100   virtual void SetOutputAODClassName(TString name) {fOutputAODClassName = name; }
 101   virtual AliCalorimeterUtils * GetCaloUtils() const {return fCaloUtils ; }
 102   void SetCaloUtils(AliCalorimeterUtils * caloutils) { fCaloUtils = caloutils ; }
 103
 104   virtual TString GetAODObjArrayName() const {return fAODObjArrayName;}
 105   virtual void SetAODObjArrayName(TString name) {fAODObjArrayName = name; }
 106
 107   virtual TClonesArray* GetInputAODBranch() const {return fInputAODBranch ;}
 108   virtual TClonesArray* GetOutputAODBranch() const {if(fNewAOD) return fOutputAODBranch; else return fInputAODBranch ;}
 109   virtual TClonesArray* GetAODBranch(TString aodBranchName) const ;
 110
 111   virtual TClonesArray* GetAODCaloClusters() const ;
 112   virtual TClonesArray* GetAODTracks() const ;
 113   virtual AliVCaloCells* GetPHOSCells()  const {return fReader->GetPHOSCells()  ;}
 114   virtual AliVCaloCells* GetEMCALCells() const {return fReader->GetEMCALCells() ;}
 115
 116   virtual TObjArray* GetAODCTS() const ;
 117   virtual TObjArray* GetAODEMCAL() const ;
 118   virtual TObjArray* GetAODPHOS() const ;
 119
 120   virtual TString       GetBaseParametersList();
 121
 122   virtual AliStack * GetMCStack() const ;
 123   virtual AliHeader* GetMCHeader() const ;
 124   virtual AliGenEventHeader* GetMCGenEventHeader() const ;
 125
 126   //Analysis helpers classes pointers setters and getters
 127   virtual AliCaloPID * GetCaloPID() {if(!fCaloPID) fCaloPID = new AliCaloPID(); return  fCaloPID ;}
 128   virtual void SetCaloPID(AliCaloPID * const pid) { fCaloPID = pid ;}
 129
 130   virtual AliFiducialCut * GetFiducialCut() {if(!fFidCut) fFidCut = new AliFiducialCut(); return  fFidCut ;}
 131   virtual void SetFiducialCut(AliFiducialCut * const fc) { fFidCut = fc ;}
 132
 133   virtual AliIsolationCut * GetIsolationCut() {if(!fIC) fIC = new AliIsolationCut();  return  fIC ;}
 134   virtual void SetIsolationCut(AliIsolationCut * const ic) { fIC = ic ;}
 135
 136   virtual AliMCAnalysisUtils * GetMCAnalysisUtils()  {if(!fMCUtils) fMCUtils = new AliMCAnalysisUtils(); return  fMCUtils ;}
 137   virtual void SetMCAnalysisUtils(AliMCAnalysisUtils * const mcutils) { fMCUtils = mcutils ;}
 138
 139   virtual AliNeutralMesonSelection * GetNeutralMesonSelection()  {if(!fNMS) fNMS = new AliNeutralMesonSelection(); return  fNMS ;}
 140   virtual void SetNeutralMesonSelection(AliNeutralMesonSelection * const nms) { fNMS = nms ;}
 141
 142   virtual Bool_t     IsDataMC()       {return fDataMC ; }
 143   virtual void SwitchOnDataMC()       {fDataMC = kTRUE ; if(!fMCUtils)fMCUtils = new AliMCAnalysisUtils();}
 144   virtual void SwitchOffDataMC()      {fDataMC = kFALSE ; }
 145
 146   virtual Bool_t IsFiducialCutOn()       { return fCheckFidCut ; }
 147   virtual void SwitchOnFiducialCut()     { fCheckFidCut = kTRUE;  if(!fFidCut)fFidCut = new AliFiducialCut();}
 148   virtual void SwitchOffFiducialCut()    { fCheckFidCut = kFALSE;}
 149
 150   virtual Bool_t IsCaloPIDOn()       { return fCheckCaloPID ; }
 151   virtual void SwitchOnCaloPID()     { fCheckCaloPID = kTRUE; if(!fCaloPID)fCaloPID = new AliCaloPID();}
 152   virtual void SwitchOffCaloPID()    { fCheckCaloPID = kFALSE;}
 153
 154   virtual Bool_t IsCaloPIDRecalculationOn()       { return fRecalculateCaloPID ; }
 155   virtual void SwitchOnCaloPIDRecalculation()     { fRecalculateCaloPID  = kTRUE;}
 156   virtual void SwitchOffCaloPIDRecalculation()    { fRecalculateCaloPID  = kFALSE;}
 157
 158   virtual Float_t    GetMaxPt()         const {return fMaxPt ; }
 159   virtual Float_t    GetMinPt()         const {return fMinPt ; }
 160   virtual void SetMaxPt(Float_t pt)           {fMaxPt = pt ; }
 161   virtual void SetMinPt(Float_t pt)           {fMinPt = pt ; }
 162   virtual void SetPtCutRange(Double_t ptmin, Double_t ptmax)
 163   {  fMaxPt=ptmax;   fMinPt=ptmin;}
 164   //Setters for parameters of event buffers
 165   virtual void SetMultiBin(Int_t n=1) {fMultiBin=n ;} //number of bins in Multiplicity
 166   virtual void SetNZvertBin(Int_t n=1) {fNZvertBin=n ;} //number of bins for vertex position
 167   virtual void SetNRPBin(Int_t n=1)    {fNrpBin=n ;}    //number of bins in reaction plain
 168   virtual void SetZvertexCut(Float_t zcut=40.){fZvtxCut=zcut ;} //cut on vertex position
 169   virtual void SetMultiplicity(Int_t multimin, Int_t multimax) {fMinMulti = multimin ; fMaxMulti = multimax ; }
 170   virtual void SwitchOnEventSelection()    {fUseSelectEvent = kTRUE ; }
 171   virtual void SwitchOffEventSelection()   {fUseSelectEvent = kFALSE ; }
 172   //Getters for event selection
 173   virtual Int_t GetMultiBin()  const       {return fMultiBin ;} //number of bins in Multiplicity
 174   virtual Int_t GetNZvertBin() const       {return fNZvertBin ;} //number of bins in vertex
 175   virtual Int_t GetNRPBin()    const       {return fNrpBin ;}    //number of bins in reaction plain
 176   //Getters for event selection
 177   virtual Float_t GetZvertexCut() const {return fZvtxCut ;} //cut on vertex position
 178   virtual Int_t GetMaxMulti()     const {return fMaxMulti  ; }
 179   virtual Int_t GetMinMulti()     const {return fMinMulti  ; }
 180
 181   // Do correlation analysis with different event buffers
 182   virtual Bool_t DoEventSelect() const {return fUseSelectEvent ; }
 183
 184   //Histogrammes setters and getters
 185   //Pt, Energy
 186   virtual void SetHistoPtRangeAndNBins(Float_t min, Float_t max, Int_t n) {
 187     fHistoPtBins = n ;
 188     fHistoPtMax = max ;
 189     fHistoPtMin = min ;
 190   }
 191
 192   virtual Int_t   GetHistoPtBins()  const { return fHistoPtBins; }
 193   virtual Float_t GetHistoPtMin()   const { return fHistoPtMin ; }
 194   virtual Float_t GetHistoPtMax()   const { return fHistoPtMax ; }
 195
 196     //Azimuthal angle
 197   virtual void SetHistoPhiRangeAndNBins(Float_t min, Float_t max, Int_t n) {
 198     fHistoPhiBins  = n ;
 199     fHistoPhiMax   = max ;
 200     fHistoPhiMin   = min ;
 201   }
 202
 203   virtual Int_t   GetHistoPhiBins()  const { return fHistoPhiBins; }
 204   virtual Float_t GetHistoPhiMin()   const { return fHistoPhiMin ; }
 205   virtual Float_t GetHistoPhiMax()   const { return fHistoPhiMax ; }
 206
 207   //Pseudorapidity-rapidity
 208   virtual void SetHistoEtaRangeAndNBins(Float_t min, Float_t max, Int_t n) {
 209     fHistoEtaBins = n ;
 210     fHistoEtaMax  = max ;
 211     fHistoEtaMin  = min ;
 212   }
 213
 214   virtual Int_t   GetHistoEtaBins()  const { return fHistoEtaBins; }
 215   virtual Float_t GetHistoEtaMin()   const { return fHistoEtaMin ; }
 216   virtual Float_t GetHistoEtaMax()   const { return fHistoEtaMax ; }
 217
 218   //Mass
 219   virtual void SetHistoMassRangeAndNBins(Float_t min, Float_t max, Int_t n) {
 220     fHistoMassBins = n ;
 221     fHistoMassMax  = max ;
 222     fHistoMassMin  = min ;
 223   }
 224
 225   virtual Int_t   GetHistoMassBins()  const { return fHistoMassBins ; }
 226   virtual Float_t GetHistoMassMin()   const { return fHistoMassMin ; }
 227   virtual Float_t GetHistoMassMax()   const { return fHistoMassMax ; }
 228
 229   //Asymetry
 230   virtual void SetHistoAsymmetryRangeAndNBins(Float_t min, Float_t max, Int_t n) {
 231     fHistoAsymBins = n ;
 232     fHistoAsymMax  = max ;
 233     fHistoAsymMin  = min ;
 234   }
 235
 236   virtual Int_t   GetHistoAsymmetryBins()  const { return fHistoAsymBins ; }
 237   virtual Float_t GetHistoAsymmetryMin()   const { return fHistoAsymMin ; }
 238   virtual Float_t GetHistoAsymmetryMax()   const { return fHistoAsymMax ; }
 239
 240   virtual AliMixedEvent * GetMixedEvent()          { return GetReader()->GetMixedEvent() ; }
 241   virtual Int_t           GetNMixedEvent()   const { return GetReader()->GetNMixedEvent() ; }
 242
 243   virtual void      GetVertex(Double_t vertex[3])   const { GetReader()->GetVertex(vertex) ; }
 244   virtual void      GetVertex(Double_t vertex[3],const Int_t evtIndex) const { GetReader()->GetVertex(vertex,evtIndex) ; }
 245   virtual Double_t* GetVertex(const Int_t evtIndex) const { return GetReader()->GetVertex(evtIndex) ; }
 246
 247         virtual Bool_t IsTrackMatched(const AliVCluster * cluster) const { return fCaloPID->IsTrackMatched(cluster); }
 248
 249   void SwitchOnPlotsMaking()  {fMakePlots = kTRUE  ;}
 250   void SwitchOffPlotsMaking() {fMakePlots = kFALSE ;}
 251   Bool_t MakePlotsOn() const  {return fMakePlots;}
 252
 253 private:
 254
 255   Bool_t  fDataMC ;             // Flag to access MC data when using ESD or AOD
 256   Int_t   fDebug ;              // Debug level
 257   Bool_t  fCheckFidCut ;        // Do analysis for clusters in defined region
 258   Bool_t  fCheckCaloPID ;       // Do analysis for calorimeters
 259   Bool_t  fRecalculateCaloPID ; // Recalculate PID or use PID weights in calorimeters
 260   Float_t fMinPt ;              // Maximum pt of (trigger) particles in the analysis
 261   Float_t fMaxPt ;              // Minimum pt of (trigger) particles in the analysis
 262   Int_t    fMultiBin ;    // Number of bins in event container for multiplicity
 263   Int_t    fNZvertBin ;   // Number of bins in event container for vertex position
 264   Int_t    fNrpBin ;        // Number of bins in event container for reaction plain
 265   Float_t  fZvtxCut ;       // Cut on vertex position
 266   Int_t    fMaxMulti ;              // Maximum multiplicity of particles in the analysis
 267   Int_t    fMinMulti ;              // Maximum multiplicity of particles in the analysis
 268   Bool_t   fUseSelectEvent ; // Select events based on multiplicity and vertex cuts
 269   Bool_t   fMakePlots   ;    // Print plots
 270
 271
 272   AliCaloTrackReader * fReader; // Acces to ESD/AOD/MC data
 273
 274   TClonesArray* fInputAODBranch ;    //! Selected input particles branch
 275   TString       fInputAODName ;      //  Name of input AOD branch;
 276   TClonesArray* fOutputAODBranch ;   //! Selected output particles branch
 277   Bool_t        fNewAOD ;            //  Flag, new aod branch added to the analysis or not.
 278   TString       fOutputAODName ;     //  Name of output AOD branch;
 279   TString       fOutputAODClassName; //  Type of aod objects to be stored in the TClonesArray (AliAODPWG4Particle, AliAODPWG4ParticleCorrelation ...)
 280   TString       fAODObjArrayName ;   // Name of ref array kept in a TList in AliAODParticleCorrelation with clusters or track references.
 281   TString       fAddToHistogramsName;// Add this string to histograms name
 282
 283   //Analysis helper classes access pointers
 284   AliCaloPID               * fCaloPID; //! PID calculation
 285   AliFiducialCut           * fFidCut;  //! Acceptance cuts
 286   AliIsolationCut          * fIC;      //! Isolation cut
 287   AliMCAnalysisUtils       * fMCUtils; //! MonteCarlo Analysis utils
 288   AliNeutralMesonSelection * fNMS;     //! Neutral Meson Selection
 289   AliCalorimeterUtils      * fCaloUtils ; //  Pointer to CalorimeterUtils
 290
 291   //Histograms binning and range
 292   Int_t   fHistoPtBins   ;  // Number of bins in pt axis
 293   Float_t fHistoPtMax    ;  // Maximum value of pt histogram range
 294   Float_t fHistoPtMin    ;  // Minimum value of pt histogram range
 295   Int_t   fHistoPhiBins  ;  // Number of bins in phi axis
 296   Float_t fHistoPhiMax   ;  // Maximum value of phi histogram range
 297   Float_t fHistoPhiMin   ;  // Minimum value of phi histogram range
 298   Int_t   fHistoEtaBins  ;  // Number of bins in eta axis
 299   Float_t fHistoEtaMax   ;  // Maximum value of eta histogram range
 300   Float_t fHistoEtaMin   ;  // Minimum value of eta histogram range
 301   Int_t   fHistoMassBins ;  // Number of bins in mass axis
 302   Float_t fHistoMassMax  ;  // Maximum value of mass histogram range
 303   Float_t fHistoMassMin  ;  // Minimum value of mass histogram range
 304   Int_t   fHistoAsymBins ;  // Number of bins in asymmetry axis
 305   Float_t fHistoAsymMax  ;  // Maximum value of asymmetry histogram range
 306   Float_t fHistoAsymMin  ;  // Minimum value of asymmetry histogram range
 307
 308   ClassDef(AliAnaPartCorrBaseClass,11)
 309 } ;
 310
 311
 312 #endif //ALIANAPARTCORRBASECLASS_H
 313
 314
 315