ORUtils::MuJetGhostDRMatcher Class Reference

Matches a muon to a jet via ghost association or a delta-R. More...

#include <MuJetGhostDRMatcher.h>

Inheritance diagram for ORUtils::MuJetGhostDRMatcher:

Collaboration diagram for ORUtils::MuJetGhostDRMatcher:

Public Member Functions
	MuJetGhostDRMatcher (double dR, bool useRapidity=true)
	Constructor takes same arguments as the DeltaRMatcher.
virtual StatusCode	setObjectTypes (xAODType::ObjectType type1, xAODType::ObjectType type2) override
	Set the object types to be used in the association.
virtual bool	objectsMatch (columnar::Particle1Id mu, columnar::Particle2Id jet, bool swapArgs=false) const override
	Check for a match via ghost association or delta-R.
bool	objectsMatch (columnar::Particle2Id p2, columnar::Particle1Id p1) const
void	setLevel (MSG::Level lvl)
	Change the current logging level.
Functions providing the same interface as AthMessaging
bool	msgLvl (const MSG::Level lvl) const
	Test the output level of the object.
MsgStream &	msg () const
	The standard message stream.
MsgStream &	msg (const MSG::Level lvl) const
	The standard message stream.

Private Types
using	MyTrackDef = columnar::VariantContainerId<columnar::ContainerId::track0,columnar::ContainerId::track0, columnar::ContainerId::track1>
	IDTrack type.

Private Member Functions
void	initMessaging () const
	Initialize our message level and MessageSvc.

Private Attributes
std::unique_ptr< IParticleAssociator >	m_drMatcher
	The delta-R matcher.
columnar::Particle1Accessor< columnar::ObjectLink< MyTrackDef > >	m_muonTrkAcc {*this, "inDetTrackParticleLink"}
columnar::Particle2Accessor< std::vector< columnar::LinkCastColumn< MyTrackDef, xAOD::IParticleContainer > > >	m_ghostAcc {*this, "GhostTrack"}
std::string	m_nm
	Message source name.
boost::thread_specific_ptr< MsgStream >	m_msg_tls
	MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * >	m_imsg { nullptr }
	MessageSvc pointer.
std::atomic< MSG::Level >	m_lvl { MSG::NIL }
	Current logging level.
std::atomic_flag m_initialized	ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
	Messaging initialized (initMessaging)

Detailed Description

Matches a muon to a jet via ghost association or a delta-R.

Ghost association is done by looking for the muon's ID track in the jet's list of ghost tracks. The Delta-R matching is implemented via the DeltaRMatcher. The final result is a match if either the ghost association or the delta-R succeeds.

Author

Steve Farrell Steve.nosp@m.n.Fa.nosp@m.rrell.nosp@m.@cer.nosp@m.n.ch

Definition at line 37 of file MuJetGhostDRMatcher.h.

Member Typedef Documentation

MyTrackDef

using ORUtils::MuJetGhostDRMatcher::MyTrackDef = columnar::VariantContainerId<columnar::ContainerId::track0,columnar::ContainerId::track0, columnar::ContainerId::track1>

private

IDTrack type.

Definition at line 60 of file MuJetGhostDRMatcher.h.

Constructor & Destructor Documentation

MuJetGhostDRMatcher()

ORUtils::MuJetGhostDRMatcher::MuJetGhostDRMatcher	(	double	dR,
		bool	useRapidity = true )

Constructor takes same arguments as the DeltaRMatcher.

Definition at line 23 of file MuJetGhostDRMatcher.cxx.

    : asg::AsgMessaging("MuJetGhostDRMatcher"),
      m_drMatcher (std::make_unique<DeltaRMatcher>(dR, useRapidity))
  {
    addSubtool (*m_drMatcher.get());
  }

Member Function Documentation

initMessaging()

void AthMessaging::initMessaging ( ) const

privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

msg() [1/2]

MsgStream & asg::AsgMessaging::msg ( ) const

inherited

The standard message stream.

Returns

A reference to the default message stream of this object.

Definition at line 49 of file AsgMessaging.cxx.

                                      {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg();
#else // not XAOD_STANDALONE
      return m_msg;
#endif // not XAOD_STANDALONE
   }

msg() [2/2]

MsgStream & asg::AsgMessaging::msg ( const MSG::Level lvl ) const

inherited

The standard message stream.

Parameters

lvl	The message level to set the stream to

Returns

A reference to the default message stream, set to level "lvl"

Definition at line 57 of file AsgMessaging.cxx.

                                                          {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msg( lvl );
#else // not XAOD_STANDALONE
      m_msg << lvl;
      return m_msg;
#endif // not XAOD_STANDALONE
   }

msgLvl()

bool asg::AsgMessaging::msgLvl ( const MSG::Level lvl ) const

inherited

Test the output level of the object.

Parameters

lvl	The message level to test against

Returns

boolean Indicting if messages at given level will be printed

true If messages at level "lvl" will be printed

Definition at line 41 of file AsgMessaging.cxx.

                                                       {
#ifndef XAOD_STANDALONE
      return ::AthMessaging::msgLvl( lvl );
#else // not XAOD_STANDALONE
      return m_msg.msgLevel( lvl );
#endif // not XAOD_STANDALONE
   }

objectsMatch() [1/2]

bool ORUtils::IParticleAssociator::objectsMatch ( columnar::Particle2Id p2, columnar::Particle1Id p1 ) const

inlineinherited

Definition at line 37 of file IObjectAssociator.h.

      { return objectsMatch(p1, p2, true); }

objectsMatch() [2/2]

bool ORUtils::MuJetGhostDRMatcher::objectsMatch ( columnar::Particle1Id mu, columnar::Particle2Id jet, bool swapArgs = false ) const

overridevirtual

Check for a match via ghost association or delta-R.

Implements ORUtils::IParticleAssociator.

Definition at line 51 of file MuJetGhostDRMatcher.cxx.

  {
    if (swapArgs) {
      ATH_MSG_WARNING("MuJetGhostDRMatcher does not support swapped args");
      return false;
    }
 
    // Check the particle types. First particle should be the muon,
    // and the second particle should be the jet.
    if constexpr (columnar::ColumnarModeDefault::isXAOD)
    {
      if(mu.getXAODObject().type() != xAOD::Type::Muon) {
        ATH_MSG_WARNING("First particle arg to objectsMatch is not a muon!");
        return false;
      }
      if(jet.getXAODObject().type() != xAOD::Type::Jet) {
        ATH_MSG_WARNING("Second particle arg to objectsMatch is not a jet!");
        return false;
      }
    }
 
    // Try the delta-R match first.
    if(m_drMatcher->objectsMatch(mu, jet)) {
      ATH_MSG_DEBUG("  Found a dR association");
      return true;
    }
 
    // Retrieve the muon's ID track, or bail if none available.
    auto muTrk = mu(m_muonTrkAcc).opt_value();
    if(!muTrk) return false;
 
    // Search for the muon ID track in the list of ghosts.
    for(const auto ghostLink : m_ghostAcc(jet)) {
      if(ghostLink.has_value() && muTrk == ghostLink) {
        ATH_MSG_DEBUG("  Found a ghost association!");
        return true;
      }
    }
 
    return false;
  }

setLevel()

void AthMessaging::setLevel ( MSG::Level lvl )

inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

{
  m_lvl = lvl;
}

setObjectTypes()

StatusCode ORUtils::MuJetGhostDRMatcher::setObjectTypes ( xAODType::ObjectType type1, xAODType::ObjectType type2 )

overridevirtual

Set the object types to be used in the association.

Implements ORUtils::IParticleAssociator.

Definition at line 32 of file MuJetGhostDRMatcher.cxx.

  {
    if (type1 != xAOD::Type::Muon) {
      ATH_MSG_ERROR("First particle arg to setObjectTypes is not a muon!");
      return StatusCode::FAILURE;
    }
    if (type2 != xAOD::Type::Jet) {
      ATH_MSG_ERROR("Second particle arg to setObjectTypes is not a jet!");
      return StatusCode::FAILURE;
    }
    ATH_CHECK (m_drMatcher->setObjectTypes(type1, type2));
    addSubtool (*m_drMatcher.get());
    return StatusCode::SUCCESS;
  }

Member Data Documentation

ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT

mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

m_drMatcher

std::unique_ptr<IParticleAssociator> ORUtils::MuJetGhostDRMatcher::m_drMatcher

private

The delta-R matcher.

Definition at line 57 of file MuJetGhostDRMatcher.h.

m_ghostAcc

columnar::Particle2Accessor<std::vector<columnar::LinkCastColumn<MyTrackDef,xAOD::IParticleContainer> > > ORUtils::MuJetGhostDRMatcher::m_ghostAcc {*this, "GhostTrack"}

private

Definition at line 65 of file MuJetGhostDRMatcher.h.

{*this, "GhostTrack"};

m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

{ nullptr };

m_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }

mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

{ MSG::NIL };

m_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls

mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.h.

m_muonTrkAcc

columnar::Particle1Accessor<columnar::ObjectLink<MyTrackDef> > ORUtils::MuJetGhostDRMatcher::m_muonTrkAcc {*this, "inDetTrackParticleLink"}

private

Definition at line 62 of file MuJetGhostDRMatcher.h.

{*this, "inDetTrackParticleLink"};

m_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

---

The documentation for this class was generated from the following files:

• MuJetGhostDRMatcher.h
• MuJetGhostDRMatcher.cxx