MuJetOverlapTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ASSOCIATIONUTILS_MUJETOVERLAPTOOL_H
#define ASSOCIATIONUTILS_MUJETOVERLAPTOOL_H
 
// Framework includes
#include "AsgDataHandles/ReadHandleKey.h"
 
// EDM includes
#include "xAODMuon/MuonContainer.h"
#include "xAODJet/JetContainer.h"
#include "xAODTracking/VertexContainer.h"
 
// Columnar includes
#include "ColumnarCore/ObjectColumn.h"
#include "ColumnarCore/VectorColumn.h"
#include "ColumnarJet/JetDef.h"
#include "ColumnarMuon/MuonDef.h"
#include "ColumnarTracking/TrackDef.h"
 
// Local includes
#include "AssociationUtils/IOverlapTool.h"
#include "AssociationUtils/BaseOverlapTool.h"
#include "AssociationUtils/IObjectAssociator.h"
#include "AssociationUtils/FEMatcher.h"
 
namespace ADD_CMODE(ORUtils)
{

  class MuJetOverlapTool : public virtual IOverlapTool,
                           public BaseOverlapTool
  {

      ASG_TOOL_CLASS(MuJetOverlapTool, IOverlapTool)
 
    public:

      MuJetOverlapTool(const std::string& name);

      virtual StatusCode
      findOverlaps(columnar::Particle1Range cont1,
                   columnar::Particle2Range cont2,
                   columnar::EventContextId eventContext) const override;

      virtual StatusCode
      internalFindOverlaps(columnar::Particle1Range muons,
                           columnar::Particle2Range jets,
                           columnar::EventContextId eventContext) const;
 
    protected:

      virtual StatusCode initializeDerived() override;
 
    protected:

      std::optional<std::size_t> getPrimVtxIdx(columnar::EventContextId eventContext) const;

      int getNumTracks(columnar::Particle2Id jet, size_t vtxIdx) const;

      float getSumTrackPt(columnar::Particle2Id jet, size_t vtxIdx) const;
 
    private:


      std::string m_bJetLabel;

      int m_numJetTrk;
      bool m_applyRelPt;
      float m_muJetPtRatio;
      float m_muJetTrkPtRatio;

      std::string m_jetNumTrkDec;
      std::string m_jetSumTrkPtDec;

      bool m_useGhostAssociation;

      float m_innerDR;
      float m_outerDR;

      bool m_useSlidingDR;
      double m_slidingDRC1;
      double m_slidingDRC2;
      double m_slidingDRMaxCone;

      bool m_useRapidity;

      bool m_useFEOR;

      std::string m_PVContName;
 
      // Allow no PVs in the event
      bool m_allowNoPV;

      struct Accessors final : columnar::ColumnarTool<>
      {
        columnar::Track0Accessor<columnar::ObjectColumn> m_track0Acc {*this, "InDetTrackParticles"};
        columnar::Track1Accessor<columnar::ObjectColumn> m_track1Acc {*this, "InDetForwardTrackParticles"};
        columnar::Particle1Accessor<float> m_muonPtAcc {*this, "pt"};
        columnar::Particle2Accessor<float> m_jetPtAcc {*this, "pt"};
        columnar::Particle2Accessor<int> m_jetNumTrkAcc;
        columnar::Particle2Accessor< std::vector<int> > m_jetNumTrkPt500Acc;
        columnar::Particle2Accessor<int> m_jetSumTrkPtAcc;
        columnar::Particle2Accessor< std::vector<float> > m_jetSumTrkPt500Acc;
        columnar::VertexAccessor<columnar::ObjectColumn> m_vtxContainerAcc;
        columnar::VertexAccessor<columnar::RetypeColumn<xAOD::VxType::VertexType,short>> m_vertexTypeAcc {*this, "vertexType"};
        using ColumnarTool::ColumnarTool;
      };
      std::unique_ptr<Accessors> m_accessors {std::make_unique<Accessors> (this)};
 
      SG::ReadHandleKey<xAOD::MissingETAssociationMap> m_feMapKey{
        this, "FEAssociationMap", "FEAssociationMap", "Flow element association map"
      };



      columnar::Particle2Accessor<char> m_bJetAcc;

      std::unique_ptr<IParticleAssociator> m_dRMatchCone1;
      std::unique_ptr<IParticleAssociator> m_dRMatchCone2;
      // Flow element matcher
      std::unique_ptr<FEMatcher> m_FEMatcher;

 
  }; // class MuJetOverlapTool
 
} // namespace ADD_CMODE(ORUtils)
 
#endif