TruthClassificationTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRUTH_CLASSIFICATION__TRUTH_CLASSIFICATION_TOOL_H_
#define TRUTH_CLASSIFICATION__TRUTH_CLASSIFICATION_TOOL_H_
 
#include <string>
 
#include <AsgAnalysisInterfaces/ITruthClassificationTool.h>
#include <AsgTools/AsgTool.h>
#include <xAODEgamma/Electron.h>
#include <xAODMuon/Muon.h>
#include <xAODTruth/TruthParticle.h>
 

class TruthClassificationTool : virtual public ITruthClassificationTool, public asg::AsgTool
{
  ASG_TOOL_CLASS2(TruthClassificationTool, IClassificationTool, ITruthClassificationTool)
 
public:
  explicit TruthClassificationTool(const std::string &type);

  virtual StatusCode classify(const xAOD::IParticle &particle,
                              unsigned int &classification) const override;

  virtual StatusCode classify(const xAOD::IParticle &particle,
                              Truth::Type &classification) const override;
 
private:
  StatusCode classifyElectron(const xAOD::IParticle &electron,
                              Truth::Type &classification) const;

  StatusCode classifyMuon(const xAOD::IParticle &muon,
                          Truth::Type &classification) const;

  bool m_separateChargeFlipElectrons = false;
  bool m_separateChargeFlipMuons = false;

  bool m_useTruthParticleDecorations{false};
 
  // accessors
  const SG::AuxElement::ConstAccessor<int> m_truthType{"truthType"};
  const SG::AuxElement::ConstAccessor<int> m_truthOrigin{"truthOrigin"};
  const SG::AuxElement::ConstAccessor<unsigned int> m_truthClassification{"truthClassification"};
  const SG::AuxElement::ConstAccessor<int> m_truthPdgId{"truthPdgId"};
  const SG::AuxElement::ConstAccessor<unsigned int> m_classifierParticleType{"classifierParticleType"};
  const SG::AuxElement::ConstAccessor<unsigned int> m_classifierParticleOrigin{"classifierParticleOrigin"};
  const SG::AuxElement::ConstAccessor<int> m_firstMotherTruthType{"firstEgMotherTruthType"};
  const SG::AuxElement::ConstAccessor<int> m_firstMotherTruthOrigin{"firstEgMotherTruthOrigin"};
  const SG::AuxElement::ConstAccessor<unsigned int> m_firstMotherTruthClassification{"firstEgMotherTruthClassification"};
  const SG::AuxElement::ConstAccessor<int> m_firstMotherPdgId{"firstEgMotherPdgId"};
  const SG::AuxElement::ConstAccessor<int> m_lastMotherTruthType{"lastEgMotherTruthType"};
  const SG::AuxElement::ConstAccessor<int> m_lastMotherTruthOrigin{"lastEgMotherTruthOrigin"};
  const SG::AuxElement::ConstAccessor<unsigned int> m_lastMotherTruthClassification{"lastEgMotherTruthClassification"};
  const SG::AuxElement::ConstAccessor<int> m_lastMotherPdgId{"lastEgMotherPdgId"};
  const SG::AuxElement::ConstAccessor<int> m_fallbackTruthType{"TruthClassifierFallback_truthType"};
  const SG::AuxElement::ConstAccessor<int> m_fallbackTruthOrigin{"TruthClassifierFallback_truthOrigin"};
  const SG::AuxElement::ConstAccessor<int> m_fallbackTruthClassification{"TruthClassifierFallback_truthClassification"};
  const SG::AuxElement::ConstAccessor<float> m_fallbackDR{"TruthClassifierFallback_dR"};
  
  bool isPromptElectron(const xAOD::IParticle &electron,
                        bool isTruthParticle,
                        const xAOD::TruthParticle *truthParticle) const;
  bool isChargeFlipElectron(const xAOD::IParticle &electron,
                            bool isTruthParticle,
                            const xAOD::TruthParticle *truthParticle) const;
  bool isChargeFlipMuon(const xAOD::IParticle &muon,
                        bool isTruthParticle,
                        const xAOD::TruthParticle *truthParticle) const;

  bool hasBHadronOrigin(int origin) const;
  bool hasCHadronOrigin(int origin) const;
  bool hasLightHadronOrigin(int origin) const;
};
 
#endif  // TRUTH_CLASSIFICATION__TRUTH_CLASSIFICATION_TOOL_H_