hep.lcio.implementation.event

Class ICluster

java.lang.Object

hep.lcio.implementation.event.ICluster

All Implemented Interfaces:

Cluster, LCObject, Cloneable

public class ICluster
extends Object
implements Cluster

Constructor Summary

Constructors

Constructor and Description
ICluster()

Method Summary

Modifier and Type	Method and Description
List	getCalorimeterHits() The hits that have been combined to this cluster.
List	getClusters() The clusters that have been combined to this cluster.
float[]	getDirectionError() Covariance matrix of the direction (3 Parameters).
float	getEnergy() Energy of the cluster.
float	getEnergyError() Returns the error on the energy of the cluster.
float[]	getHitContributions() Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits()
float	getIPhi() Intrinsic direction of cluster at position: Phi.
float	getITheta() Intrinsic direction of cluster at position: Theta.
List	getParticleIDs() The particle Id's sorted by their likelihood.
float[]	getPosition() Position of the cluster.
float[]	getPositionError() Covariance matrix of the position (6 Parameters)
float[]	getShape() Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters.
float[]	getSubdetectorEnergies() A vector that holds the energy observed in a particular subdetectors.
int	getType() Flagword that defines the type of cluster.
void	setCalorimeterHits(List calorimeterHits, float[] hitContributions)
void	setClusters(List clusters)
void	setDirectionError(float[] directionError)
void	setEnergy(float energy)
void	setEnergyError(float energyError)
void	setIPhi(float phi)
void	setITheta(float theta)
void	setParticleIDs(List list)
void	setPosition(float[] position)
void	setPositionError(float[] positionError)
void	setShape(float[] shape)
void	setSubdetectorEnergies(float[] fs)
void	setType(int type)
void	setTypeBit(int bit)
void	setTypeBit(int bit, boolean val)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ICluster

public ICluster()

Method Detail

getCalorimeterHits

public List getCalorimeterHits()

Description copied from interface: Cluster

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.

Specified by:

getCalorimeterHits in interface Cluster

See Also:

CalorimeterHit

getClusters

public List getClusters()

Description copied from interface: Cluster

The clusters that have been combined to this cluster.

Specified by:

getClusters in interface Cluster

getDirectionError

public float[] getDirectionError()

Description copied from interface: Cluster

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

Specified by:

getDirectionError in interface Cluster

getEnergy

public float getEnergy()

Description copied from interface: Cluster

Energy of the cluster.

Specified by:

getEnergy in interface Cluster

getEnergyError

public float getEnergyError()

Description copied from interface: Cluster

Returns the error on the energy of the cluster.

Specified by:

getEnergyError in interface Cluster

getHitContributions

public float[] getHitContributions()

Description copied from interface: Cluster

Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits()

Specified by:

getHitContributions in interface Cluster

getIPhi

public float getIPhi()

Description copied from interface: Cluster

Intrinsic direction of cluster at position: Phi. Not to be confused with direction cluster is seen from IP.

Specified by:

getIPhi in interface Cluster

getPosition

public float[] getPosition()

Description copied from interface: Cluster

Position of the cluster.

Specified by:

getPosition in interface Cluster

getPositionError

public float[] getPositionError()

Description copied from interface: Cluster

Covariance matrix of the position (6 Parameters)

Specified by:

getPositionError in interface Cluster

getShape

public float[] getShape()

Description copied from interface: Cluster

Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters.

Specified by:

getShape in interface Cluster

getITheta

public float getITheta()

Description copied from interface: Cluster

Intrinsic direction of cluster at position: Theta. Not to be confused with direction cluster is seen from IP.

Specified by:

getITheta in interface Cluster

getType

public int getType()

Description copied from interface: Cluster

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.

Specified by:

getType in interface Cluster

setCalorimeterHits

public void setCalorimeterHits(List calorimeterHits,
                               float[] hitContributions)

setClusters

public void setClusters(List clusters)

setDirectionError

public void setDirectionError(float[] directionError)

setEnergy

public void setEnergy(float energy)

setEnergyError

public void setEnergyError(float energyError)

setIPhi

public void setIPhi(float phi)

setPosition

public void setPosition(float[] position)

setPositionError

public void setPositionError(float[] positionError)

setShape

public void setShape(float[] shape)

setITheta

public void setITheta(float theta)

setType

public void setType(int type)

setTypeBit

public void setTypeBit(int bit)

setTypeBit

public void setTypeBit(int bit,
                       boolean val)

getSubdetectorEnergies

public float[] getSubdetectorEnergies()

Description copied from interface: Cluster

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.

Specified by:

getSubdetectorEnergies in interface Cluster

setSubdetectorEnergies

public void setSubdetectorEnergies(float[] fs)

getParticleIDs

public List getParticleIDs()

Description copied from interface: Cluster

The particle Id's sorted by their likelihood.

Specified by:

getParticleIDs in interface Cluster

See Also:

ParticleID

setParticleIDs

public void setParticleIDs(List list)