[u/mrichter/AliRoot.git] / PWGJE / EMCALJetTasks / AliAnalysisTaskLocalRho.h

#ifndef ALIANALYSISTASKLOCALRHO_H
#define ALIANALYSISTASKLOCALRHO_H

// $Id$

#include <AliAnalysisTaskEmcalJet.h>
#include <AliEmcalJet.h>
#include <AliVEvent.h>
#include <AliVTrack.h>
#include <AliVCluster.h>
#include <TClonesArray.h>
#include <TMath.h>
#include <TRandom3.h>
#include <AliLog.h>
#include <AliJetContainer.h>

class TF1;
class THF1;
class THF2;
class TProfile;
class AliLocalRhoParameter;

class AliAnalysisTaskLocalRho : public AliAnalysisTaskEmcalJet {
 public:
  // enumerators
  enum fitModulationType  { kNoFit, kV2, kV3, kCombined, kFourierSeries, kIntegratedFlow, kQC2, kQC4 }; // fit type
  enum detectorType       { kTPC, kVZEROA, kVZEROC, kVZEROComb};  // detector that was used
  enum qcRecovery         { kFixedRho, kNegativeVn, kTryFit };    // how to deal with negative cn value for qcn value
  enum runModeType        { kLocal, kGrid };                      // run mode type
  // constructors, destructor
  AliAnalysisTaskLocalRho();
  AliAnalysisTaskLocalRho(const char *name, runModeType type);
  virtual                 ~AliAnalysisTaskLocalRho();
  // setting up the task and technical aspects
  void                    ExecOnce();
  Bool_t                  InitializeAnalysis();
  virtual void            UserCreateOutputObjects();
  TH1F*                   BookTH1F(const char* name, const char* x, Int_t bins, Double_t min, Double_t max, Int_t c = -1, Bool_t append = kTRUE);
  TH2F*                   BookTH2F(const char* name, const char* x, const char* y, Int_t binsx, Double_t minx, Double_t maxx, 
				   Int_t binsy, Double_t miny, Double_t maxy, Int_t c = -1, Bool_t append = kTRUE);
  virtual Bool_t          Run();
  /* inline */   Double_t PhaseShift(Double_t x) const {  
    while (x>=TMath::TwoPi())x-=TMath::TwoPi();
    while (x<0.)x+=TMath::TwoPi();
    return x; }
  /* inline */   Double_t PhaseShift(Double_t x, Double_t n) const {
    x = PhaseShift(x);
    if(TMath::Nint(n)==2) while (x>TMath::Pi()) x-=TMath::Pi();
    if(TMath::Nint(n)==3) {
      if(x>2.*TMath::TwoPi()/n) x = TMath::TwoPi() - x;
      if(x>TMath::TwoPi()/n) x = TMath::TwoPi()-(x+TMath::TwoPi()/n);
    }
    return x; }
  /* inline */   Double_t ChiSquarePDF(Int_t ndf, Double_t x) const {
    Double_t n(ndf/2.), denom(TMath::Power(2, n)*TMath::Gamma(n));
    if (denom!=0)  return ((1./denom)*TMath::Power(x, n-1)*TMath::Exp(-x/2.)); 
    return -999; }
  // the cdf of the chisquare distribution is the normalized lower incomplete gamma function
  /* inline */    Double_t ChiSquareCDF(Int_t ndf, Double_t x) const { return TMath::Gamma(ndf/2., x/2.); }
  // setters - setup how to run
  void                    SetDebugMode(Int_t d)                           {fDebug = d;}
  void                    SetCentralityClasses(TArrayI* c)                {fCentralityClasses = c;}
  void                    SetAttachToEvent(Bool_t a)                      {fAttachToEvent = a;}
  void                    SetUseScaledRho(Bool_t s)                       {fUseScaledRho = s;}
  void                    SetFillHistograms(Bool_t b)                     {fFillHistograms = b;}
  // setters - analysis details
  void                    SetNoEventWeightsForQC(Bool_t e)                {fNoEventWeightsForQC = e;}
  void                    SetIntegratedFlow(TH1F* i, TH1F* j)             {fUserSuppliedV2 = i; fUserSuppliedV3 = j; }
  void                    SetOnTheFlyResCorrection(TH1F* r2, TH1F* r3)    {fUserSuppliedR2 = r2; fUserSuppliedR3 = r3; }
  void                    SetModulationFit(TF1* fit);
  void                    SetModulationFitMinMaxP(Float_t m, Float_t n)   {fMinPvalue = m; fMaxPvalue = n; }
  void                    SetModulationFitType(fitModulationType type)    {fFitModulationType = type; }
  void                    SetQCnRecoveryType(qcRecovery type)             {fQCRecovery = type; }
  void                    SetModulationFitOptions(TString opt)            {fFitModulationOptions = opt; }
  void                    SetReferenceDetector(detectorType type)         {fDetectorType = type; }
  void                    SetUsePtWeight(Bool_t w)                        {fUsePtWeight = w; }
  void                    SetRunModeType(runModeType type)                {fRunModeType = type; }
  void                    SetForceAbsVnHarmonics(Bool_t f)                {fAbsVnHarmonics = f; }
  void                    SetExcludeLeadingJetsFromFit(Float_t n)         {fExcludeLeadingJetsFromFit = n; }
  void                    SetRebinSwapHistoOnTheFly(Bool_t r)             {fRebinSwapHistoOnTheFly = r; }
  void                    SetSaveThisPercentageOfFits(Float_t p)          {fPercentageOfFits = p; }
  void                    SetUseV0EventPlaneFromHeader(Bool_t h)          {fUseV0EventPlaneFromHeader = h;}
  void                    SetSoftTrackMinMaxPt(Float_t min, Float_t max)  {fSoftTrackMinPt = min; fSoftTrackMaxPt = max;}
  // getters
  TString                 GetLocalRhoName() const                         {return fLocalRhoName; }
  // numerical evaluations
  void                    CalculateEventPlaneVZERO(Double_t vzero[2][2]) const;
  void                    CalculateEventPlaneTPC(Double_t* tpc);
  void                    CalculateEventPlaneCombinedVZERO(Double_t* comb) const;
  Double_t                CalculateQC2(Int_t harm);
  Double_t                CalculateQC4(Int_t harm);
  // helper calculations for the q-cumulant analysis, also used by AliAnalyisTaskJetFlow
  void                    QCnQnk(Int_t n, Int_t k, Double_t &reQ, Double_t &imQ);
  Double_t                QCnS(Int_t i, Int_t j);
  Double_t                QCnM();
  Double_t                QCnM11();
  Double_t                QCnM1111();
  Bool_t                  QCnRecovery(Double_t psi2, Double_t psi3);
  // analysis details
  Bool_t                  CorrectRho(Double_t psi2, Double_t psi3);
  void                    FillEventPlaneHistograms(Double_t psi2, Double_t psi3) const;
  void                    FillAnalysisSummaryHistogram() const;
  // track selection
  /* inline */     Bool_t PassesCuts(AliVTrack* track) const { return AcceptTrack(track, 0);}
  /* inline */     Bool_t PassesCuts(AliEmcalJet* jet) { return AcceptJet(jet, 0);}
  virtual void            Terminate(Option_t* option);

 private: 
  Int_t                   fDebug;                 // debug level (0 none, 1 fcn calls, 2 verbose)
  Bool_t                  fInitialized;           //! is the analysis initialized?
  Bool_t                  fAttachToEvent;         // attach local rho to the event
  Bool_t                  fFillHistograms;        // fill qa histograms
  Bool_t                  fNoEventWeightsForQC;   // don't store event weights for qc analysis
  Bool_t                  fUseScaledRho;          // use scaled rho
  TArrayI*                fCentralityClasses;     // centrality classes (maximum 10) used for QA
  TH1F*                   fUserSuppliedV2;        // histo with integrated v2
  TH1F*                   fUserSuppliedV3;        // histo with integrated v3
  TH1F*                   fUserSuppliedR2;        // correct the extracted v2 with this r
  TH1F*                   fUserSuppliedR3;        // correct the extracted v3 with this r
  Int_t                   fNAcceptedTracks;       //! number of accepted tracks
  Int_t                   fNAcceptedTracksQCn;    //! accepted tracks for QCn
  Int_t                   fInCentralitySelection; //! centrality bin, only for QA plots
  fitModulationType       fFitModulationType;     // fit modulation type
  qcRecovery              fQCRecovery;            // recovery type for e-by-e qc method
  Bool_t                  fUsePtWeight;           // use dptdphi instead of dndphi
  detectorType            fDetectorType;          // type of detector used for modulation fit
  TString                 fFitModulationOptions;  // fit options for modulation fit
  runModeType             fRunModeType;           // run mode type 
  TF1*                    fFitModulation;         // modulation fit for rho
  Float_t                 fMinPvalue;             // minimum value of p
  Float_t                 fMaxPvalue;             // maximum value of p
  // additional jet cuts (most are inherited)
  Float_t                 fLocalJetMinEta;        // local eta cut for jets
  Float_t                 fLocalJetMaxEta;        // local eta cut for jets
  Float_t                 fLocalJetMinPhi;        // local phi cut for jets
  Float_t                 fLocalJetMaxPhi;        // local phi cut for jets
  Float_t                 fSoftTrackMinPt;        // min pt for soft tracks
  Float_t                 fSoftTrackMaxPt;        // max pt for soft tracks
  // general qa histograms
  TH1F*                   fHistPvalueCDF;         //! cdf value of chisquare p
  // general settings
  Bool_t                  fAbsVnHarmonics;        // force postive local rho
  Float_t                 fExcludeLeadingJetsFromFit;    // exclude n leading jets from fit
  Bool_t                  fRebinSwapHistoOnTheFly;       // rebin swap histo on the fly
  Float_t                 fPercentageOfFits;      // save this percentage of fits
  Bool_t                  fUseV0EventPlaneFromHeader;    // use the vzero event plane from the header
  // transient object pointers
  TList*                  fOutputList;            //! output list
  TList*                  fOutputListGood;        //! output list for local analysis
  TList*                  fOutputListBad;         //! output list for local analysis
  TH1F*                   fHistSwap;              //! swap histogram
  TH1F*                   fHistAnalysisSummary;   //! flags
  TProfile*               fProfV2;                //! extracted v2
  TProfile*               fProfV2Cumulant;        //! v2 cumulant
  TProfile*               fProfV3;                //! extracted v3
  TProfile*               fProfV3Cumulant;        //! v3 cumulant
  TH1F*                   fHistPsi2[10];          //! psi 2
  TH1F*                   fHistPsi3[10];          //! psi 3

  AliAnalysisTaskLocalRho(const AliAnalysisTaskLocalRho&);                  // not implemented
  AliAnalysisTaskLocalRho& operator=(const AliAnalysisTaskLocalRho&);       // not implemented

  ClassDef(AliAnalysisTaskLocalRho, 4);
};
#endif
Commit	Line	Data
5ce0dc6d	1	#ifndef ALIANALYSISTASKLOCALRHO_H
	2	#define ALIANALYSISTASKLOCALRHO_H
	3
	4	// $Id$
	5
9239b066	6	#include <AliAnalysisTaskEmcalJet.h>
5ce0dc6d	7	#include <AliEmcalJet.h>
	8	#include <AliVEvent.h>
	9	#include <AliVTrack.h>
	10	#include <AliVCluster.h>
	11	#include <TClonesArray.h>
	12	#include <TMath.h>
	13	#include <TRandom3.h>
9e5eee5d	14	#include <AliLog.h>
9e5eee5d	15	#include <AliJetContainer.h>
5ce0dc6d	16
	17	class TF1;
	18	class THF1;
	19	class THF2;
	20	class TProfile;
	21	class AliLocalRhoParameter;
	22
9239b066	23	class AliAnalysisTaskLocalRho : public AliAnalysisTaskEmcalJet {
	24	public:
	25	// enumerators
	26	enum fitModulationType { kNoFit, kV2, kV3, kCombined, kFourierSeries, kIntegratedFlow, kQC2, kQC4 }; // fit type
	27	enum detectorType { kTPC, kVZEROA, kVZEROC, kVZEROComb}; // detector that was used
	28	enum qcRecovery { kFixedRho, kNegativeVn, kTryFit }; // how to deal with negative cn value for qcn value
	29	enum runModeType { kLocal, kGrid }; // run mode type
	30	// constructors, destructor
	31	AliAnalysisTaskLocalRho();
	32	AliAnalysisTaskLocalRho(const char *name, runModeType type);
	33	virtual ~AliAnalysisTaskLocalRho();
	34	// setting up the task and technical aspects
	35	void ExecOnce();
	36	Bool_t InitializeAnalysis();
	37	virtual void UserCreateOutputObjects();
	38	TH1F* BookTH1F(const char* name, const char* x, Int_t bins, Double_t min, Double_t max, Int_t c = -1, Bool_t append = kTRUE);
	39	TH2F* BookTH2F(const char* name, const char* x, const char* y, Int_t binsx, Double_t minx, Double_t maxx,
	40	Int_t binsy, Double_t miny, Double_t maxy, Int_t c = -1, Bool_t append = kTRUE);
	41	virtual Bool_t Run();
	42	/* inline */ Double_t PhaseShift(Double_t x) const {
	43	while (x>=TMath::TwoPi())x-=TMath::TwoPi();
	44	while (x<0.)x+=TMath::TwoPi();
	45	return x; }
	46	/* inline */ Double_t PhaseShift(Double_t x, Double_t n) const {
	47	x = PhaseShift(x);
	48	if(TMath::Nint(n)==2) while (x>TMath::Pi()) x-=TMath::Pi();
	49	if(TMath::Nint(n)==3) {
	50	if(x>2.*TMath::TwoPi()/n) x = TMath::TwoPi() - x;
	51	if(x>TMath::TwoPi()/n) x = TMath::TwoPi()-(x+TMath::TwoPi()/n);
	52	}
	53	return x; }
	54	/* inline */ Double_t ChiSquarePDF(Int_t ndf, Double_t x) const {
	55	Double_t n(ndf/2.), denom(TMath::Power(2, n)*TMath::Gamma(n));
	56	if (denom!=0) return ((1./denom)TMath::Power(x, n-1)TMath::Exp(-x/2.));
	57	return -999; }
	58	// the cdf of the chisquare distribution is the normalized lower incomplete gamma function
	59	/* inline */ Double_t ChiSquareCDF(Int_t ndf, Double_t x) const { return TMath::Gamma(ndf/2., x/2.); }
	60	// setters - setup how to run
	61	void SetDebugMode(Int_t d) {fDebug = d;}
	62	void SetCentralityClasses(TArrayI* c) {fCentralityClasses = c;}
	63	void SetAttachToEvent(Bool_t a) {fAttachToEvent = a;}
	64	void SetUseScaledRho(Bool_t s) {fUseScaledRho = s;}
	65	void SetFillHistograms(Bool_t b) {fFillHistograms = b;}
	66	// setters - analysis details
	67	void SetNoEventWeightsForQC(Bool_t e) {fNoEventWeightsForQC = e;}
	68	void SetIntegratedFlow(TH1F* i, TH1F* j) {fUserSuppliedV2 = i; fUserSuppliedV3 = j; }
	69	void SetOnTheFlyResCorrection(TH1F* r2, TH1F* r3) {fUserSuppliedR2 = r2; fUserSuppliedR3 = r3; }
	70	void SetModulationFit(TF1* fit);
	71	void SetModulationFitMinMaxP(Float_t m, Float_t n) {fMinPvalue = m; fMaxPvalue = n; }
	72	void SetModulationFitType(fitModulationType type) {fFitModulationType = type; }
	73	void SetQCnRecoveryType(qcRecovery type) {fQCRecovery = type; }
	74	void SetModulationFitOptions(TString opt) {fFitModulationOptions = opt; }
	75	void SetReferenceDetector(detectorType type) {fDetectorType = type; }
	76	void SetUsePtWeight(Bool_t w) {fUsePtWeight = w; }
	77	void SetRunModeType(runModeType type) {fRunModeType = type; }
	78	void SetForceAbsVnHarmonics(Bool_t f) {fAbsVnHarmonics = f; }
	79	void SetExcludeLeadingJetsFromFit(Float_t n) {fExcludeLeadingJetsFromFit = n; }
	80	void SetRebinSwapHistoOnTheFly(Bool_t r) {fRebinSwapHistoOnTheFly = r; }
	81	void SetSaveThisPercentageOfFits(Float_t p) {fPercentageOfFits = p; }
	82	void SetUseV0EventPlaneFromHeader(Bool_t h) {fUseV0EventPlaneFromHeader = h;}
	83	void SetSoftTrackMinMaxPt(Float_t min, Float_t max) {fSoftTrackMinPt = min; fSoftTrackMaxPt = max;}
	84	// getters
	85	TString GetLocalRhoName() const {return fLocalRhoName; }
	86	// numerical evaluations
87	void CalculateEventPlaneVZERO(Double_t vzero[2][2]) const;
88	void CalculateEventPlaneTPC(Double_t* tpc);
89	void CalculateEventPlaneCombinedVZERO(Double_t* comb) const;
90	Double_t CalculateQC2(Int_t harm);
91	Double_t CalculateQC4(Int_t harm);
92	// helper calculations for the q-cumulant analysis, also used by AliAnalyisTaskJetFlow
93	void QCnQnk(Int_t n, Int_t k, Double_t &reQ, Double_t &imQ);
94	Double_t QCnS(Int_t i, Int_t j);
95	Double_t QCnM();
96	Double_t QCnM11();
97	Double_t QCnM1111();
98	Bool_t QCnRecovery(Double_t psi2, Double_t psi3);
99	// analysis details
100	Bool_t CorrectRho(Double_t psi2, Double_t psi3);
101	void FillEventPlaneHistograms(Double_t psi2, Double_t psi3) const;
102	void FillAnalysisSummaryHistogram() const;
103	// track selection
104	/* inline / Bool_t PassesCuts(AliVTrack track) const { return AcceptTrack(track, 0);}
105	/* inline / Bool_t PassesCuts(AliEmcalJet jet) { return AcceptJet(jet, 0);}
106	virtual void Terminate(Option_t* option);
5ce0dc6d	107
9239b066	108	private:
	109	Int_t fDebug; // debug level (0 none, 1 fcn calls, 2 verbose)
	110	Bool_t fInitialized; //! is the analysis initialized?
	111	Bool_t fAttachToEvent; // attach local rho to the event
	112	Bool_t fFillHistograms; // fill qa histograms
	113	Bool_t fNoEventWeightsForQC; // don't store event weights for qc analysis
	114	Bool_t fUseScaledRho; // use scaled rho
	115	TArrayI* fCentralityClasses; // centrality classes (maximum 10) used for QA
	116	TH1F* fUserSuppliedV2; // histo with integrated v2
	117	TH1F* fUserSuppliedV3; // histo with integrated v3
	118	TH1F* fUserSuppliedR2; // correct the extracted v2 with this r
	119	TH1F* fUserSuppliedR3; // correct the extracted v3 with this r
	120	Int_t fNAcceptedTracks; //! number of accepted tracks
	121	Int_t fNAcceptedTracksQCn; //! accepted tracks for QCn
	122	Int_t fInCentralitySelection; //! centrality bin, only for QA plots
	123	fitModulationType fFitModulationType; // fit modulation type
	124	qcRecovery fQCRecovery; // recovery type for e-by-e qc method
	125	Bool_t fUsePtWeight; // use dptdphi instead of dndphi
	126	detectorType fDetectorType; // type of detector used for modulation fit
	127	TString fFitModulationOptions; // fit options for modulation fit
	128	runModeType fRunModeType; // run mode type
	129	TF1* fFitModulation; // modulation fit for rho
	130	Float_t fMinPvalue; // minimum value of p
	131	Float_t fMaxPvalue; // maximum value of p
	132	// additional jet cuts (most are inherited)
	133	Float_t fLocalJetMinEta; // local eta cut for jets
	134	Float_t fLocalJetMaxEta; // local eta cut for jets
	135	Float_t fLocalJetMinPhi; // local phi cut for jets
	136	Float_t fLocalJetMaxPhi; // local phi cut for jets
	137	Float_t fSoftTrackMinPt; // min pt for soft tracks
	138	Float_t fSoftTrackMaxPt; // max pt for soft tracks
	139	// general qa histograms
	140	TH1F* fHistPvalueCDF; //! cdf value of chisquare p
	141	// general settings
	142	Bool_t fAbsVnHarmonics; // force postive local rho
	143	Float_t fExcludeLeadingJetsFromFit; // exclude n leading jets from fit
	144	Bool_t fRebinSwapHistoOnTheFly; // rebin swap histo on the fly
	145	Float_t fPercentageOfFits; // save this percentage of fits
	146	Bool_t fUseV0EventPlaneFromHeader; // use the vzero event plane from the header
	147	// transient object pointers
	148	TList* fOutputList; //! output list
	149	TList* fOutputListGood; //! output list for local analysis
	150	TList* fOutputListBad; //! output list for local analysis
	151	TH1F* fHistSwap; //! swap histogram
	152	TH1F* fHistAnalysisSummary; //! flags
	153	TProfile* fProfV2; //! extracted v2
	154	TProfile* fProfV2Cumulant; //! v2 cumulant
	155	TProfile* fProfV3; //! extracted v3
	156	TProfile* fProfV3Cumulant; //! v3 cumulant
	157	TH1F* fHistPsi2[10]; //! psi 2
	158	TH1F* fHistPsi3[10]; //! psi 3
5ce0dc6d	159
9239b066	160	AliAnalysisTaskLocalRho(const AliAnalysisTaskLocalRho&); // not implemented
9239b066	161	AliAnalysisTaskLocalRho& operator=(const AliAnalysisTaskLocalRho&); // not implemented
5ce0dc6d	162
9239b066	163	ClassDef(AliAnalysisTaskLocalRho, 4);
5ce0dc6d	164	};
5ce0dc6d	165	#endif