AliEmcalJetTask.h

Go to the documentation of this file.

#ifndef ALIEMCALJETTASK_H
#define ALIEMCALJETTASK_H

/* Copyright(c) 1998-2016, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

class TClonesArray;
class TObjArray;
class AliVEvent;
class AliEmcalJetUtility;

#include "TF1.h"

#include <AliLog.h>

#include "AliAnalysisTaskEmcal.h"
#include "AliFJWrapper.h"
#include "FJ_includes.h"
#include "AliEmcalJet.h"
#include "AliJetContainer.h"
#if !(defined(__CINT__) || defined(__MAKECINT__))
#include "AliEmcalContainerIndexMap.h"
#endif

namespace fastjet {
  class PseudoJet;
}

class AliEmcalJetTask : public AliAnalysisTaskEmcal {
 public:

  typedef AliJetContainer::EJetType_t EJetType_t;
  typedef AliJetContainer::EJetAlgo_t EJetAlgo_t;
  typedef AliJetContainer::ERecoScheme_t ERecoScheme_t;

#if !defined(__CINT__) && !defined(__MAKECINT__)
  typedef fastjet::JetAlgorithm FJJetAlgo;
  typedef fastjet::RecombinationScheme FJRecoScheme;
#endif

  AliEmcalJetTask();
  AliEmcalJetTask(const char *name);
  virtual ~AliEmcalJetTask();

  Bool_t Run();

  void                   SetGhostArea(Double_t gharea)              { if (IsLocked()) return; fGhostArea        = gharea; }
  void                   SetJetsName(const char *n)                 { if (IsLocked()) return; fJetsTag          = n     ; }
  void                   SetJetsTag(const char *n)                  { if (IsLocked()) return; fJetsTag          = n     ; }
  void                   SetJetEtaRange(Double_t emi, Double_t ema) { if (IsLocked()) return; fJetEtaMin        = emi   ; fJetEtaMax = ema; }
  void                   SetJetPhiRange(Double_t pmi, Double_t pma) { if (IsLocked()) return; fJetPhiMin        = pmi   ; fJetPhiMax = pma; }
  void                   SetJetAlgo(EJetAlgo_t a)                   { if (IsLocked()) return; fJetAlgo          = a     ; }
  void                   SetJetType(EJetType_t t)                   { if (IsLocked()) return; fJetType          = t     ; }
  void                   SetLocked()                                { fLocked = kTRUE;}
  void                   SetMinJetArea(Double_t a)                  { if (IsLocked()) return; fMinJetArea       = a     ; }
  void                   SetMinJetPt(Double_t j)                    { if (IsLocked()) return; fMinJetPt         = j     ; }
  void                   SetRecombScheme(ERecoScheme_t scheme)      { if (IsLocked()) return; fRecombScheme     = scheme; }
  void                   SetTrackEfficiency(Double_t t)             { if (IsLocked()) return; fTrackEfficiency  = t     ; }
  void                   SetTrackEfficiencyOnlyForEmbedding(Bool_t b) { if (IsLocked()) return; fTrackEfficiencyOnlyForEmbedding = b     ; }
  void                   SetLegacyMode(Bool_t mode)                 { if (IsLocked()) return; fLegacyMode       = mode  ; }
  void                   SetFillGhost(Bool_t b=kTRUE)               { if (IsLocked()) return; fFillGhost        = b     ; }
  void                   SetRadius(Double_t r)                      { if (IsLocked()) return; fRadius           = r     ; }

  void                   SetEtaRange(Double_t emi, Double_t ema);
  void                   SetMinJetClusPt(Double_t min);
  void                   SetMinJetClusE(Double_t min);
  void                   SetMinJetTrackPt(Double_t min);
  void                   SetPhiRange(Double_t pmi, Double_t pma);

  AliEmcalJetUtility*    AddUtility(AliEmcalJetUtility* utility);

  Double_t               GetGhostArea()                   { return fGhostArea         ; }
  const char*            GetJetsName()                    { return fJetsName.Data()   ; }
  const char*            GetJetsTag()                     { return fJetsTag.Data()    ; }
  Double_t               GetJetEtaMin()                   { return fJetEtaMin         ; }
  Double_t               GetJetEtaMax()                   { return fJetEtaMax         ; }
  Double_t               GetJetPhiMin()                   { return fJetPhiMin         ; }
  Double_t               GetJetPhiMax()                   { return fJetPhiMax         ; }
  UInt_t                 GetJetType()                     { return fJetType           ; }
  UInt_t                 GetJetAlgo()                     { return fJetAlgo           ; }
  Bool_t                 GetLegacyMode()                  { return fLegacyMode        ; }
  Double_t               GetMinJetArea()                  { return fMinJetArea        ; }
  Double_t               GetMinJetPt()                    { return fMinJetPt          ; }
  Int_t                  GetMinMCLabel()                  { return fMinMCLabel        ; }
  Double_t               GetRadius()                      { return fRadius            ; }
  Int_t                  GetRecombScheme()                { return fRecombScheme      ; }
  Double_t               GetTrackEfficiency()             { return fTrackEfficiency   ; }
  Bool_t                 GetTrackEfficiencyOnlyForEmbedding() { return fTrackEfficiencyOnlyForEmbedding; }

  TClonesArray*          GetJets()                        { return fJets              ; }
  TObjArray*             GetUtilities()                   { return fUtilities         ; }

  void                   FillJetConstituents(AliEmcalJet *jet, std::vector<fastjet::PseudoJet>& constituents,
                                             std::vector<fastjet::PseudoJet>& constituents_sub, Int_t flag = 0, TString particlesSubName = "");

  UInt_t                 FindJetAcceptanceType(Double_t eta, Double_t phi, Double_t r);
  
  void                   LoadTrackEfficiencyFunction(const std::string & path, const std::string & name);

  Bool_t                 IsLocked() const;
  void                   SelectCollisionCandidates(UInt_t offlineTriggerMask = AliVEvent::kMB);
  void                   SetType(Int_t t);

  void                   SetFillJetConsituents(Bool_t doFill) { fFillConstituents = doFill; }

  static AliEmcalJetTask* AddTaskEmcalJet(
      const TString nTracks                      = "usedefault",
      const TString nClusters                    = "usedefault",
      const AliJetContainer::EJetAlgo_t jetAlgo  = AliJetContainer::antikt_algorithm,
      const Double_t radius                      = 0.4,
      const AliJetContainer::EJetType_t jetType  = AliJetContainer::kFullJet,
      const Double_t minTrPt                     = 0.15,
      const Double_t minClPt                     = 0.30,
      const Double_t ghostArea                   = 0.005,
      const AliJetContainer::ERecoScheme_t reco  = AliJetContainer::pt_scheme,
      const TString tag                          = "Jet",
      const Double_t minJetPt                    = 0.,
      const Bool_t lockTask                      = kTRUE,
      const Bool_t bFillGhosts                   = kFALSE
    );

#if !defined(__CINT__) && !defined(__MAKECINT__)
  static FJJetAlgo       ConvertToFJAlgo(EJetAlgo_t algo);
  static FJRecoScheme    ConvertToFJRecoScheme(ERecoScheme_t reco);
#endif

 protected:

  Int_t                  FindJets();
  void                   FillJetBranch();
  void                   ExecOnce();
  void                   InitEvent();
  void                   InitUtilities();
  void                   PrepareUtilities();
  void                   ExecuteUtilities(AliEmcalJet* jet, Int_t ij);
  void                   TerminateUtilities();
  Bool_t                 GetSortedArray(Int_t indexes[], std::vector<fastjet::PseudoJet> array) const;
  Bool_t                 IsJetInEmcal(Double_t eta, Double_t phi, Double_t r);
  Bool_t                 IsJetInDcal(Double_t eta, Double_t phi, Double_t r);
  Bool_t                 IsJetInDcalOnly(Double_t eta, Double_t phi, Double_t r);
  Bool_t                 IsJetInPhos(Double_t eta, Double_t phi, Double_t r);

  TString                fJetsTag;                

  EJetType_t             fJetType;                
  EJetAlgo_t             fJetAlgo;                
  ERecoScheme_t          fRecombScheme;           
  Double_t               fRadius;                 
  Double_t               fMinJetArea;             
  Double_t               fMinJetPt;               
  Double_t               fJetPhiMin;              
  Double_t               fJetPhiMax;              
  Double_t               fJetEtaMin;              
  Double_t               fJetEtaMax;              
  Double_t               fGhostArea;              
  Double_t               fTrackEfficiency;        
  TObjArray             *fUtilities;              
  Bool_t                 fTrackEfficiencyOnlyForEmbedding; 
  //TF1                    fTrackEfficiencyFunction;///< Function that describes the artificial tracking efficiency to be applied on top of the nominal tracking efficiency, as a function of track pT
  Bool_t                 fApplyArtificialTrackingEfficiency; 
  Bool_t                 fLocked;                 
  Bool_t            fFillConstituents;     

  TString                fJetsName;               
  Bool_t                 fIsInit;                 
  Bool_t                 fIsPSelSet;              
  Bool_t                 fIsEmcPart;              
  Bool_t                 fLegacyMode;             
  Bool_t                 fFillGhost;              

  TClonesArray          *fJets;                   
  AliFJWrapper           fFastJetWrapper;         

  static const Int_t     fgkConstIndexShift;      

#if !(defined(__CINT__) || defined(__MAKECINT__))
  // Handle mapping between index and containers
  AliEmcalContainerIndexMap <AliClusterContainer, AliVCluster> fClusterContainerIndexMap;    
  AliEmcalContainerIndexMap <AliParticleContainer, AliVParticle> fParticleContainerIndexMap; 
#endif

 private:
  AliEmcalJetTask(const AliEmcalJetTask&);            // not implemented
  AliEmcalJetTask &operator=(const AliEmcalJetTask&); // not implemented

  ClassDef(AliEmcalJetTask, 27);
};
#endif