ITruthIsolationTool Class Reference

#include <ITruthIsolationTool.h>

Inheritance diagram for ITruthIsolationTool:

Collaboration diagram for ITruthIsolationTool:

Public Types
enum	ParticleSelect { UseChargedOnly = 0, UseAll }
	enumerator to decide which strategy to apply in the selection of particles during the Et-isolation computation More...

Public Member Functions
virtual	~ITruthIsolationTool ()
	Destructor: More...
virtual StatusCode	initialize ()=0
virtual const std::string &	etIsolationsName (const std::string &mcEvtName) const =0
	Return the name of the TruthEtIsolations container (ie: its StoreGate location) given the StoreGate location of a McEventCollection. More...
virtual StatusCode	buildEtIsolations (const std::string &mcEvtName, ParticleSelect c=UseAll)=0
	Computes the isolation energies for each of the HepMC::GenEvent contained into the McEventCollection. More...
virtual StatusCode	registerAlias (const std::string &originalMcEvtColl, const std::string &aliasMcEvtColl)=0
	Make an alias in the map of isolation energies. More...

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Inline methods: More...

Detailed Description

interface for AlgTools which want to compute and/or retrieve isolation energies for/from HepMC::GenEvent. This information is then stored into a TruthEtIsolations container, put into StoreGate with the key "TruthEtIsolations_<key-of-GenEvent>". See McParticleEvent/TruthParticleParameters.h for more informations about these transverse energy isolations.

Definition at line 32 of file ITruthIsolationTool.h.

Member Enumeration Documentation

ParticleSelect

enum ITruthIsolationTool::ParticleSelect

enumerator to decide which strategy to apply in the selection of particles during the Et-isolation computation

Enumerator
UseChargedOnly
UseAll

Definition at line 43 of file ITruthIsolationTool.h.

                      {
    UseChargedOnly = 0,
    UseAll
  };

Constructor & Destructor Documentation

~ITruthIsolationTool()

ITruthIsolationTool::~ITruthIsolationTool ( )

virtual

Destructor:

Public methods:

Destructor

Definition at line 22 of file ITruthIsolationTool.cxx.

{}

Member Function Documentation

buildEtIsolations()

virtual StatusCode ITruthIsolationTool::buildEtIsolations ( const std::string &  mcEvtName, ParticleSelect  c = UseAll  )

pure virtual

Computes the isolation energies for each of the HepMC::GenEvent contained into the McEventCollection.

One can switch b/w using all particles or only the charged ones. Default is to use all

Implemented in TruthIsolationTool.

etIsolationsName()

virtual const std::string& ITruthIsolationTool::etIsolationsName ( const std::string &  mcEvtName ) const

pure virtual

Return the name of the TruthEtIsolations container (ie: its StoreGate location) given the StoreGate location of a McEventCollection.

It returns an empty string if no TruthEtIsolations container has been processed by the isolation tool.

Implemented in TruthIsolationTool.

initialize()

virtual StatusCode ITruthIsolationTool::initialize ( )

pure virtual

Implemented in TruthIsolationTool.

interfaceID()

const InterfaceID & ITruthIsolationTool::interfaceID ( )

inlinestatic

Inline methods:

Definition at line 100 of file ITruthIsolationTool.h.

{ 
   return IID_ITruthIsolationTool; 
}

registerAlias()

virtual StatusCode ITruthIsolationTool::registerAlias ( const std::string &  originalMcEvtColl, const std::string &  aliasMcEvtColl  )

pure virtual

Make an alias in the map of isolation energies.

Implemented in TruthIsolationTool.

---

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

• ITruthIsolationTool.h
• ITruthIsolationTool.cxx