ATLAS Offline Software
Public Member Functions | List of all members
ORUtils::IOverlapTool Class Referenceabstract

Interface class for overlap removal tools. More...

#include <IOverlapTool.h>

Inherits asg::IAsgTool.

Inherited by ORUtils::AltMuJetOverlapTool [virtual], ORUtils::DeltaROverlapTool [virtual], ORUtils::EleEleOverlapTool [virtual], ORUtils::EleJetOverlapTool [virtual], ORUtils::EleMuSharedTrkOverlapTool [virtual], ORUtils::MuJetOverlapTool [virtual], ORUtils::ObjLinkOverlapTool [virtual], ORUtils::TauAntiTauJetOverlapTool [virtual], ORUtils::TauJetOverlapTool [virtual], ORUtils::TauLooseEleOverlapTool [virtual], and ORUtils::TauLooseMuOverlapTool [virtual].

Collaboration diagram for ORUtils::IOverlapTool:

Public Member Functions

virtual StatusCode findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2) const =0
 Declare the interface. More...
 
virtual void print () const =0
 Print the state of the tool. More...
 

Detailed Description

Interface class for overlap removal tools.

Tools that implement this interface will operate on particle containers and find and mark overlaps based on their custom logic.

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

Definition at line 26 of file IOverlapTool.h.

Member Function Documentation

◆ findOverlaps()

virtual StatusCode ORUtils::IOverlapTool::findOverlaps ( const xAOD::IParticleContainer cont1,
const xAOD::IParticleContainer cont2 
) const
pure virtual

Declare the interface.

Find overlaps between two containers. The details will depend on the tool implementation, but the convention should be that if only one container is to be marked, it should be the first argument. Otherwise, both of them can be marked. The decoration logic may depend on configuration.

Implemented in ORUtils::MuJetOverlapTool, ORUtils::TauAntiTauJetOverlapTool, ORUtils::AltMuJetOverlapTool, ORUtils::EleJetOverlapTool, ORUtils::EleMuSharedTrkOverlapTool, ORUtils::TauJetOverlapTool, ORUtils::EleEleOverlapTool, ORUtils::TauLooseEleOverlapTool, ORUtils::TauLooseMuOverlapTool, ORUtils::ObjLinkOverlapTool, and ORUtils::DeltaROverlapTool.

◆ print()

virtual void asg::IAsgTool::print ( ) const
pure virtualinherited

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