LCIO  02.17
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
EVENT::ParticleID Class Referenceabstract

Persistent interface for LCIO ParticleIDs. More...

#include <ParticleID.h>

+ Inheritance diagram for EVENT::ParticleID:

Public Types

typedef ParticleID lcobject_type
 Useful typedef for template programming with LCIO. More...
 
- Public Types inherited from lcrtrel::LCRTRelations
typedef std::type_index ext_index
 
typedef std::shared_ptr< void > ext_type
 
typedef std::map< ext_index,
ext_type
ext_map
 

Public Member Functions

virtual ~ParticleID ()
 Destructor. More...
 
virtual int getType () const =0
 Type - userdefined. More...
 
virtual int getPDG () const =0
 The PDG code of this id - UnknownPDG ( 999999 ) if unknown. More...
 
virtual float getLikelihood () const =0
 The likelihood of this hypothesis - in a user defined normalization. More...
 
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. More...
 
virtual int id () const =0
 Returns an object id for internal (debugging) use in LCIO. More...
 
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,... More...
 
template<class V >
const V::ext_type ext () const
 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,... More...
 
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. More...
 

Static Public Attributes

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

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()

Definition at line 28 of file ParticleID.h.

Member Typedef Documentation

Useful typedef for template programming with LCIO.

Definition at line 36 of file ParticleID.h.

Constructor & Destructor Documentation

virtual EVENT::ParticleID::~ParticleID ( )
inlinevirtual

Destructor.

Definition at line 32 of file ParticleID.h.

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::operator<<(), UTIL::LCTOOLS::printClusters(), and UTIL::LCTOOLS::printReconstructedParticles().

virtual float EVENT::ParticleID::getLikelihood ( ) const
pure virtual

The likelihood of this hypothesis - in a user defined normalization.

Implemented in IMPL::ParticleIDImpl.

Referenced by IMPL::PIDSort::operator()(), UTIL::operator<<(), UTIL::LCTOOLS::printClusters(), and UTIL::LCTOOLS::printReconstructedParticles().

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(), and UTIL::LCTOOLS::printReconstructedParticles().

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

The PDG code of this id - UnknownPDG ( 999999 ) if unknown.

Implemented in IMPL::ParticleIDImpl.

Referenced by UTIL::operator<<(), UTIL::LCTOOLS::printClusters(), and UTIL::LCTOOLS::printReconstructedParticles().

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

Member Data Documentation

const int EVENT::ParticleID::UnknownPDG = 999999
static

Constant to be used if the PDG code is not known or undefined.

Definition at line 50 of file ParticleID.h.


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