ORUtils::IOverlapTool Class Reference

Interface class for overlap removal tools. More...

#include <IOverlapTool.h>

Inherits asg::IAsgTool.

Inherited by ORUtils::AltMuJetOverlapTool [virtual], ORUtils::BaseOverlapTool [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 (columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext) const =0
	Declare the interface.
StatusCode	findOverlaps (const xAOD::IParticleContainer &cont1, const xAOD::IParticleContainer &cont2, const EventContext &eventContext=Gaudi::Hive::currentContext()) const
virtual void	print () const =0
	Print the state of the tool.

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 30 of file IOverlapTool.h.

Member Function Documentation

findOverlaps() [1/2]

virtual StatusCode ORUtils::IOverlapTool::findOverlaps ( columnar::Particle1Range cont1, columnar::Particle2Range cont2, columnar::EventContextId eventContext ) 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::AltMuJetOverlapTool, ORUtils::DeltaROverlapTool, ORUtils::EleEleOverlapTool, ORUtils::EleJetOverlapTool, ORUtils::EleMuSharedTrkOverlapTool, ORUtils::MuJetOverlapTool, ORUtils::ObjLinkOverlapTool, ORUtils::TauAntiTauJetOverlapTool, ORUtils::TauJetOverlapTool, ORUtils::TauLooseEleOverlapTool, and ORUtils::TauLooseMuOverlapTool.

findOverlaps() [2/2]

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

inline

Definition at line 46 of file IOverlapTool.h.

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

print()

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

pure virtualinherited

Print the state of the tool.

Implemented in asg::AsgTool, 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.

---

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

• IOverlapTool.h