PWG/FLOW/Tasks/AliAnalysisTaskMultiparticleCorrelations.h

   1 /*
   2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved.
   3  * See cxx source for full Copyright notice
   4  * $Id$
   5  */
   6
   7 /****************************************
   8  * analysis task for flow analysis with *
   9  *     multi-particle correlations      *
  10  *                                      *
  11  * author: Ante Bilandzic               *
  12  *         (abilandzic@gmail.com)       *
  13  ***************************************/
  14
  15 #ifndef ALIANALYSISTASKMULTIPARTICLECORRELATIONS_H
  16 #define ALIANALYSISTASKMULTIPARTICLECORRELATIONS_H
  17
  18 #include "AliAnalysisTaskSE.h"
  19 #include "AliFlowAnalysisWithMultiparticleCorrelations.h"
  20 #include "AliFlowEventSimple.h"
  21
  22 //================================================================================================================
  23
  24 class AliAnalysisTaskMultiparticleCorrelations : public AliAnalysisTaskSE{
  25  public:
  26   AliAnalysisTaskMultiparticleCorrelations();
  27   AliAnalysisTaskMultiparticleCorrelations(const char *name, Bool_t useParticleWeights=kFALSE);
  28   virtual ~AliAnalysisTaskMultiparticleCorrelations(){};
  29
  30   virtual void UserCreateOutputObjects();
  31   virtual void UserExec(Option_t *option);
  32   virtual void Terminate(Option_t *);
  33
  34   // Internal flags:
  35   void SetMinNoRPs(Int_t const min) {fUseInternalFlags = kTRUE; this->fMinNoRPs = min;};
  36   Int_t GetMinNoRPs() const {return this->fMinNoRPs;};
  37   void SetMaxNoRPs(Int_t const max) {fUseInternalFlags = kTRUE; this->fMaxNoRPs = max;};
  38   Int_t GetMaxNoRPs() const {return this->fMaxNoRPs;};
  39   void SetExactNoRPs(Int_t const exact) {fUseInternalFlags = kTRUE; this->fExactNoRPs = exact;};
  40   Int_t GetExactNoRPs() const {return this->fExactNoRPs;};
  41
  42   // Control histograms:
  43   void SetFillControlHistograms(Bool_t const fch) {this->fFillControlHistograms = fch;};
  44   Bool_t GetFillControlHistograms() const {return this->fFillControlHistograms;};
  45   void SetFillKinematicsHist(Bool_t const fkh) {this->fFillKinematicsHist = fkh;};
  46   Bool_t GetFillKinematicsHist() const {return this->fFillKinematicsHist;};
  47   void SetFillMultDistributionsHist(Bool_t const mdh) {this->fFillMultDistributionsHist = mdh;};
  48   Bool_t GetFillMultDistributionsHist() const {return this->fFillMultDistributionsHist;};
  49   void SetFillMultCorrelationsHist(Bool_t const mch) {this->fFillMultCorrelationsHist = mch;};
  50   Bool_t GetFillMultCorrelationsHist() const {return this->fFillMultCorrelationsHist;};
  51
  52   // Q-vectors:
  53   void SetCalculateQvector(Bool_t const cqv) {this->fCalculateQvector = cqv;};
  54   Bool_t GetCalculateQvector() const {return this->fCalculateQvector;};
  55   void SetCalculateDiffQvectors(Bool_t const cdqv) {this->fCalculateDiffQvectors = cdqv;};
  56   Bool_t GetCalculateDiffQvectors() const {return this->fCalculateDiffQvectors;};
  57
  58   // Weights:
  59   void SetWeightsHist(TH1D* const hist, const char *type, const char *variable); // .cxx
  60
  61   // Correlations:
  62   void SetCalculateCorrelations(Bool_t const cc) {this->fCalculateCorrelations = cc;};
  63   Bool_t GetCalculateCorrelations() const {return this->fCalculateCorrelations;};
  64   void SetCalculateIsotropic(Bool_t const ci) {this->fCalculateIsotropic = ci;};
  65   Bool_t GetCalculateIsotropic() const {return this->fCalculateIsotropic;};
  66   void SetCalculateSame(Bool_t const csh) {this->fCalculateSame = csh;};
  67   Bool_t GetCalculateSame() const {return this->fCalculateSame;};
  68   void SetSkipZeroHarmonics(Bool_t const szh) {this->fSkipZeroHarmonics = szh;};
  69   Bool_t GetSkipZeroHarmonics() const {return this->fSkipZeroHarmonics;};
  70   void SetCalculateSameIsotropic(Bool_t const csi) {this->fCalculateSameIsotropic = csi;};
  71   Bool_t GetCalculateSameIsotropic() const {return this->fCalculateSameIsotropic;};
  72   void SetCalculateAll(Bool_t const ca) {this->fCalculateAll = ca;};
  73   Bool_t GetCalculateAll() const {return this->fCalculateAll;};
  74   void SetDontGoBeyond(Int_t const dgb) {this->fDontGoBeyond = dgb;};
  75   Int_t GetDontGoBeyond() const {return this->fDontGoBeyond;};
  76   void SetCalculateOnlyForHarmonicQC(Bool_t const cofhqc) {this->fCalculateOnlyForHarmonicQC = cofhqc;};
  77   Bool_t GetCalculateOnlyForHarmonicQC() const {return this->fCalculateOnlyForHarmonicQC;};
  78   void SetCalculateOnlyForSC(Bool_t const cofsc) {this->fCalculateOnlyForSC = cofsc;};
  79   Bool_t GetCalculateOnlyForSC() const {return this->fCalculateOnlyForSC;};
  80   void SetCalculateOnlyCos(Bool_t const coc) {this->fCalculateOnlyCos = coc;};
  81   Bool_t GetCalculateOnlyCos() const {return this->fCalculateOnlyCos;};
  82   void SetCalculateOnlySin(Bool_t const cos) {this->fCalculateOnlySin = cos;};
  83   Bool_t GetCalculateOnlySin() const {return this->fCalculateOnlySin;};
  84
  85   // Event-by-event cumulants:
  86   void SetCalculateEbECumulants(Bool_t const cebec) {this->fCalculateEbECumulants = cebec;};
  87   Bool_t GetCalculateEbECumulants() const {return this->fCalculateEbECumulants;};
  88
  89   // Nested loops:
  90   void SetCrossCheckWithNestedLoops(Bool_t const ccwnl) {this->fCrossCheckWithNestedLoops = ccwnl;};
  91   Bool_t GetCrossCheckWithNestedLoops() const {return this->fCrossCheckWithNestedLoops;};
  92   void SetCrossCheckDiffWithNestedLoops(Bool_t const ccdwnl) {this->fCrossCheckDiffWithNestedLoops = ccdwnl;};
  93   Bool_t GetCrossCheckDiffWithNestedLoops() const {return this->fCrossCheckDiffWithNestedLoops;};
  94   void SetCrossCheckDiffCSCOBN(Int_t const cs, Int_t const co, Int_t const bn)
  95   {
  96    this->fCrossCheckDiffCSCOBN[0] = cs; // cos/sin
  97    this->fCrossCheckDiffCSCOBN[1] = co; // correlator order [1p,2p,3p,4p]
  98    this->fCrossCheckDiffCSCOBN[2] = bn; // bin number
  99   };
 100
 101   // 'Standard candles':
 102   void SetCalculateStandardCandles(Bool_t const csc) {this->fCalculateStandardCandles = csc;};
 103   Bool_t GetCalculateStandardCandles() const {return this->fCalculateStandardCandles;};
 104   void SetPropagateErrorSC(Bool_t const pesc) {this->fPropagateErrorSC = pesc;};
 105   Bool_t GetPropagateErrorSC() const {return this->fPropagateErrorSC;};
 106
 107   // Q-cumulants:
 108   void SetCalculateQcumulants(Bool_t const cqc) {this->fCalculateQcumulants = cqc;};
 109   Bool_t GetCalculateQcumulants() const {return this->fCalculateQcumulants;};
 110   void SetHarmonicQC(Int_t const hqc) {this->fHarmonicQC = hqc;};
 111   Int_t GetHarmonicQC() const {return this->fHarmonicQC;};
 112   void SetPropagateErrorQC(Bool_t const peqc) {this->fPropagateErrorQC = peqc;};
 113   Bool_t GetPropagateErrorQC() const {return this->fPropagateErrorQC;};
 114
 115   // Differential correlations:
 116   void SetCalculateDiffCorrelations(Bool_t const cdc) {this->fCalculateDiffCorrelations = cdc;};
 117   Bool_t GetCalculateDiffCorrelations() const {return this->fCalculateDiffCorrelations;};
 118   void SetDiffHarmonics(Int_t order, Int_t *harmonics); // see implementation in .cxx file
 119   void SetCalculateDiffCos(Bool_t const cdc) {this->fCalculateDiffCos = cdc;};
 120   Bool_t GetCalculateDiffCos() const {return this->fCalculateDiffCos;};
 121   void SetCalculateDiffSin(Bool_t const cds) {this->fCalculateDiffSin = cds;};
 122   Bool_t GetCalculateDiffSin() const {return this->fCalculateDiffSin;};
 123   void SetCalculateDiffCorrelationsVsPt(Bool_t const cdcvspt) {this->fCalculateDiffCorrelationsVsPt = cdcvspt;};
 124   Bool_t GetCalculateDiffCorrelationsVsPt() const {return this->fCalculateDiffCorrelationsVsPt;};
 125   void SetUseDefaultBinning(Bool_t const udb) {this->fUseDefaultBinning = udb;};
 126   Bool_t GetUseDefaultBinning() const {return this->fUseDefaultBinning;};
 127   void SetnDiffBins(Int_t const ndb) {this->fnDiffBins = ndb;};
 128   Int_t GetnDiffBins() const {return this->fnDiffBins;};
 129   void SetRangesDiffBins(Double_t* const rdb) {this->fRangesDiffBins = rdb;};
 130   Double_t* GetRangesDiffBins() const {return this->fRangesDiffBins;};
 131
 132  private:
 133   AliAnalysisTaskMultiparticleCorrelations(const AliAnalysisTaskMultiparticleCorrelations& aatqc);
 134   AliAnalysisTaskMultiparticleCorrelations& operator=(const AliAnalysisTaskMultiparticleCorrelations& aatqc);
 135
 136   AliFlowEventSimple *fEvent; // the input event
 137   AliFlowAnalysisWithMultiparticleCorrelations *fMPC; // "multi-particle correlations" object
 138   TList *fHistList; // base list to hold all output object (a.k.a. grandmother of all lists)
 139
 140   // Internal flags:
 141   Bool_t fUseInternalFlags; // use internal flags (automatically set if some internal flag is used)
 142   Int_t fMinNoRPs; // minimum number of RPs required for the analysis
 143   Int_t fMaxNoRPs; // maximum number of RPs allowed for the analysis
 144   Int_t fExactNoRPs; // exact (randomly shuffled) number of RPs selected for the analysis
 145
 146   // Control histograms:
 147   Bool_t fFillControlHistograms;     // fill or not control histograms (by default they are filled)
 148   Bool_t fFillKinematicsHist;        // fill or not fKinematicsHist[2][3]
 149   Bool_t fFillMultDistributionsHist; // fill or not TH1D *fMultDistributionsHist[3]
 150   Bool_t fFillMultCorrelationsHist;  // fill or not TH2D *fMultCorrelationsHist[3]
 151
 152   // Q-vectors:
 153   Bool_t fCalculateQvector;      // to calculate or not to calculate Q-vector components, that's a Boolean...
 154   Bool_t fCalculateDiffQvectors; // to calculate or not to calculate p- and q-vector components, that's a Boolean...
 155
 156   // Weights:
 157   Bool_t fUseWeights[2][3]; // use weights [RP,POI][phi,pt,eta]
 158   TH1D *fWeightsHist[2][3]; // histograms holding weights [RP,POI][phi,pt,eta]
 159
 160   // Correlations:
 161   Bool_t fCalculateCorrelations;      // calculate and store correlations, or perhaps not, if the weather is bad...
 162   Bool_t fCalculateIsotropic;         // calculate only isotropic correlations
 163   Bool_t fCalculateSame;              // calculate only 'same abs harmonics' correlations TBI
 164   Bool_t fSkipZeroHarmonics;          // skip correlations which have some of the harmonicc equal to zero
 165   Bool_t fCalculateSameIsotropic;     // calculate all isotropic correlations in 'same abs harmonic' TBI this can be implemented better
 166   Bool_t fCalculateAll;               // calculate all possible correlations
 167   Int_t  fDontGoBeyond;               // do not go beyond fDontGoBeyond-p correlators
 168   Bool_t fCalculateOnlyForHarmonicQC; // calculate only isotropic correlations in |fHarmonicQC|
 169   Bool_t fCalculateOnlyForSC;         // calculate only correlations needed for 'standard candles'
 170   Bool_t fCalculateOnlyCos;           // calculate only 'cos' correlations
 171   Bool_t fCalculateOnlySin;           // calculate only 'sin' correlations
 172
 173   // Event-by-event cumulants:
 174   Bool_t fCalculateEbECumulants; // calculate and store event-by-event cumulants
 175
 176   // Nested loops:
 177   Bool_t fCrossCheckWithNestedLoops;     // cross-check results with nested loops
 178   Bool_t fCrossCheckDiffWithNestedLoops; // cross-check differential correlators with nested loops
 179   Int_t fCrossCheckDiffCSCOBN[3];        // [0=cos,1=sin][1p,2p,...,4p][binNo]
 180
 181   // 'Standard candles':
 182   Bool_t fCalculateStandardCandles; // calculate and store 'standard candles'
 183   Bool_t fPropagateErrorSC;         // propagate and store error for 'standard candles'
 184
 185   // Q-cumulants:
 186   Bool_t fCalculateQcumulants; // calculate and store Q-cumulants
 187   Int_t fHarmonicQC;           // calculate Q-cumulants in this harmonic (default is 2)
 188   Bool_t fPropagateErrorQC;    // propagate and store error for Q-cumulants
 189
 190   // Differential correlations:
 191   Bool_t fCalculateDiffCorrelations;     // calculate and store differential correlations
 192   Bool_t fCalculateDiffCos;              // calculate and store differential cosine correlations (kTRUE by default)
 193   Bool_t fCalculateDiffSin;              // calculate and store differential sinus correlations (kFALSE by default)
 194   Bool_t fCalculateDiffCorrelationsVsPt; // calculate differential correlations vs pt (default), or vs eta
 195   Bool_t fUseDefaultBinning;             // use default binning in pt or in eta
 196   Int_t fnDiffBins;                      // number of differential bins in pt or in eta (when non-default binning is used)
 197   Double_t *fRangesDiffBins;             // ranges for differential bins in pt or in eta (when non-default binning is used)
 198
 199   ClassDef(AliAnalysisTaskMultiparticleCorrelations,1);
 200
 201 };
 202
 203 //================================================================================================================
 204
 205 #endif
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216