ORUtils::MuJetOverlapTool Class Reference

A tool implementing the recommended mu-jet overlap removal. More...

#include <MuJetOverlapTool.h>

Inheritance diagram for ORUtils::MuJetOverlapTool:

Collaboration diagram for ORUtils::MuJetOverlapTool:

Classes
struct	Accessors
	Columnar accessors. More...

Public Member Functions
	MuJetOverlapTool (const std::string &name)
	Create proper constructor for Athena.
virtual StatusCode	findOverlaps (columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext) const override
	Identify overlapping muons and jets.
virtual StatusCode	internalFindOverlaps (columnar::Particle1Range muons, columnar::Particle2Range jets, columnar::EventContextId eventContext) const
	Identify overlapping muons and jets.
StatusCode	findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2, const EventContext &eventContext=Gaudi::Hive::currentContext()) const
StatusCode	initialize () override final
	Initialize base class functionality.
virtual void	callEvents (columnar::EventContextRange events) const override
	The callEvents() for columnar tools.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
virtual StatusCode	initializeDerived () override
	Initialize the tool.
std::optional< std::size_t >	getPrimVtxIdx (columnar::EventContextId eventContext) const
	Retrieve the primary vertex used to count jet tracks.
int	getNumTracks (columnar::Particle2Id jet, size_t vtxIdx) const
	Get the number of tracks in a jet w.r.t. requested vertex.
float	getSumTrackPt (columnar::Particle2Id jet, size_t vtxIdx) const
	Get the sum trk pt in a jet w.r.t. requested vertex.
template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>
StatusCode	handleOverlap (const columnar::ObjectId< CI1, CM > &testParticle, const columnar::ObjectId< CI2, CM > &refParticle) const
	Common helper method to handle an overlap result.
template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM>
StatusCode	checkForXAODContainer (columnar::ObjectRange< CI, CM > cont, std::string_view message) const
	check whether the container is of the right type
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.
Helper Functions
void	initializeDecorations (columnar::Particle1Range container) const
void	initializeDecorations (columnar::Particle2Range container) const
char	getObjectPriority (columnar::Particle1Id obj) const
char	getObjectPriority (columnar::Particle2Id obj) const
bool	isSurvivingObject (columnar::Particle1Id obj) const
bool	isSurvivingObject (columnar::Particle2Id obj) const
bool	isRejectedObject (columnar::Particle1Id obj) const
bool	isRejectedObject (columnar::Particle2Id obj) const
void	setObjectFail (columnar::Particle1Id obj) const
void	setObjectFail (columnar::Particle2Id obj) const
template<columnar::ContainerIdConcept CI>
StatusCode	addObjectLink (columnar::Particle1Id p1, columnar::ObjectId< CI > p2) const
template<columnar::ContainerIdConcept CI>
StatusCode	addObjectLink (columnar::Particle2Id p1, columnar::ObjectId< CI > p2) const

Protected Attributes
Common configurable properties
std::string	m_inputLabel
	Input object decoration which specifies which objects to look at.
std::string	m_outputLabel
	Output object decoration which specifies overlapping objects.
bool	m_outputPassValue
	Toggle the output flag logic.
bool	m_linkOverlapObjects
	Flag to toggle overlap object links.
bool	m_enableUserPrio
	Enable user-priority scoring.
Utilities
std::unique_ptr< BaseAccessors >	m_baseAccessors {std::make_unique<BaseAccessors> (this)}
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle1 > >	m_decHelper1
	Helper for handling input/output decorations.
std::unique_ptr< OverlapDecorationHelper< columnar::ContainerId::particle2 > >	m_decHelper2
std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle1 > >	m_objLinkHelper1
	Helper for linking overlap objects.
std::unique_ptr< OverlapLinkHelper< columnar::ContainerId::particle2 > >	m_objLinkHelper2

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared
Configurable properties
std::string	m_bJetLabel
	Input jet decoration which labels a bjet.
int	m_numJetTrk
	Minimum number of jet tracks to prioritize the jet.
bool	m_applyRelPt
	Toggle PT ratio criteria TODO: rename to m_applyPtRatio.
float	m_muJetPtRatio
	PT ratio threshold for vetoing the jet.
float	m_muJetTrkPtRatio
	PT ratio threshold for vetoing the jet. Uses sum of jet track PT.
std::string	m_jetNumTrkDec
	Optional user decoration for jet numTrack of type 'int'.
std::string	m_jetSumTrkPtDec
	Optional user decoration for jet sumTrackPT of type 'float'.
bool	m_useGhostAssociation
	Use ghost association in matching to remove jets.
float	m_innerDR
	Inner dR cone within which jets get removed.
float	m_outerDR
	Outer dR cone within which muons get removed.
bool	m_useSlidingDR
	Toggle sliding dR overlap removal for removing muons.
double	m_slidingDRC1
	C1, the constant offset in sliding dR.
double	m_slidingDRC2
	C1, the inverse pt factor in sliding dR.
double	m_slidingDRMaxCone
	MaxCone, the upper limit of the sliding cone.
bool	m_useRapidity
	Calculate deltaR using rapidity.
std::string	m_PVContName
	PV Container to use.
bool	m_allowNoPV
std::unique_ptr< Accessors >	m_accessors {std::make_unique<Accessors> (this)}
Utilities
columnar::Particle2Accessor< char >	m_bJetAcc
	BJet helper.
std::unique_ptr< IParticleAssociator >	m_dRMatchCone1
	Delta-R matcher for the inner cone.
std::unique_ptr< IParticleAssociator >	m_dRMatchCone2
	Delta-R matcher for the outer cone.

Detailed Description

A tool implementing the recommended mu-jet overlap removal.

This tool takes muons and jets and removes their overlaps based on various criteria including delta-R, jet track multiplicity, mu/jet PT ratio, and btagging results.

The procedure works as follows.

1. Remove non-btagged jets that overlap with muons.
   • Matching is done with ghost association or flat delta-R.
   • Jets are then rejected if they have low track multiplicity or if the muon has sufficient PT relative to the jet.
2. Remove muons from remaining non-pileup jets.
   • Matching is done with either a flat delta-R or with the sliding delta-R cone (c1 + c2/pt).

To determine jet track multiplicity, the primary vertex is retrieved and used to query the NumTrkPt500 jet attribute.

Some special configuration properties UseSlidingDR - activate sliding dR cone (c1 + c2/muPt) SlidingDRC1 - c1 constant for sliding dR (default 0.04) SlidingDRC2 - c2 constant for sliding dR (default 10GeV) SlidingDRMaxCone - max cone size cutoff for sliding dR (default off) NumJetTrk - number of tracks required to give priorty to jet and remove the muon.

Todo

TODO document all the new properties!

These properties are useful for specifying PV-related quantities so that the tool doesn't need to retrieve the PV: JetNumTrackDecoration - user-defined numTrk decoration JetSumTrackPTDecoration - user-defined sumTrkPt decoration

Author

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

Definition at line 66 of file MuJetOverlapTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MuJetOverlapTool()

ORUtils::MuJetOverlapTool::MuJetOverlapTool

(

const std::string &

name

)

Create proper constructor for Athena.

Standalone constructor

Definition at line 31 of file MuJetOverlapTool.cxx.

    : BaseOverlapTool(name)
  {
    declareProperty("BJetLabel", m_bJetLabel = "",
                    "Input b-jet flag. Disabled by default.");
    declareProperty("NumJetTrk", m_numJetTrk = 3,
                    "Min number of jet tracks to keep jet and remove muon");
    declareProperty("ApplyRelPt", m_applyRelPt = false,
                    "Toggle mu/jet relative PT requirements to prioritize jet");
    declareProperty("MuJetPtRatio", m_muJetPtRatio = 0.5,
                    "Mu/jet PT ratio threshold to remove a jet");
    declareProperty("MuJetTrkPtRatio", m_muJetTrkPtRatio = 0.7,
                    "Mu/jetTrk PT ratio threshold to remove a jet");
    declareProperty("JetNumTrackDecoration", m_jetNumTrkDec = "",
                    "User-defined decoration for jet numTrack");
    declareProperty("JetSumTrackPTDecoration", m_jetSumTrkPtDec = "",
                    "User-defined decoration for jet sumTrackPT");
    declareProperty("UseGhostAssociation", m_useGhostAssociation = true,
                    "Activate ghost-association mapping for jet removals");
    declareProperty("InnerDR", m_innerDR = 0.2,
                    "Flat inner cone for removing jets");
    declareProperty("OuterDR", m_outerDR = 0.4,
                    "Flat outer cone for removing muons");
    declareProperty("UseSlidingDR", m_useSlidingDR = false,
                    "Enables sliding dR outer cone = c1 + c2/MuPt");
    declareProperty("SlidingDRC1", m_slidingDRC1 = 0.04,
                    "The constant offset for sliding dR");
    declareProperty("SlidingDRC2", m_slidingDRC2 = 10.*GeV,
                    "The inverse muon pt factor for sliding dR");
    declareProperty("SlidingDRMaxCone", m_slidingDRMaxCone = 0.4,
                    "Maximum allowed size of sliding dR cone");
    declareProperty("UseRapidity", m_useRapidity = true,
                    "Calculate delta-R using rapidity");
    declareProperty("AllowNoPV", m_allowNoPV = false,
                    "Allow events with no primary vertex");
    declareProperty("PVContainerName", m_PVContName = "PrimaryVertices",
                    "PV Container to use");
  }

Member Function Documentation

addObjectLink() [1/2]

template<columnar::ContainerIdConcept CI>

StatusCode ORUtils::BaseOverlapTool::addObjectLink ( columnar::Particle1Id p1, columnar::ObjectId< CI > p2 ) const

inlineprotectedinherited

Definition at line 163 of file BaseOverlapTool.h.

                                                                                       {
        return m_objLinkHelper1->addObjectLink (p1, p2); }

addObjectLink() [2/2]

template<columnar::ContainerIdConcept CI>

StatusCode ORUtils::BaseOverlapTool::addObjectLink ( columnar::Particle2Id p1, columnar::ObjectId< CI > p2 ) const

inlineprotectedinherited

Definition at line 166 of file BaseOverlapTool.h.

                                                                                       {
        return m_objLinkHelper2->addObjectLink (p1, p2); }

callEvents()

void ORUtils::BaseOverlapTool::callEvents ( columnar::EventContextRange events ) const

overridevirtualinherited

The callEvents() for columnar tools.

Definition at line 65 of file BaseOverlapTool.cxx.

  {
    auto& baseAcc = *m_baseAccessors;
    for (auto event : events)
    {
      ANA_CHECK_THROW (findOverlaps (baseAcc.m_particles1Acc (event), baseAcc.m_particles2Acc (event), event));
    }
  }

checkForXAODContainer()

template<typename XAODContainer, columnar::RegularContainerIdConcept CI, typename CM>

StatusCode ORUtils::BaseOverlapTool::checkForXAODContainer ( columnar::ObjectRange< CI, CM > cont, std::string_view message ) const

inlineprotectedinherited

check whether the container is of the right type

Definition at line 83 of file BaseOverlapTool.h.

      {
        if constexpr (CM::isXAOD) {
          if(typeid(cont.getXAODObjectNoexcept()) != typeid(XAODContainer) &&
            typeid(cont.getXAODObjectNoexcept()) != typeid(ConstDataVector<XAODContainer>)) {
            ATH_MSG_ERROR(message);
            return StatusCode::FAILURE;
          }
        }
        return StatusCode::SUCCESS;
      }

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

findOverlaps() [1/2]

StatusCode ORUtils::IOverlapTool::findOverlaps ( const xAOD::IParticleContainer & cont1, const xAOD::IParticleContainer & cont2, const EventContext & eventContext = Gaudi::Hive::currentContext() ) const

inlineinherited

Definition at line 46 of file IOverlapTool.h.

                                                                                                  {
        return findOverlaps(
          columnar::Particle1Range(cont1),
          columnar::Particle2Range(cont2),
          eventContext);
      }

findOverlaps() [2/2]

StatusCode ORUtils::MuJetOverlapTool::findOverlaps ( columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext ) const

overridevirtual

Identify overlapping muons and jets.

First, low-track-multiplicity jets are flagged if they overlap with muons. Second, muons are flagged if they overlap with the remaining jets.

Implements ORUtils::IOverlapTool.

Definition at line 138 of file MuJetOverlapTool.cxx.

  {
    // Check the container types
    ATH_CHECK( checkForXAODContainer<xAOD::MuonContainer>(cont1, "First container arg is not of type MuonContainer!") );
    ATH_CHECK( checkForXAODContainer<xAOD::JetContainer>(cont2, "Second container arg is not of type JetContainer!") );
 
    ATH_CHECK( internalFindOverlaps(cont1, cont2, eventContext) );
    return StatusCode::SUCCESS;
  }

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getNumTracks()

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

protected

Get the number of tracks in a jet w.r.t. requested vertex.

Definition at line 257 of file MuJetOverlapTool.cxx.

  {
    auto& acc = *m_accessors;
    // Use the user decoration if configured
    if(!m_jetNumTrkDec.empty()) {
      return acc.m_jetNumTrkAcc(jet);
    }
    return acc.m_jetNumTrkPt500Acc(jet)[vtxIdx];
  }

getObjectPriority() [1/2]

char ORUtils::BaseOverlapTool::getObjectPriority ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 146 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper1->getObjectPriority (obj); }

getObjectPriority() [2/2]

char ORUtils::BaseOverlapTool::getObjectPriority ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 148 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper2->getObjectPriority (obj); }

getPrimVtxIdx()

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

protected

Retrieve the primary vertex used to count jet tracks.

Definition at line 236 of file MuJetOverlapTool.cxx.

  {
    auto& acc = *m_accessors;
    // the old version of this code would allow for a missing PV
    // container, but then fail later on. So the code now requires a
    // primary vertex here.
    auto vertices = acc.m_vtxContainerAcc(eventContext);
    for(auto vtx : vertices) {
      if(vtx(acc.m_vertexTypeAcc) == xAOD::VxType::PriVtx)
        return vertices.getIndexInRange(vtx);
    }
    // No PV found. Printing a debug message only and leaving it to the
    // caller to do the right thing. There is no point checking here
    // whether we will fail or not.
    ATH_MSG_DEBUG("No primary vertex in the " << m_PVContName << " container!");
    return std::nullopt;
  }

getProperty()

template<class T>

const T * asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

getSumTrackPt()

float ORUtils::MuJetOverlapTool::getSumTrackPt ( columnar::Particle2Id jet, size_t vtxIdx ) const

protected

Get the sum trk pt in a jet w.r.t. requested vertex.

Definition at line 270 of file MuJetOverlapTool.cxx.

  {
    auto& acc = *m_accessors;
    // Use the user decoration if configured
    if(!m_jetSumTrkPtDec.empty()) {
      return acc.m_jetSumTrkPtAcc(jet);
    }
    return acc.m_jetSumTrkPt500Acc(jet)[vtxIdx];
  }

handleOverlap()

template<columnar::RegularContainerIdConcept CI1, columnar::RegularContainerIdConcept CI2, typename CM>

StatusCode ORUtils::BaseOverlapTool::handleOverlap ( const columnar::ObjectId< CI1, CM > & testParticle, const columnar::ObjectId< CI2, CM > & refParticle ) const

protectedinherited

Common helper method to handle an overlap result.

This method for now applies the user-defined object priorities set as the input decoration, so if the testParticle is higher prio than the refParticle, nothing happens. Otherwise, this method prints a debug message, decorates the testParticle as overlap, and optionally sets the object element link.

Unit conversion constant

Definition at line 177 of file BaseOverlapTool.h.

  {
    // Apply user-priority override
    if(!m_enableUserPrio ||
       getObjectPriority(testParticle) <=
       getObjectPriority(refParticle))
    {
      if constexpr (CM::isXAOD)
      {
        const float invGeV = 1e-3;
        ATH_MSG_DEBUG("  Found overlap " << testParticle.getXAODObject().type() <<
                      " pt " << testParticle.getXAODObject().pt()*invGeV);
      } else
      {
        ATH_MSG_DEBUG("  Found overlap " << testParticle);
      }
      setObjectFail(testParticle);
      if(m_linkOverlapObjects) {
        ATH_CHECK( addObjectLink(testParticle, refParticle) );
      }
    }
    return StatusCode::SUCCESS;
  }

initialize()

StatusCode ORUtils::BaseOverlapTool::initialize ( void )

finaloverridevirtualinherited

Initialize base class functionality.

Concrete tool specific initialization can be implemented by overriding the initializeDerived() method.

Reimplemented from asg::AsgTool.

Definition at line 32 of file BaseOverlapTool.cxx.

  {
    ATH_MSG_DEBUG("Initializing " << name());
    ATH_MSG_DEBUG("Base config options: InputLabel " << m_inputLabel <<
                  " OutputLabel " << m_outputLabel <<
                  " OutputPassValue " << m_outputPassValue <<
                  " UserPrio " << m_enableUserPrio);
 
    // Initialize the decoration helper
    m_decHelper1 = std::make_unique<OverlapDecorationHelper<columnar::ContainerId::particle1>>
      (m_inputLabel, m_outputLabel, m_outputPassValue);
    addSubtool(*m_decHelper1);
    m_decHelper2 = std::make_unique<OverlapDecorationHelper<columnar::ContainerId::particle2>>
      (m_inputLabel, m_outputLabel, m_outputPassValue);
    addSubtool(*m_decHelper2);
 
    // Initialize the obj-link helper
    if(m_linkOverlapObjects)
    {
      m_objLinkHelper1 = std::make_unique<OverlapLinkHelper<columnar::ContainerId::particle1>>("overlapObject");
      addSubtool(*m_objLinkHelper1);
      m_objLinkHelper2 = std::make_unique<OverlapLinkHelper<columnar::ContainerId::particle2>>("overlapObject");
      addSubtool(*m_objLinkHelper2);
    }
 
    // Initialize the derived tool
    ATH_CHECK( initializeDerived() );
 
    ATH_CHECK ( initializeColumns() );
 
    return StatusCode::SUCCESS;
  }

initializeDecorations() [1/2]

void ORUtils::BaseOverlapTool::initializeDecorations ( columnar::Particle1Range container ) const

inlineprotectedinherited

Definition at line 142 of file BaseOverlapTool.h.

                                                                         {
        m_decHelper1->initializeDecorations (container); }

initializeDecorations() [2/2]

void ORUtils::BaseOverlapTool::initializeDecorations ( columnar::Particle2Range container ) const

inlineprotectedinherited

Definition at line 144 of file BaseOverlapTool.h.

                                                                         {
        m_decHelper2->initializeDecorations (container); }

initializeDerived()

StatusCode ORUtils::MuJetOverlapTool::initializeDerived ( )

overrideprotectedvirtual

Initialize the tool.

Reimplemented from ORUtils::BaseOverlapTool.

Definition at line 73 of file MuJetOverlapTool.cxx.

  {
    // Initialize the b-jet helper
    if(!m_bJetLabel.empty()) {
      ATH_MSG_DEBUG("Configuring btag-aware OR with btag label: " << m_bJetLabel);
      resetAccessor (m_bJetAcc, *this, m_bJetLabel);
    }
 
    // Initialize the matcher for the 'inner' cone.
    if(m_useGhostAssociation) {
      ATH_MSG_DEBUG("Configuring ghost association + dR matching for jet-mu OR "
                    "with inner cone size " << m_innerDR);
      m_dRMatchCone1 = std::make_unique<MuJetGhostDRMatcher>(m_innerDR, m_useRapidity);
    }
    else {
      ATH_MSG_DEBUG("Configuring mu-jet inner cone size " << m_innerDR);
      m_dRMatchCone1 = std::make_unique<DeltaRMatcher>(m_innerDR, m_useRapidity);
    }
    ATH_CHECK (m_dRMatchCone1->setObjectTypes (xAODType::ObjectType::Muon, xAODType::ObjectType::Jet));
    addSubtool(*m_dRMatchCone1);
 
    // Use sliding dR or flat dR for the 'outer' cone.
    if(m_useSlidingDR) {
      ATH_MSG_DEBUG("Configuring sliding outer cone for mu-jet OR with " <<
                    "constants C1 = " << m_slidingDRC1 << ", C2 = " <<
                    m_slidingDRC2 << ", MaxCone = " << m_slidingDRMaxCone);
      m_dRMatchCone2 =
        std::make_unique<SlidingDeltaRMatcher>
          (m_slidingDRC1, m_slidingDRC2, m_slidingDRMaxCone, m_useRapidity);
    }
    else {
      ATH_MSG_DEBUG("Configuring mu-jet outer cone size " << m_outerDR);
      m_dRMatchCone2 = std::make_unique<DeltaRMatcher>(m_outerDR, m_useRapidity);
    }
    ATH_CHECK (m_dRMatchCone2->setObjectTypes (xAODType::ObjectType::Muon, xAODType::ObjectType::Jet));
    addSubtool(*m_dRMatchCone2);
 
    // Additional config printouts
    ATH_MSG_DEBUG("Mu-jet matching config: NumJetTrk " << m_numJetTrk <<
                  " ApplyRelPt " << m_applyRelPt <<
                  " MuJetPtRatio " << m_muJetPtRatio <<
                  " MuJetTrkPtRatio " << m_muJetTrkPtRatio);
    if(!m_jetNumTrkDec.empty()) {
      ATH_MSG_DEBUG("Using user-defined JetNumTrackDecoration " << m_jetNumTrkDec);
    }
    if(!m_jetSumTrkPtDec.empty()) {
      ATH_MSG_DEBUG("Using user-defined JetSumTrackPTDecoration " << m_jetSumTrkPtDec);
    }
 
    ATH_MSG_DEBUG("AllowNoPV set to " << m_allowNoPV);
    resetAccessor (m_accessors->m_vtxContainerAcc, *m_accessors, m_PVContName, {.addMTDependency = true});
    if (!m_jetNumTrkDec.empty())
      resetAccessor (m_accessors->m_jetNumTrkAcc, *m_accessors, m_jetNumTrkDec);
    else
      resetAccessor (m_accessors->m_jetNumTrkPt500Acc, *m_accessors, "NumTrkPt500");
    if (!m_jetSumTrkPtDec.empty())
      resetAccessor (m_accessors->m_jetSumTrkPtAcc, *m_accessors, m_jetSumTrkPtDec);
    else
      resetAccessor (m_accessors->m_jetSumTrkPt500Acc, *m_accessors, "SumPtTrkPt500");
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

internalFindOverlaps()

StatusCode ORUtils::MuJetOverlapTool::internalFindOverlaps ( columnar::Particle1Range muons, columnar::Particle2Range jets, columnar::EventContextId eventContext ) const

virtual

Identify overlapping muons and jets.

The above method calls this one.

Definition at line 154 of file MuJetOverlapTool.cxx.

  {
    ATH_MSG_DEBUG("Removing overlapping muons and jets");
    auto& acc = *m_accessors;
 
    // Initialize output decorations if necessary
    initializeDecorations(muons);
    initializeDecorations(jets);
 
    // Retrieve the primary vertex for later reference
    auto vtxIdx = getPrimVtxIdx(eventContext);
    if(m_jetNumTrkDec.empty() && m_jetSumTrkPtDec.empty()) {
      if (!vtxIdx)
      {
        if (!m_allowNoPV) {
          ATH_MSG_ERROR("No primary vertex found! Cannot proceed with Mu-Jet OR.");
          return StatusCode::FAILURE;
        }
        else {
          ATH_MSG_DEBUG("No primary vertex found. Skipping the PV-dependent jet track info.");
        }
      }
    }
 
    // Remove suspicious jets that overlap with muons.
    for(const auto muon : muons){
      if(!isSurvivingObject(muon)) continue;
 
      for(const auto jet : jets){
        if(!isSurvivingObject(jet)) continue;
 
        // Don't reject user-defined b-tagged jets
        if(!m_bJetLabel.empty() && m_bJetAcc(jet)) continue;
 
        if (vtxIdx) {
          // Get the number of tracks and the sumPT of those tracks
          int nTrk = getNumTracks(jet, vtxIdx.value());
          float sumTrkPt = getSumTrackPt(jet, vtxIdx.value());
 
          // Don't reject jets with high track multiplicity and
          // high relative PT ratio
          bool highNumTrk = nTrk >= m_numJetTrk;
          bool highRelPt = false;
 
            if (sumTrkPt < FLT_MIN){
              highRelPt = (muon(acc.m_muonPtAcc)/jet(acc.m_jetPtAcc) < m_muJetPtRatio);
            }
            else{
              highRelPt = (muon(acc.m_muonPtAcc)/jet(acc.m_jetPtAcc) < m_muJetPtRatio || muon(acc.m_muonPtAcc)/sumTrkPt < m_muJetTrkPtRatio);
            }
 
          if(highNumTrk && (!m_applyRelPt || highRelPt)) continue;
        } // end part related to PV
 
        if(m_dRMatchCone1->objectsMatch(muon, jet)){
          ATH_CHECK( handleOverlap(jet, muon) );
        }
      }
    }
 
    // Remove muons from remaining overlapping jets
    for(const auto jet : jets){
      if(!isSurvivingObject(jet)) continue;
 
      for(const auto muon : muons){
        if(!isSurvivingObject(muon)) continue;
 
        if(m_dRMatchCone2->objectsMatch(muon, jet)){
          ATH_CHECK( handleOverlap(muon, jet) );
        }
      }
    }
 
    return StatusCode::SUCCESS;
  }

isRejectedObject() [1/2]

bool ORUtils::BaseOverlapTool::isRejectedObject ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 154 of file BaseOverlapTool.h.

                                                                         {
        return m_decHelper1->isRejectedObject (obj); }

isRejectedObject() [2/2]

bool ORUtils::BaseOverlapTool::isRejectedObject ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 156 of file BaseOverlapTool.h.

                                                                         {
        return m_decHelper2->isRejectedObject (obj); }

isSurvivingObject() [1/2]

bool ORUtils::BaseOverlapTool::isSurvivingObject ( columnar::Particle1Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 150 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper1->isSurvivingObject (obj);}

isSurvivingObject() [2/2]

bool ORUtils::BaseOverlapTool::isSurvivingObject ( columnar::Particle2Id obj ) const

inlinenodiscardprotectedinherited

Definition at line 152 of file BaseOverlapTool.h.

                                                                          {
        return m_decHelper2->isSurvivingObject (obj);}

msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setObjectFail() [1/2]

void ORUtils::BaseOverlapTool::setObjectFail ( columnar::Particle1Id obj ) const

inlineprotectedinherited

Definition at line 158 of file BaseOverlapTool.h.

                                                        {
        m_decHelper1->setObjectFail (obj); }

setObjectFail() [2/2]

void ORUtils::BaseOverlapTool::setObjectFail ( columnar::Particle2Id obj ) const

inlineprotectedinherited

Definition at line 160 of file BaseOverlapTool.h.

                                                        {
        m_decHelper2->setObjectFail (obj); }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_accessors

std::unique_ptr<Accessors> ORUtils::MuJetOverlapTool::m_accessors {std::make_unique<Accessors> (this)}

private

Definition at line 175 of file MuJetOverlapTool.h.

{std::make_unique<Accessors> (this)};

m_allowNoPV

bool ORUtils::MuJetOverlapTool::m_allowNoPV

private

Definition at line 158 of file MuJetOverlapTool.h.

m_applyRelPt

bool ORUtils::MuJetOverlapTool::m_applyRelPt

private

Toggle PT ratio criteria TODO: rename to m_applyPtRatio.

Definition at line 122 of file MuJetOverlapTool.h.

m_baseAccessors

std::unique_ptr<BaseAccessors> ORUtils::BaseOverlapTool::m_baseAccessors {std::make_unique<BaseAccessors> (this)}

protectedinherited

Definition at line 125 of file BaseOverlapTool.h.

{std::make_unique<BaseAccessors> (this)};

m_bJetAcc

columnar::Particle2Accessor<char> ORUtils::MuJetOverlapTool::m_bJetAcc

private

BJet helper.

Definition at line 183 of file MuJetOverlapTool.h.

m_bJetLabel

std::string ORUtils::MuJetOverlapTool::m_bJetLabel

private

Input jet decoration which labels a bjet.

Definition at line 116 of file MuJetOverlapTool.h.

m_decHelper1

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle1> > ORUtils::BaseOverlapTool::m_decHelper1

protectedinherited

Helper for handling input/output decorations.

Definition at line 128 of file BaseOverlapTool.h.

m_decHelper2

std::unique_ptr<OverlapDecorationHelper<columnar::ContainerId::particle2> > ORUtils::BaseOverlapTool::m_decHelper2

protectedinherited

Definition at line 129 of file BaseOverlapTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_dRMatchCone1

std::unique_ptr<IParticleAssociator> ORUtils::MuJetOverlapTool::m_dRMatchCone1

private

Delta-R matcher for the inner cone.

Definition at line 186 of file MuJetOverlapTool.h.

m_dRMatchCone2

std::unique_ptr<IParticleAssociator> ORUtils::MuJetOverlapTool::m_dRMatchCone2

private

Delta-R matcher for the outer cone.

Definition at line 188 of file MuJetOverlapTool.h.

m_enableUserPrio

bool ORUtils::BaseOverlapTool::m_enableUserPrio

protectedinherited

Enable user-priority scoring.

Definition at line 111 of file BaseOverlapTool.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_innerDR

float ORUtils::MuJetOverlapTool::m_innerDR

private

Inner dR cone within which jets get removed.

Definition at line 137 of file MuJetOverlapTool.h.

m_inputLabel

std::string ORUtils::BaseOverlapTool::m_inputLabel

protectedinherited

Input object decoration which specifies which objects to look at.

Definition at line 99 of file BaseOverlapTool.h.

m_jetNumTrkDec

std::string ORUtils::MuJetOverlapTool::m_jetNumTrkDec

private

Optional user decoration for jet numTrack of type 'int'.

Definition at line 129 of file MuJetOverlapTool.h.

m_jetSumTrkPtDec

std::string ORUtils::MuJetOverlapTool::m_jetSumTrkPtDec

private

Optional user decoration for jet sumTrackPT of type 'float'.

Definition at line 131 of file MuJetOverlapTool.h.

m_linkOverlapObjects

bool ORUtils::BaseOverlapTool::m_linkOverlapObjects

protectedinherited

Flag to toggle overlap object links.

Definition at line 108 of file BaseOverlapTool.h.

m_muJetPtRatio

float ORUtils::MuJetOverlapTool::m_muJetPtRatio

private

PT ratio threshold for vetoing the jet.

Definition at line 124 of file MuJetOverlapTool.h.

m_muJetTrkPtRatio

float ORUtils::MuJetOverlapTool::m_muJetTrkPtRatio

private

PT ratio threshold for vetoing the jet. Uses sum of jet track PT.

Definition at line 126 of file MuJetOverlapTool.h.

m_numJetTrk

int ORUtils::MuJetOverlapTool::m_numJetTrk

private

Minimum number of jet tracks to prioritize the jet.

Definition at line 119 of file MuJetOverlapTool.h.

m_objLinkHelper1

std::unique_ptr<OverlapLinkHelper<columnar::ContainerId::particle1> > ORUtils::BaseOverlapTool::m_objLinkHelper1

protectedinherited

Helper for linking overlap objects.

Definition at line 132 of file BaseOverlapTool.h.

m_objLinkHelper2

std::unique_ptr<OverlapLinkHelper<columnar::ContainerId::particle2> > ORUtils::BaseOverlapTool::m_objLinkHelper2

protectedinherited

Definition at line 133 of file BaseOverlapTool.h.

m_outerDR

float ORUtils::MuJetOverlapTool::m_outerDR

private

Outer dR cone within which muons get removed.

Replaced by sliding dR if activated.

Definition at line 140 of file MuJetOverlapTool.h.

m_outputLabel

std::string ORUtils::BaseOverlapTool::m_outputLabel

protectedinherited

Output object decoration which specifies overlapping objects.

Definition at line 101 of file BaseOverlapTool.h.

m_outputPassValue

bool ORUtils::BaseOverlapTool::m_outputPassValue

protectedinherited

Toggle the output flag logic.

If true, then non-overlapping objects will be assigned "true".

Definition at line 105 of file BaseOverlapTool.h.

m_PVContName

std::string ORUtils::MuJetOverlapTool::m_PVContName

private

PV Container to use.

Definition at line 155 of file MuJetOverlapTool.h.

m_slidingDRC1

double ORUtils::MuJetOverlapTool::m_slidingDRC1

private

C1, the constant offset in sliding dR.

Definition at line 145 of file MuJetOverlapTool.h.

m_slidingDRC2

double ORUtils::MuJetOverlapTool::m_slidingDRC2

private

C1, the inverse pt factor in sliding dR.

Definition at line 147 of file MuJetOverlapTool.h.

m_slidingDRMaxCone

double ORUtils::MuJetOverlapTool::m_slidingDRMaxCone

private

MaxCone, the upper limit of the sliding cone.

Definition at line 149 of file MuJetOverlapTool.h.

m_useGhostAssociation

bool ORUtils::MuJetOverlapTool::m_useGhostAssociation

private

Use ghost association in matching to remove jets.

Definition at line 134 of file MuJetOverlapTool.h.

m_useRapidity

bool ORUtils::MuJetOverlapTool::m_useRapidity

private

Calculate deltaR using rapidity.

Definition at line 152 of file MuJetOverlapTool.h.

m_useSlidingDR

bool ORUtils::MuJetOverlapTool::m_useSlidingDR

private

Toggle sliding dR overlap removal for removing muons.

Definition at line 143 of file MuJetOverlapTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• MuJetOverlapTool.h
• MuJetOverlapTool.cxx