OverlapRemovalTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2022 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ASSOCIATIONUTILS_OVERLAPREMOVALTOOL_H
#define ASSOCIATIONUTILS_OVERLAPREMOVALTOOL_H
 
// Framework includes
#include "AsgTools/AsgTool.h"
#include "AsgTools/ToolHandle.h"
 
// Columnar includes
#include "ColumnarCore/ParticleDef.h"
 
// Local includes
#include "AssociationUtils/IOverlapRemovalTool.h"
#include "AssociationUtils/IOverlapTool.h"
#include "AssociationUtils/OverlapRemovalDefs.h"
#include "AssociationUtils/OverlapDecorationHelper.h"
 
 
namespace ORUtils
{

  class OverlapRemovalTool : public virtual IOverlapRemovalTool,
                             public asg::AsgTool
  {

      ASG_TOOL_CLASS(OverlapRemovalTool, IOverlapRemovalTool)
 
    public:

      OverlapRemovalTool(const std::string& name);

      virtual StatusCode initialize() override;

      virtual StatusCode
      removeOverlaps(const xAOD::ElectronContainer* electrons,
                     const xAOD::MuonContainer* muons,
                     const xAOD::JetContainer* jets,
                     const xAOD::TauJetContainer* taus = 0,
                     const xAOD::PhotonContainer* photons = 0,
                     const xAOD::JetContainer* fatJets = 0) const override;
 
    private:

      StatusCode removeOverlap(const ToolHandle<IOverlapTool>& tool,
                               const xAOD::IParticleContainer* cont1,
                               const xAOD::IParticleContainer* cont2) const;
 
    private:
 
      //
      // Configurable properties
      //

      std::string m_inputLabel;
      std::string m_outputLabel;

      bool m_outputPassValue;

      bool m_requireExpectedPointers;
 
      //
      // Helper utilities
      //

      std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle1>> m_decHelper;
 
      //
      // Overlap tool handles
      //

      ToolHandle<IOverlapTool> m_eleEleORT;

      ToolHandle<IOverlapTool> m_eleMuORT;

      ToolHandle<IOverlapTool> m_eleJetORT;

      ToolHandle<IOverlapTool> m_muJetORT;

      ToolHandle<IOverlapTool> m_tauEleORT;

      ToolHandle<IOverlapTool> m_tauMuORT;

      ToolHandle<IOverlapTool> m_tauJetORT;

      ToolHandle<IOverlapTool> m_phoEleORT;

      ToolHandle<IOverlapTool> m_phoMuORT;

      ToolHandle<IOverlapTool> m_phoJetORT;

      ToolHandle<IOverlapTool> m_eleFatJetORT;

      ToolHandle<IOverlapTool> m_jetFatJetORT;
 
  }; // class OverlapRemovalTool
 
} // namespace ORUtils
 
#endif