TauTruthMatchingTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef  TAUANALYSISTOOLS_TAUTRUTHMATCHINGTOOL_H
#define  TAUANALYSISTOOLS_TAUTRUTHMATCHINGTOOL_H
 
/*
  author: Dirk Duschinger
  mail: dirk.duschinger@cern.ch
  documentation in: ../README.rst
*/
 
// Local include(s):
#include "TauAnalysisTools/ITauTruthMatchingTool.h"
#include "TauAnalysisTools/BuildTruthTaus.h"
#include "CxxUtils/CachedValue.h"
#include "AsgTools/PropertyWrapper.h"
#include <vector>
#include <string>
 
namespace ADD_CMODE(TauAnalysisTools)
{
 
class TauTruthMatchingTool
  : public virtual BuildTruthTaus
  , public virtual ITauTruthMatchingTool
{
  ASG_TOOL_CLASS2( TauTruthMatchingTool,
                   IBuildTruthTaus,
                   ITauTruthMatchingTool )
 
public:                         // Interface functions
 
  TauTruthMatchingTool( const std::string& name );
 
  virtual ~TauTruthMatchingTool() = default;
 
  // initialize the tool
  virtual StatusCode initialize() override final;
 
  virtual std::unique_ptr<ITruthTausEvent> getEvent() const override final;
 
  // get pointer to the truth matched particle, if no truth particle was found a null pointer is returned
  virtual const xAOD::TruthParticle* getTruth(const xAOD::TauJet& xTau) override final;
  virtual const xAOD::TruthParticle* getTruth(const xAOD::TauJet& xTau,
                                              ITruthTausEvent& truthTausEVent) const override final;
  virtual std::vector<const xAOD::TruthParticle*> getTruth(const std::vector<const xAOD::TauJet*>& vTaus) override final;
 
public:                         // Wrapper functions
  
  // wrapper function to get truth tau visible TLorentzvector
  virtual TLorentzVector getTruthTauP4Vis(const xAOD::TauJet& xTau) override final;
  virtual TLorentzVector getTruthTauP4Vis(const xAOD::TruthParticle& xTruthTau) const override final;
 
  // wrapper function to get truth tau invisible TLorentzvector
  virtual TLorentzVector getTruthTauP4Invis(const xAOD::TauJet& xTau) override final;
  virtual TLorentzVector getTruthTauP4Invis(const xAOD::TruthParticle& xTruthTau) const override final;
 
  // function to check if a reconstructed electron or muon is matched to a true tau 
  bool matchTruthLeptonicTauDecay(const xAOD::IParticle* p, const xAOD::TruthParticleContainer* truth_taus);
 
  // get type of truth match particle (hadronic tau, leptonic tau, electron, muon, jet)
  virtual TauAnalysisTools::TruthMatchedParticleType getTruthParticleType(const xAOD::TauJet& xTau) override final;
 
  // wrapper function to count number of decay particles of given pdg id
  virtual int getNTauDecayParticles(const xAOD::TauJet& xTau, int iPdgId, bool bCompareAbsoluteValues = false) override final;
  virtual int getNTauDecayParticles(const xAOD::TruthParticle& xTruthTau, int iPdgId, bool bCompareAbsoluteValues = false) const override final;
 
  // wrapper function to obtain truth verion of xAOD::TauJetParameters::DecayMode
  virtual xAOD::TauJetParameters::DecayMode getDecayMode(const xAOD::TauJet& xTau) override final;
  virtual xAOD::TauJetParameters::DecayMode getDecayMode(const xAOD::TruthParticle& xTruthTau) const override final;

  virtual StatusCode lockDecorations (const xAOD::TauJetContainer& taus) const override final;
 
private:                        // private helper functions
 
  StatusCode findTruthTau(const xAOD::TauJet& xTau,
                          TruthTausEvent& truthTausEvent) const;
  StatusCode checkTruthMatch (const xAOD::TauJet& xTau, const xAOD::TruthParticleContainer& xTauContainer, const TruthTausEvent& truthTausEvent) const;
 
private:                        // steering variables
 
  Gaudi::Property<double> m_dMaxDeltaR{this, "MaxDeltaR", 0.2};
 
  CxxUtils::CachedValue<bool> m_bIsTruthMatchedAvailable;
  CxxUtils::CachedValue<bool> m_bIsTruthParticleLinkAvailable;
 
private:                        // private helper variables
 
  SG::ConstAccessor<double> m_accPtVis;
  SG::ConstAccessor<double> m_accEtaVis;
  SG::ConstAccessor<double> m_accPhiVis;
  SG::ConstAccessor<double> m_accMVis;
 
}; // class TauTruthMatchingTool
 
}
#endif // TAUANALYSISTOOLS_TAUTRUTHMATCHINGTOOL_H