Abstract interface for tools that implement constituent based subtraction. More...

#include <IHISubtractorTool.h>

Inheritance diagram for IHISubtractorTool:

Collaboration diagram for IHISubtractorTool:

Public Member Functions
virtual	~IHISubtractorTool ()

virtual void	subtract (xAOD::IParticle::FourMom_t &, const xAOD::IParticle , const xAOD::HIEventShapeContainer , const HIEventShapeIndex , const ToolHandle< IHIUEModulatorTool > &, const xAOD::HIEventShape shape) const =0
	Abstract method where particle itself is not modified IParticle::FourMom_t containing kinematics after subtraction is passed by reference. More...

virtual void	subtractWithMoments (xAOD::CaloCluster , const xAOD::HIEventShapeContainer , const HIEventShapeIndex index, const ToolHandle< IHIUEModulatorTool > &, const xAOD::HIEventShape shape) const =0

virtual void	updateUsingCluster (xAOD::HIEventShapeContainer shape, const HIEventShapeIndex index, const xAOD::CaloCluster *cl) const =0
	Method to update the shape based on a given cluster two sets of indices are passed by reference and updated by the method sets are queried to see if the cluster has already been used, e.g. More...

virtual float	minEnergyForMoments () const =0

virtual bool	usesCells () const =0

virtual const xAOD::HIEventShapeContainer *	getShape () const =0

virtual const HIEventShapeIndex *	getIndex () const =0

virtual const IHIUEModulatorTool *	getModulator () const =0

virtual void	setShape (const xAOD::HIEventShapeContainer *)=0

virtual void	setIndex (const HIEventShapeIndex *)=0

virtual void	setModulator (const IHIUEModulatorTool *)=0

virtual void	print () const =0
	Print the state of the tool. More...

Detailed Description

Abstract interface for tools that implement constituent based subtraction.

Author: Aaron Angerami anger.nosp@m.ami@.nosp@m.cern..nosp@m.ch

Date: Jan, 2015

Definition at line 31 of file IHISubtractorTool.h.

Constructor & Destructor Documentation

◆ ~IHISubtractorTool()

virtual IHISubtractorTool::~IHISubtractorTool ( )

inlinevirtual

Definition at line 36 of file IHISubtractorTool.h.

36 { };

Member Function Documentation

◆ getIndex()

virtual const HIEventShapeIndex* IHISubtractorTool::getIndex ( ) const

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ getModulator()

virtual const IHIUEModulatorTool* IHISubtractorTool::getModulator ( ) const

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ getShape()

virtual const xAOD::HIEventShapeContainer* IHISubtractorTool::getShape ( ) const

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ minEnergyForMoments()

virtual float IHISubtractorTool::minEnergyForMoments ( ) const

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ print()

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

pure virtualinherited

Print the state of the tool.

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

◆ setIndex()

virtual void IHISubtractorTool::setIndex ( const HIEventShapeIndex * )

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ setModulator()

virtual void IHISubtractorTool::setModulator ( const IHIUEModulatorTool * )

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ setShape()

virtual void IHISubtractorTool::setShape ( const xAOD::HIEventShapeContainer * )

pure virtual

Implemented in HIJetSubtractorToolBase.

◆ subtract()

virtual void IHISubtractorTool::subtract	(	xAOD::IParticle::FourMom_t &	,
		const xAOD::IParticle *	,
		const xAOD::HIEventShapeContainer *	,
		const HIEventShapeIndex *	,
		const ToolHandle< IHIUEModulatorTool > &	,
		const xAOD::HIEventShape *	shape
	)		const

pure virtual

Abstract method where particle itself is not modified IParticle::FourMom_t containing kinematics after subtraction is passed by reference.

Implemented in HIJetCellSubtractorTool, and HIJetClusterSubtractorTool.

◆ subtractWithMoments()

virtual void IHISubtractorTool::subtractWithMoments	(	xAOD::CaloCluster *	,
		const xAOD::HIEventShapeContainer *	,
		const HIEventShapeIndex *	index,
		const ToolHandle< IHIUEModulatorTool > &	,
		const xAOD::HIEventShape *	shape
	)		const

pure virtual

Implemented in HIJetCellSubtractorTool, and HIJetClusterSubtractorTool.

◆ updateUsingCluster()

virtual void IHISubtractorTool::updateUsingCluster	(	xAOD::HIEventShapeContainer *	shape,
		const HIEventShapeIndex *	index,
		const xAOD::CaloCluster *	cl
	)		const

pure virtual

Method to update the shape based on a given cluster two sets of indices are passed by reference and updated by the method sets are queried to see if the cluster has already been used, e.g.

by another jet seed checking/updating sets prevents double counting eta-bin set used to determine eta-averaged flow

Implemented in HIJetClusterSubtractorTool, and HIJetCellSubtractorTool.