Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | Related Pages

EVENT::Cluster Class Reference

The LCIO cluster. More...

#include <EVENT/Cluster.h>

Inheritance diagram for EVENT::Cluster:

EVENT::LCObject lcrtrel::LCRTRelations IMPL::ClusterImpl IOIMPL::ClusterIOImpl List of all members.

Public Types

typedef Cluster lcobject_type
 Useful typedef for template programming with LCIO.

Public Member Functions

virtual ~Cluster ()
 Destructor.
virtual int getType () const =0
 Flagword that defines the type of cluster.
virtual float getEnergy () const =0
 Energy of the cluster.
virtual const float * getPosition () const =0
 Position of the cluster.
virtual const FloatVecgetPositionError () const =0
 Covariance matrix of the position (6 Parameters).
virtual float getITheta () const =0
 Intrinsic direction of cluster at position: Theta.
virtual float getIPhi () const =0
 Intrinsic direction of cluster at position: Phi.
virtual const FloatVecgetDirectionError () const =0
 Covariance matrix of the direction (3 Parameters).
virtual const FloatVecgetShape () const =0
 Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters.
virtual const ParticleIDVecgetParticleIDs () const =0
 The particle Id's sorted by their likelihood.
virtual const ClusterVecgetClusters () const =0
 The clusters that have been combined to this cluster.
virtual const CalorimeterHitVecgetCalorimeterHits () const =0
 The hits that have been combined to this cluster.
virtual const FloatVecgetHitContributions () const =0
 Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits().
virtual const FloatVecgetSubdetectorEnergies () const =0
 A vector that holds the energy observed in a particular subdetectors.

Detailed Description

The LCIO cluster.

Author:
gaede
Version:
Id
Cluster.aid,v 1.14 2006/08/03 16:53:34 gaede Exp


Member Function Documentation

virtual const CalorimeterHitVec& EVENT::Cluster::getCalorimeterHits  )  const [pure virtual]
 

The hits that have been combined to this cluster.

Only available if collection flag bit LCIO::CLBIT_HITS==1 and if the CalorimeterHit objects have not been saved with LCIO::RCHBIT_NO_PTR==1.

See also:
CalorimeterHit

Implemented in IMPL::ClusterImpl.

virtual float EVENT::Cluster::getIPhi  )  const [pure virtual]
 

Intrinsic direction of cluster at position: Phi.

Not to be confused with direction cluster is seen from IP.

Implemented in IMPL::ClusterImpl.

virtual float EVENT::Cluster::getITheta  )  const [pure virtual]
 

Intrinsic direction of cluster at position: Theta.

Not to be confused with direction cluster is seen from IP.

Implemented in IMPL::ClusterImpl.

virtual const ParticleIDVec& EVENT::Cluster::getParticleIDs  )  const [pure virtual]
 

The particle Id's sorted by their likelihood.

See also:
ParticleID

Implemented in IMPL::ClusterImpl.

virtual const FloatVec& EVENT::Cluster::getSubdetectorEnergies  )  const [pure virtual]
 

A vector that holds the energy observed in a particular subdetectors.

The mapping of indices to subdetectors is implementation dependent. To be used as convenient information or if hits are not stored in the data set, e.g. DST or FastMC. Check/set collection parameter ClusterSubdetectorNames for decoding the indices of the array.

Implemented in IMPL::ClusterImpl.

virtual int EVENT::Cluster::getType  )  const [pure virtual]
 

Flagword that defines the type of cluster.

Bits 0-15 can be used to denote the subdetectors that have contributed hits to the cluster. For the definition of the bits check/Set the collection variables ClusterTypeBitNames and ClusterTypeBitIndices. Bits 16-31 are used internally.

Implemented in IMPL::ClusterImpl.


The documentation for this class was generated from the following file:
Generated on Sat Dec 13 14:19:40 2008 for LCIO by  doxygen 1.3.9.1