IMPL::ClusterImpl Class Reference

Implementation of Cluster. More...

#include <IMPL/ClusterImpl.h>

Inheritance diagram for IMPL::ClusterImpl:

Public Member Functions
	ClusterImpl ()
	Default constructor, initializes values to 0.
virtual	~ClusterImpl ()
	Destructor.
virtual int	id () const
	Returns an object id for internal (debugging) use in LCIO.
virtual int	getType () const
	Flagword that defines the type of cluster. More...
virtual float	getEnergy () const
	Energy of the cluster.
virtual float	getEnergyError () const
	Returns the error on the energy of the cluster.
virtual const float *	getPosition () const
	Position of the cluster.
virtual const EVENT::FloatVec &	getPositionError () const
	Covariance matrix of the position (6 Parameters)
virtual float	getITheta () const
	Intrinsic direction of cluster at position: Theta.
virtual float	getIPhi () const
	Intrinsic direction of cluster at position: Phi.
virtual const EVENT::FloatVec &	getDirectionError () const
	Covariance matrix of the direction (3 Parameters)
virtual const EVENT::FloatVec &	getShape () const
	Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters.
virtual const EVENT::ParticleIDVec &	getParticleIDs () const
	Type hypotheses: 3 Parameters: compatible with EM, HAD, muon cluster. More...
virtual const EVENT::ClusterVec &	getClusters () const
	The clusters that have been combined to this cluster.
virtual const EVENT::CalorimeterHitVec &	getCalorimeterHits () const
	The hits that have been combined to this cluster.
virtual const EVENT::FloatVec &	getHitContributions () const
	Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits()
virtual const EVENT::FloatVec &	getSubdetectorEnergies () const
	A vector that holds the energy observed in a particular subdetectors. More...
void	setTypeBit (int index, bool val=true)
void	setEnergy (float energy)
void	setEnergyError (float energyError)
void	setPosition (const float *position)
void	setPositionError (const EVENT::FloatVec &errpos)
void	setPositionError (const float *errpos)
void	setITheta (float theta)
void	setIPhi (float phi)
void	setDirectionError (const EVENT::FloatVec &errdir)
void	setDirectionError (const float *errdir)
void	setShape (const EVENT::FloatVec &shape)
void	addParticleID (EVENT::ParticleID *pid)
void	addCluster (EVENT::Cluster *cluster)
void	addHit (EVENT::CalorimeterHit *hit, float contribution)
EVENT::FloatVec &	subdetectorEnergies ()
	To be used for modifying the subdetector energies, e.g. More...
Public Member Functions inherited from EVENT::Cluster
virtual	~Cluster ()
	Destructor.
Public Member Functions inherited from EVENT::LCObject
virtual	~LCObject ()
	Destructor.
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,...
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.
Public Member Functions inherited from IMPL::AccessChecked
virtual int	simpleUID () const

Protected Member Functions
void	setType (int type)
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.
Protected Member Functions inherited from IMPL::AccessChecked
virtual void	setReadOnly (bool readOnly)
void	checkAccess () throw ( EVENT::ReadOnlyException )
void	checkAccess (const char *what) throw ( EVENT::ReadOnlyException )

Protected Attributes
std::bitset< 32 >	_type
float	_energy
float	_energyError
float	_position [3]
EVENT::FloatVec	_errpos
float	_theta
float	_phi
EVENT::FloatVec	_errdir
EVENT::FloatVec	_shape
EVENT::ParticleIDVec	_pid
EVENT::ClusterVec	_clusters
EVENT::CalorimeterHitVec	_hits
EVENT::FloatVec	_weights
EVENT::FloatVec	_subdetectorEnergies
Protected Attributes inherited from IMPL::AccessChecked
bool	_readOnly
int	_id

Additional Inherited Members
Public Types inherited from EVENT::Cluster
typedef Cluster	lcobject_type
	Useful typedef for template programming with LCIO.

Detailed Description

Implementation of Cluster.

See Also

Cluster

Author

gaede

Version

Id:

ClusterImpl.h,v 1.13 2006-08-04 16:52:46 gaede Exp

Member Function Documentation

const EVENT::ParticleIDVec & IMPL::ClusterImpl::getParticleIDs ( ) const

virtual

Type hypotheses: 3 Parameters: compatible with EM, HAD, muon cluster.

The particle Id's sorted by their probability.

See Also

ParticleID

Implements EVENT::Cluster.

const EVENT::FloatVec & IMPL::ClusterImpl::getSubdetectorEnergies ( ) const

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.

Implements EVENT::Cluster.

int IMPL::ClusterImpl::getType ( ) const

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. The definition of the bits has to be done elsewhere, e.g. in the run header. Bits 16-31 are used internally.

Implements EVENT::Cluster.

EVENT::FloatVec & IMPL::ClusterImpl::subdetectorEnergies

(

)

To be used for modifying the subdetector energies, e.g.

clu->subdetectorEnergies().resize(3) ; clu->subdetectorEnergies()[0] = 123.4567 ; clu->subdetectorEnergies()[1] = 12.34567 ; clu->subdetectorEnergies()[2] = 1.234567 ;

---

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

• ClusterImpl.h
• ClusterImpl.cc