The LCIO cluster. More...

#include <Cluster.h>

Inheritance diagram for EVENT::Cluster:

Public Types
typedef Cluster	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	~Cluster ()
	Destructor. More...

virtual int	getType () const =0
	Flagword that defines the type of cluster. More...

virtual float	getEnergy () const =0
	Energy of the cluster. More...

virtual float	getEnergyError () const =0
	Returns the error on the energy of the cluster. More...

virtual const float *	getPosition () const =0
	Position of the cluster. More...

virtual const FloatVec &	getPositionError () const =0
	Covariance matrix of the position (6 Parameters) More...

virtual float	getIPhi () const =0
	Intrinsic direction of cluster at position: Phi. More...

virtual float	getITheta () const =0
	Intrinsic direction of cluster at position: Theta. More...

virtual const FloatVec &	getDirectionError () const =0
	Covariance matrix of the direction (3 Parameters). More...

virtual const FloatVec &	getShape () const =0
	Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters. More...

virtual const ParticleIDVec &	getParticleIDs () const =0
	The particle Id's sorted by their likelihood. More...

virtual const ClusterVec &	getClusters () const =0
	The clusters that have been combined to this cluster. More...

virtual const CalorimeterHitVec &	getCalorimeterHits () const =0
	The hits that have been combined to this cluster. More...

virtual const FloatVec &	getHitContributions () const =0
	Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits() More...

virtual const FloatVec &	getSubdetectorEnergies () const =0
	A vector that holds the energy observed in a particular subdetectors. 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 LCObject *	clone () 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...

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

inlinevirtual

Destructor.

Definition at line 34 of file Cluster.h.

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.

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

virtual const FloatVec& EVENT::Cluster::getDirectionError ( ) const

pure virtual

Covariance matrix of the direction (3 Parameters).

Stored as lower triangle matrix where the order of parameters is: iPhi, iTheta. So we have cov(iPhi,iPhi), cov( iPhi, iTheta), cov( iTheta, iTheta).

Implemented in IMPL::ClusterImpl.

Referenced by UTIL::operator<<(), and SIO::SIOClusterHandler::write().

virtual float EVENT::Cluster::getEnergy ( ) const

pure virtual

Energy of the cluster.

Implemented in IMPL::ClusterImpl.

Referenced by UTIL::operator<<(), and SIO::SIOClusterHandler::write().

virtual float EVENT::Cluster::getEnergyError ( ) const

pure virtual

Returns the error on the energy of the cluster.

Implemented in IMPL::ClusterImpl.

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

virtual const float* EVENT::Cluster::getPosition ( ) const

pure virtual

Position of the cluster.

Implemented in IMPL::ClusterImpl.

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

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

/afs/desy.de/user/d/dudarboh/iLCSoft/LCIO/src/cpp/include/pre-generated/EVENT/Cluster.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation