ATLAS Offline Software
Public Member Functions | Static Public Member Functions | List of all members
Rec::IParticleCaloClusterAssociationTool Class Referenceabstract

Interface for extending Particles with calo cells. More...

#include <IParticleCaloClusterAssociationTool.h>

Inheritance diagram for Rec::IParticleCaloClusterAssociationTool:
Collaboration diagram for Rec::IParticleCaloClusterAssociationTool:

Public Member Functions

virtual bool particleClusterAssociation (const xAOD::IParticle &particle, const ParticleClusterAssociation *&association, float dr, const xAOD::CaloClusterContainer *container, bool useCaching=true) const =0
 Method to get the ParticleClusterAssociation of a given TrackParticle. More...
 

Static Public Member Functions

static const InterfaceID & interfaceID ()
 

Detailed Description

Interface for extending Particles with calo cells.

Definition at line 24 of file IParticleCaloClusterAssociationTool.h.

Member Function Documentation

◆ interfaceID()

const InterfaceID & Rec::IParticleCaloClusterAssociationTool::interfaceID ( )
inlinestatic

Definition at line 48 of file IParticleCaloClusterAssociationTool.h.

48  {
49  return IID_IParticleCaloClusterAssociationTool;
50  }

◆ particleClusterAssociation()

virtual bool Rec::IParticleCaloClusterAssociationTool::particleClusterAssociation ( const xAOD::IParticle particle,
const ParticleClusterAssociation *&  association,
float  dr,
const xAOD::CaloClusterContainer container,
bool  useCaching = true 
) const
pure virtual

Method to get the ParticleClusterAssociation of a given TrackParticle.

Parameters
particleinput particle
extensionreference to a pointer to a ParticleClusterAssociation, will be updated if call is successfull NEVER delete the pointer, you will cause a crash!
drcone size used for the association If caching is enabled, the cells associated to the association contain at least all cells in dr but could contain more. Users ALWAYS have to recalculate the associated cells in their cone.
containercluster container to be used if provided
useCachingconfigure whether the tool caches the result on the track particle The default behavior is 'true' to ensure optimal performance If caching is enabled, the code will perform a consistency check on the container pointer If the function is called twice on the same particle with different containers, the call will fail. The same is true if the function is called once without container and once with on the same particle.
Returns
true if the call was successful

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