EVENT::Cluster Class Reference

#include <Cluster.h>

Inheritance diagram for EVENT::Cluster:

List of all members.

Public Types
typedef Cluster	lcobject_type
Public Member Functions
virtual	~Cluster ()
	Destructor.
virtual int	getType () const =0
virtual float	getEnergy () const =0
virtual const float *	getPosition () const =0
virtual const FloatVec &	getPositionError () const =0
virtual float	getITheta () const =0
virtual float	getIPhi () const =0
virtual const FloatVec &	getDirectionError () const =0
virtual const FloatVec &	getShape () const =0
virtual const ParticleIDVec &	getParticleIDs () const =0
virtual const ClusterVec &	getClusters () const =0
virtual const CalorimeterHitVec &	getCalorimeterHits () const =0
virtual const FloatVec &	getHitContributions () const =0
virtual const FloatVec &	getSubdetectorEnergies () const =0
virtual int	id () const =0
virtual LCObject *	clone () const
template<class V>
V::ext_type	ext ()
template<class V>
V::rel_type	rel ()
Protected Member Functions
template<class V>
V::ptr &	ptr ()

---

Detailed Description

The LCIO cluster.

Author:

gaede

Version:

Id

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

Definition at line 30 of file Cluster.h.

---

Member Typedef Documentation

typedef Cluster EVENT::Cluster::lcobject_type

Useful typedef for template programming with LCIO Definition at line 38 of file Cluster.h.

---

Constructor & Destructor Documentation

virtual EVENT::Cluster::~Cluster (   )  [inline, virtual]

Destructor. Definition at line 34 of file Cluster.h.

---

Member Function Documentation

virtual LCObject* EVENT::LCObject::clone (   )  const [inline, virtual, inherited]

Deep copy of the object. C++ implementations should return the concrete type (virtual constructor). No reasonable implementation yet. Do not use this method. Reimplemented in IMPL::SimCalorimeterHitImpl. Definition at line 52 of file LCObject.h.

template<class V> V::ext_type lcrtrel::LCRTRelations::ext (   )  [inline, inherited]

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,... Definition at line 430 of file LCRTRelations.h.

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. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual const ClusterVec& EVENT::Cluster::getClusters (   )  const [pure virtual]

The clusters that have been combined to this cluster. Implemented in IMPL::ClusterImpl. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual const FloatVec& EVENT::Cluster::getDirectionError (   )  const [pure virtual]

Covariance matrix of the direction (3 Parameters) Implemented in IMPL::ClusterImpl. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual float EVENT::Cluster::getEnergy (   )  const [pure virtual]

Energy of the cluster. Implemented in IMPL::ClusterImpl. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual const FloatVec& EVENT::Cluster::getHitContributions (   )  const [pure virtual]

Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits() Implemented in IMPL::ClusterImpl. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

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. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

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. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

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

The particle Id's sorted by their likelihood. See also: ParticleID Implemented in IMPL::ClusterImpl. Referenced by SIO::SIOClusterHandler::write().

virtual const float* EVENT::Cluster::getPosition (   )  const [pure virtual]

Position of the cluster. Implemented in IMPL::ClusterImpl. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual const FloatVec& EVENT::Cluster::getPositionError (   )  const [pure virtual]

Covariance matrix of the position (6 Parameters) Implemented in IMPL::ClusterImpl. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual const FloatVec& EVENT::Cluster::getShape (   )  const [pure virtual]

Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters. Implemented in IMPL::ClusterImpl. Referenced by SIO::SIOClusterHandler::write().

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. Referenced by SIO::SIOClusterHandler::write().

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. Referenced by UTIL::LCTOOLS::printClusters(), and SIO::SIOClusterHandler::write().

virtual int EVENT::LCObject::id (   )  const [pure virtual, inherited]

Returns an object id for internal (debugging) use in LCIO. Implemented in tpc_tracking::CustomLCIOObject, EVENT::LCFloatVec, EVENT::LCGenericObject, EVENT::LCIntVec, EVENT::LCStrVec, IMPL::CalorimeterHitImpl, IMPL::ClusterImpl, IMPL::LCGenericObjectImpl, IMPL::LCRelationImpl, IMPL::LCRunHeaderImpl, IMPL::MCParticleImpl, IMPL::ParticleIDImpl, IMPL::RawCalorimeterHitImpl, IMPL::ReconstructedParticleImpl, IMPL::SimCalorimeterHitImpl, IMPL::SimTrackerHitImpl, IMPL::TPCHitImpl, IMPL::TrackerDataImpl, IMPL::TrackerHitImpl, IMPL::TrackerPulseImpl, IMPL::TrackerRawDataImpl, IMPL::TrackImpl, IMPL::VertexImpl, and tpc_tracking::CustomLCIOObject. Referenced by UTIL::operator<<(), UTIL::LCTOOLS::printCalorimeterHits(), UTIL::LCTOOLS::printClusters(), UTIL::LCTOOLS::printMCParticles(), UTIL::LCTOOLS::printRawCalorimeterHits(), UTIL::LCTOOLS::printReconstructedParticles(), UTIL::LCTOOLS::printRelation(), UTIL::LCTOOLS::printSimCalorimeterHits(), UTIL::LCTOOLS::printTPCHits(), UTIL::LCTOOLS::printTrackerData(), UTIL::LCTOOLS::printTrackerHits(), UTIL::LCTOOLS::printTrackerPulse(), UTIL::LCTOOLS::printTrackerRawData(), and UTIL::LCTOOLS::printTracks().

template<class V> V::ptr& lcrtrel::LCRTRelations::ptr (   )  [inline, protected, inherited]

Returns the reference to the pointer to the extension/relation object Definition at line 508 of file LCRTRelations.h.

template<class V> V::rel_type lcrtrel::LCRTRelations::rel (   )  [inline, inherited]

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. Definition at line 444 of file LCRTRelations.h.

---

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

• include/EVENT/Cluster.h

---