LCIO  "2.7.4"
 All Classes Namespaces Functions Variables Typedefs Friends Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
EVENT::ParticleID Class Referenceabstract

Persistent interface for LCIO ParticleIDs. More...

#include <pre-generated/EVENT/ParticleID.h>

Inheritance diagram for EVENT::ParticleID:
EVENT::LCObject lcrtrel::LCRTRelations IMPL::ParticleIDImpl IOIMPL::ParticleIDIOImpl

Public Types

typedef ParticleID lcobject_type
 Useful typedef for template programming with LCIO.
 

Public Member Functions

virtual ~ParticleID ()
 Destructor.
 
virtual int getType () const =0
 Type - userdefined.
 
virtual int getPDG () const =0
 The PDG code of this id - UnknownPDG ( 999999 ) if unknown.
 
virtual float getLikelihood () const =0
 The likelihood of this hypothesis - in a user defined normalization.
 
virtual int getAlgorithmType () const =0
 Type of the algorithm/module that created this hypothesis - NOTE: must be unique within one collection. More...
 
virtual const FloatVecgetParameters () const =0
 Parameters associated with this hypothesis. More...
 
- Public Member Functions inherited from EVENT::LCObject
virtual ~LCObject ()
 Destructor.
 
virtual int id () const =0
 Returns an object id for internal (debugging) use in LCIO.
 
virtual LCObjectclone () const
 Returns an object id for internal (debugging) use in LCIO. More...
 
- Public Member Functions inherited from lcrtrel::LCRTRelations
template<class V >
V::ext_type ext ()
 Provides access to an extension object - the type and ownership is defined by the class V which should be a subtype of LCExtension, LCOwnedExtension, LCExtensionVector, LCExtensionList,...
 
template<class V >
const V::ext_type ext () const
 
template<class V >
V::rel_type rel ()
 Provides read access to relations - the object types and their connectivity are defined by the class V which has to be a subtype of either LC1To1Relation, LC1ToNRelation or LCNToNRelation.
 

Static Public Attributes

static const int UnknownPDG = 999999
 Constant to be used if the PDG code is not known or undefined.
 

Additional Inherited Members

- Protected Member Functions inherited from lcrtrel::LCRTRelations
template<class V >
V::ptr & ptr () const
 Returns the reference to the pointer to the extension/relation object.
 

Detailed Description

Persistent interface for LCIO ParticleIDs.

Used by ReconstructedParticle and Cluster for different hypotheses on the particle type.

Author
gaede
Version
Id:
ParticleID.aid,v 1.11 2008-05-30 13:23:27 gaede Exp
See Also
ReconstructedParticle.getParticleIDs()
Cluster.getParticleIDs()

Member Function Documentation

virtual int EVENT::ParticleID::getAlgorithmType ( ) const
pure virtual

Type of the algorithm/module that created this hypothesis - NOTE: must be unique within one collection.

Check/set collection parameters PIDAlgorithmTypeName and PIDAlgorithmTypeID.

Implemented in IMPL::ParticleIDImpl.

Referenced by UTIL::LCTOOLS::printClusters(), UTIL::LCTOOLS::printReconstructedParticles(), SIO::SIOClusterHandler::write(), and SIO::SIOReconstructedParticleHandler::write().

virtual const FloatVec& EVENT::ParticleID::getParameters ( ) const
pure virtual

Parameters associated with this hypothesis.

Check/set collection parameters ParameterNames_PIDAlgorithmTypeName for decoding the indices.

Implemented in IMPL::ParticleIDImpl.

Referenced by UTIL::LCTOOLS::printClusters(), UTIL::LCTOOLS::printReconstructedParticles(), SIO::SIOClusterHandler::write(), and SIO::SIOReconstructedParticleHandler::write().


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