Cluster

All Superinterfaces:

Cloneable, LCObject

All Known Implementing Classes:

ICluster
```
public interface Cluster
extends LCObject
```
The LCIO cluster.

Method Summary

All Methods Instance Methods Abstract Methods
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.

- Method Detail
  - getType
```
int getType()
```
    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.
  - getEnergy
```
float getEnergy()
```
    Energy of the cluster.
  - getEnergyError
```
float getEnergyError()
```
    Returns the error on the energy of the cluster.
  - getPosition
```
float[] getPosition()
```
    Position of the cluster.
  - getPositionError
```
float[] getPositionError()
```
    Covariance matrix of the position (6 Parameters)
  - getIPhi
```
float getIPhi()
```
    Intrinsic direction of cluster at position: Phi. Not to be confused with direction cluster is seen from IP.
  - getITheta
```
float getITheta()
```
    Intrinsic direction of cluster at position: Theta. Not to be confused with direction cluster is seen from IP.
  - getDirectionError
```
float[] getDirectionError()
```
    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).
  - getShape
```
float[] getShape()
```
    Shape parameters - check/set collection parameter ClusterShapeParameters for size and names of parameters.
  - getParticleIDs
```
List getParticleIDs()
```
    The particle Id's sorted by their likelihood.
    
    See Also:
    
    ParticleID
  - getClusters
```
List getClusters()
```
    The clusters that have been combined to this cluster.
  - getCalorimeterHits
```
List getCalorimeterHits()
```
    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
  - getHitContributions
```
float[] getHitContributions()
```
    Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits()
  - getSubdetectorEnergies
```
float[] getSubdetectorEnergies()
```
    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.

Interface Cluster

Method Summary

Method Detail

getType

getEnergy

getEnergyError

getPosition

getPositionError

getIPhi

getITheta

getDirectionError

getShape

getParticleIDs

getClusters

getCalorimeterHits

getHitContributions

getSubdetectorEnergies