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

The LCIO reconstructedParticle. More...

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

Inheritance diagram for EVENT::ReconstructedParticle:
EVENT::LCObject lcrtrel::LCRTRelations IMPL::ReconstructedParticleImpl IOIMPL::ReconstructedParticleIOImpl

Public Types

typedef ReconstructedParticle lcobject_type
 Useful typedef for template programming with LCIO.
 

Public Member Functions

virtual ~ReconstructedParticle ()
 Destructor.
 
virtual int getType () const =0
 Type of reconstructed particle. More...
 
virtual bool isCompound () const =0
 Return particles primary flag. More...
 
virtual const double * getMomentum () const =0
 The reconstructed particle's 3-momentum - only float used in files,.
 
virtual double getEnergy () const =0
 Energy of the reconstructed particle - only float used in files.
 
virtual const FloatVecgetCovMatrix () const =0
 Covariance matrix of the reconstructed particle's 4vector (10 parameters). More...
 
virtual double getMass () const =0
 Mass of the reconstructed particle, set independently from four vector quantities. More...
 
virtual float getCharge () const =0
 Charge of the reconstructed particle.
 
virtual const float * getReferencePoint () const =0
 Reference point of the reconstructedParticle parameters.
 
virtual const ParticleIDVecgetParticleIDs () const =0
 The particle Id's sorted by their likelihood. More...
 
virtual ParticleIDgetParticleIDUsed () const =0
 The particle Id used for the kinematics of this particle. More...
 
virtual float getGoodnessOfPID () const =0
 The overall goodness of the PID on a scale of [0;1].
 
virtual const
ReconstructedParticleVec
getParticles () const =0
 The reconstructed particles that have been combined to this particle.
 
virtual const ClusterVecgetClusters () const =0
 The weights of the reconstructed particles combined to this particle. More...
 
virtual const TrackVecgetTracks () const =0
 The weights of cluster contributions to this particle. More...
 
virtual VertexgetStartVertex () const =0
 The start vertex associated to this particle.
 
virtual VertexgetEndVertex () const =0
 The vertex where the particle decays This method actually returns the start vertex from the first daughter particle found.
 
virtual void addParticleID (ParticleID *pid)=0
 Set the type of reconstructed particle, one of:
ReconstructedParticle::SINGLE,
ReconstructedParticle::V0,
ReconstructedParticle::COMPOUND,
ReconstructedParticle::JET
More...
 
virtual void addParticle (ReconstructedParticle *particle)=0
 Add a particle that has been used to create this particle.
 
virtual void addCluster (Cluster *cluster)=0
 Add a cluster that has been used to create this particle.
 
virtual void addTrack (Track *track)=0
 Add a track that has been used to create this particle.
 
- 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.
 

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

The LCIO reconstructedParticle.

Author
gaede
Version
Id:
ReconstructedParticle.aid,v 1.18 2006-09-21 06:10:35 gaede Exp

Member Function Documentation

virtual void EVENT::ReconstructedParticle::addParticleID ( ParticleID pid)
pure virtual

Set the type of reconstructed particle, one of:
ReconstructedParticle::SINGLE,
ReconstructedParticle::V0,
ReconstructedParticle::COMPOUND,
ReconstructedParticle::JET

Set primary flag.Set particle momentum (px,py,pz).Set energy.Set the values of the covariance matrix of the particles four vector (px,py,pz,E).Set the values of the covariance matrix of the particles four vector (px,py,pz,E).Set mass - independently from four vector. Set the charge. Set the reference point, i.e. the point where the four vector is defined.Add a ParticleID object.

See Also
ParticleID

Implemented in IMPL::ReconstructedParticleImpl.

virtual const ClusterVec& EVENT::ReconstructedParticle::getClusters ( ) const
pure virtual

The weights of the reconstructed particles combined to this particle.

The clusters that have been used for this particle.

Implemented in IMPL::ReconstructedParticleImpl.

Referenced by SIO::SIOReconstructedParticleHandler::write().

virtual const FloatVec& EVENT::ReconstructedParticle::getCovMatrix ( ) const
pure virtual

Covariance matrix of the reconstructed particle's 4vector (10 parameters).

Stored as lower triangle matrix of the four momentum (px,py,pz,E), i.e. cov(px,px), cov(py,px), cov( py,py ) , ....

Implemented in IMPL::ReconstructedParticleImpl.

Referenced by SIO::SIOReconstructedParticleHandler::write().

virtual double EVENT::ReconstructedParticle::getMass ( ) const
pure virtual

Mass of the reconstructed particle, set independently from four vector quantities.

  • only float used in files.

Implemented in IMPL::ReconstructedParticleImpl.

Referenced by SIO::SIOReconstructedParticleHandler::write().

virtual const ParticleIDVec& EVENT::ReconstructedParticle::getParticleIDs ( ) const
pure virtual

The particle Id's sorted by their likelihood.

See Also
ParticleID

Implemented in IMPL::ReconstructedParticleImpl.

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

virtual ParticleID* EVENT::ReconstructedParticle::getParticleIDUsed ( ) const
pure virtual

The particle Id used for the kinematics of this particle.

See Also
ParticleID

Implemented in IMPL::ReconstructedParticleImpl.

Referenced by SIO::SIOReconstructedParticleHandler::write().

virtual const TrackVec& EVENT::ReconstructedParticle::getTracks ( ) const
pure virtual

The weights of cluster contributions to this particle.

The tracks that have been used for this particle.

Implemented in IMPL::ReconstructedParticleImpl.

Referenced by SIO::SIOReconstructedParticleHandler::write().

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

Type of reconstructed particle.

Check/set collection parameters ReconstructedParticleTypeNames and ReconstructedParticleTypeValues.

Implemented in IMPL::ReconstructedParticleImpl.

Referenced by SIO::SIOReconstructedParticleHandler::write().

virtual bool EVENT::ReconstructedParticle::isCompound ( ) const
pure virtual

Return particles primary flag.

All particles in the ReconstructedParticle collection should by definition return true. Compound partciles will return false.Convenient method - same as (getParticles().size() > 0 ).

Implemented in IMPL::ReconstructedParticleImpl.


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