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