AliAnalysisTaskEmcalJetSubstructureTree.h

Go to the documentation of this file.

/************************************************************************************
 * Copyright (C) 2017, Copyright Holders of the ALICE Collaboration                 *
 * All rights reserved.                                                             *
 *                                                                                  *
 * Redistribution and use in source and binary forms, with or without               *
 * modification, are permitted provided that the following conditions are met:      *
 *     * Redistributions of source code must retain the above copyright             *
 *       notice, this list of conditions and the following disclaimer.              *
 *     * Redistributions in binary form must reproduce the above copyright          *
 *       notice, this list of conditions and the following disclaimer in the        *
 *       documentation and/or other materials provided with the distribution.       *
 *     * Neither the name of the <organization> nor the                             *
 *       names of its contributors may be used to endorse or promote products       *
 *       derived from this software without specific prior written permission.      *
 *                                                                                  *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND  *
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED    *
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE           *
 * DISCLAIMED. IN NO EVENT SHALL ALICE COLLABORATION BE LIABLE FOR ANY              *
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES       *
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;     *
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND      *
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS    *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                     *
 ************************************************************************************/
#ifndef ALIANALYSISTASKEMCALJETSUBSTRUCTURETREE_H
#define ALIANALYSISTASKEMCALJETSUBSTRUCTURETREE_H

#include "AliAnalysisTaskEmcalJet.h"
#include <exception>
#include <vector>
#include <string>
#include <TString.h>
#include <fastjet/PseudoJet.hh>
#include <fastjet/JetDefinition.hh>

class TH1;
class THistManager;
class TTree;
class AliClusterContainer;
class AliEmcalJet;
class AliParticleContainer;
class AliTrackContainer;

#define EXPERIMENTAL_JETCONSTITUENTS

namespace EmcalTriggerJets {

struct AliNSubjettinessParameters {
  Double_t fOneSubjettiness;      
  Double_t fTwoSubjettiness;      

  void LinkJetTreeBranches(TTree *jettree, const char *tag);
};

struct AliNSubjettinessDefinition{
  Double_t fBeta;                 
  Double_t fRadius;               
};

struct AliSoftDropParameters {
  Double_t fZg;             
  Double_t fMg;             
  Double_t fRg;             
  Double_t fPtg;            
  Double_t fDeltaR;         
  Double_t fMug;            
  Int_t fNDropped;          

  void LinkJetTreeBranches(TTree *jettree, const char *tag);
};

struct AliSoftdropDefinition {
  Double_t fZ;                              
  Double_t fBeta;                           
  fastjet::JetAlgorithm fRecluserAlgo;      
};

struct AliJetSubstructureSettings {
  AliSoftdropDefinition fSoftdropSettings;
  AliNSubjettinessDefinition fSubjettinessSettings;
};

struct AliJetSubstructureData {
  AliSoftDropParameters fSoftDrop;
  AliNSubjettinessParameters fNsubjettiness;
};

struct AliJetKineParameters {
  Double_t fPt;                              
  Double_t fE;                               
  Double_t fMass;                            
  Double_t fEta;                             
  Double_t fPhi;                             
  Double_t fArea;                            
  Double_t fNEF;                             
  Int_t    fNCharged;                        
  Int_t    fNNeutral;                        
  Double_t fZLeading;                        
  Double_t fZLeadingCharged;                 
  Double_t fZLeadingNeutral;                 

  void LinkJetTreeBranches(TTree *jettree, const char *tag);
};

struct AliJetStructureParameters {
  Double_t fAngularity;                       
  Double_t fPtD;                              

  void LinkJetTreeBranches(TTree *jettree, const char *tag);
};

struct AliJetTreeGlobalParameters {
  Double_t fJetRadius;                        
  Double_t fEventWeight;                      
  Int_t    fTriggerClusterIndex;              
  Double_t fRhoParamters[4];                  

  void LinkJetTreeBranches(TTree *jettree, bool fillRho);
};

class AliAnalysisTaskEmcalJetSubstructureTree : public AliAnalysisTaskEmcalJet {
public:
  class ReclusterizerException : public std::exception {
  public:
    ReclusterizerException() : std::exception() {}
    virtual ~ReclusterizerException() throw() {}

    virtual const char *what() const throw() { return "Error in reclusterizing in fastjet"; }
  };
  class SubstructureException : public std::exception {
  public:
    SubstructureException() : std::exception() {}
    virtual ~SubstructureException() throw() {}

    virtual const char *what() const throw() { return "Error in builing substructure observable"; }
  };
  class SoftDropException : public std::exception {
  public:
    SoftDropException() : std::exception() {}
    virtual ~SoftDropException() throw() {}

    virtual const char *what() const throw() { return "No associated softdrop structure found for jet - softdrop algorithm failing"; }
  };
  enum Reclusterizer_t {
    kCAAlgo = 0,
    kKTAlgo = 1,
    kAKTAlgo = 2
  };

  enum JetRecType_t {
    kDetLevel = 0,
    kPartLevel = 1
  };

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

  void SetTriggerBits(UInt_t triggersel) { fTriggerSelectionBits = triggersel; }
  void SetTriggerString(TString triggerstring) { fTriggerSelectionString = triggerstring; }
  void SetUseDownscaleWeight(Bool_t usedownscale) { fUseDownscaleWeight = usedownscale; }
  void SetGlobalTriggerDecisionContainerName(const char *name) { fNameTriggerDecisionContainer = name; }
  void SetUseTriggerSelectionOnData(bool doUse) { fUseTriggerSelectionForData = doUse; }

  void SetSoftdropDefiniion(Double_t zcut, Double_t betacut, Reclusterizer_t reclusterizer) {
    fSDZCut = zcut;
    fSDBetaCut = betacut;
    fReclusterizer = reclusterizer;
  }

  void SetFillPartLevelBranches(Bool_t doFill) { fFillPart = doFill; }
  void SetFillRhoBranches(Bool_t doFill) { fFillRho = doFill; }
  void SetFillSoftdropBranches(Bool_t doFill) { fFillSoftDrop = doFill; }
  void SetFillNSubjettinessBranches(Bool_t doFill) { fFillNSub = doFill; }
  void SetFillSubstructureBranches(Bool_t doFill) { fFillStructGlob = doFill; }

  void SetUseChargedConstituents(Bool_t doUse) { fUseChargedConstituents = doUse; }
  void SetUseNeutralConstituents(Bool_t doUse) { fUseNeutralConstituents = doUse; }

  void SetHasRecEvent(Bool_t hasrec) { fHasRecEvent = hasrec; }
  void SetHasTrueEvent(Bool_t hastrue) { fHasTrueEvent = hastrue; }

  static AliAnalysisTaskEmcalJetSubstructureTree *AddEmcalJetSubstructureTreeMaker(Bool_t isMC, Bool_t isData, Double_t jetradius, AliJetContainer::EJetType_t jettype, AliJetContainer::ERecoScheme_t recombinationScheme, Bool_t useDCAL, const char *name);

protected:
  virtual void UserCreateOutputObjects();
  virtual bool Run();
  virtual void RunChanged(Int_t newrun);
  virtual void UserExecOnce();
  virtual Bool_t IsTriggerSelected();

  AliJetSubstructureData MakeJetSubstructure(const AliEmcalJet &jet, double jetradius, const AliParticleContainer *tracks, const AliClusterContainer *clusters, const AliJetSubstructureSettings &settings) const;

  AliSoftDropParameters MakeSoftDropParameters(const fastjet::PseudoJet &jet, const AliSoftdropDefinition &cut) const;

  AliNSubjettinessParameters MakeNsubjettinessParameters(const fastjet::PseudoJet &jet, const AliNSubjettinessDefinition &cut) const;
  
  AliJetKineParameters MakeJetKineParameters(const AliEmcalJet &jet, JetRecType_t rectype, const AliParticleContainer *const particles, const AliClusterContainer *const clusters) const;

  Double_t MakeAngularity(const AliEmcalJet &jet, const AliParticleContainer *tracks, const AliClusterContainer *clusters) const;

  Double_t MakePtD(const AliEmcalJet &jet, const AliParticleContainer *const particles, const AliClusterContainer *const clusters) const;

  void FillLuminosity();
  
  void DoConstituentQA(const AliEmcalJet *jet, const AliParticleContainer *tracks, const AliClusterContainer *clusters);

  std::string MatchTrigger(const std::string &triggerclass) const;
  bool IsSelectEmcalTriggers(const std::string &triggerstring) const;

  bool SelectJet(const AliEmcalJet &jet, const AliParticleContainer *particles) const;

private:
  TTree                       *fJetSubstructureTree;        
  AliJetTreeGlobalParameters  *fGlobalTreeParams;           
  AliSoftDropParameters       *fSoftDropMeasured;           
  AliSoftDropParameters       *fSoftDropTrue;               
  AliNSubjettinessParameters  *fNSubMeasured;               
  AliNSubjettinessParameters  *fNSubTrue;                   
  AliJetKineParameters        *fKineRec;                    
  AliJetKineParameters        *fKineSim;                    
  AliJetStructureParameters   *fJetStructureMeasured;       
  AliJetStructureParameters   *fJetStructureTrue;           
  THistManager                *fQAHistos;                   
  TH1                         *fLumiMonitor;                

  Double_t                     fSDZCut;                     
  Double_t                     fSDBetaCut;                  
  Reclusterizer_t              fReclusterizer;              

  Bool_t                       fHasRecEvent;                
  Bool_t                       fHasTrueEvent;               
  UInt_t                       fTriggerSelectionBits;       
  TString                      fTriggerSelectionString;     
  TString                      fNameTriggerDecisionContainer; 
  Bool_t                       fUseTriggerSelectionForData; 
  Bool_t                       fUseDownscaleWeight;         
  Bool_t                       fUseChargedConstituents;     
  Bool_t                       fUseNeutralConstituents;     

  // Fill levels for tree (save disk space when information is not needed)
  Bool_t                       fFillPart;                   
  Bool_t                       fFillRho;                    
  Bool_t                       fFillSoftDrop;               
  Bool_t                       fFillNSub;                   
  Bool_t                       fFillStructGlob;             

  ClassDef(AliAnalysisTaskEmcalJetSubstructureTree, 1);
};

void LinkBranch(TTree *jettree, void *data, const char *branchname, const char *type);

} /* namespace EmcalTriggerJets */

#endif /* ALIANALYSISTASKEMCALJETSUBSTRUCTURETREE_H */