ReconCluster (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.mc.fast.cluster.ronan.ReconCluster

All Implemented Interfaces:

Cluster

Direct Known Subclasses:

ReconEMCluster, ReconHADCluster
```
public abstract class ReconCluster
extends Object
implements Cluster
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`a`
`protected double`	`b`
`protected double`	`c`
`protected double`	`d`
`protected double`	`energy`
`protected double`	`energyError`
`protected Particle`	`mcp`
`protected double`	`neg_energy`
`protected ClusterResolutionTables`	`parm`
`protected double`	`phi`
`protected double`	`radius`
`protected double`	`sigma`
`protected double`	`theta`
`protected double`	`transDist`

Constructor Summary

Constructors
Constructor and Description

ReconCluster(ClusterResolutionTables parm, Random rand, Particle mcp, boolean hist)

Constructors
Constructor and Description
`ReconCluster(ClusterResolutionTables parm, Random rand, Particle mcp, boolean hist)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`adjustEnergy(double neg_energy_total, double pos_energy_weight_total)`
`List`	`getCalorimeterHits()` The hits that have been combined to this cluster.
`List`	`getClusters()` The clusters that have been combined to this cluster.
`double[]`	`getDirectionError()` Covariance matrix of the direction (3 Parameters)
`double`	`getEnergy()` Best estimate for total energy of cluster
`double`	`getEnergyError()` Energy error of the cluster.
`double[]`	`getHitContributions()` Returns the energy contribution of the hits Runs parallel to the CalorimeterHitVec from getCalorimeterHits()
`double`	`getIPhi()` Intrinsic direction of cluster at position: Phi.
`double`	`getITheta()` Intrinsic direction of cluster at position: Theta.
`Particle`	`getMCParticle()`
`double`	`getNegEnergy()`
`int`	`getParticleId()`
`double[]`	`getParticleType()`
`double[]`	`getPosition()` Position of the cluster.
`double[]`	`getPositionError()` Covariance matrix of the position (6 Parameters)
`double[]`	`getShape()` Shape parameters (6 Parameters) - TO DO: definition
`double`	`getSigma()`
`int`	`getSize()` Number of hits in cluster.
`double[]`	`getSubdetectorEnergies()` A vector that holds the energy observed in a particular subdetectors.
`int`	`getType()` Flagword that defines the type of cluster.
`void`	`setEnergyError(double energyError)`
`protected void`	`smear(Random rand, boolean hist)`
`protected void`	`smearEnergy(Random rand, double E, boolean hist)`
`protected void`	`smearPosition(Random rand)`
`(package private) abstract void`	`smearPosition(Random rand, double E, boolean hist)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - parm
```
protected ClusterResolutionTables parm
```
  - mcp
```
protected Particle mcp
```
  - a
```
protected double a
```
  - b
```
protected double b
```
  - c
```
protected double c
```
  - d
```
protected double d
```
  - energy
```
protected double energy
```
  - energyError
```
protected double energyError
```
  - neg_energy
```
protected double neg_energy
```
  - sigma
```
protected double sigma
```
  - phi
```
protected double phi
```
  - radius
```
protected double radius
```
  - theta
```
protected double theta
```
  - transDist
```
protected double transDist
```
- Constructor Detail
  - ReconCluster
```
ReconCluster(ClusterResolutionTables parm,
            Random rand,
            Particle mcp,
            boolean hist)
```
- Method Detail
  - getEnergy
```
public double getEnergy()
```
    Best estimate for total energy of cluster
    
    Specified by:
    
    getEnergy in interface Cluster
  - getEnergyError
```
public double getEnergyError()
```
    Description copied from interface: Cluster
    
    Energy error of the cluster.
    
    Specified by:
    
    getEnergyError in interface Cluster
  - setEnergyError
```
public void setEnergyError(double energyError)
```
  - getNegEnergy
```
public double getNegEnergy()
```
  - getSigma
```
public double getSigma()
```
  - adjustEnergy
```
public void adjustEnergy(double neg_energy_total,
                double pos_energy_weight_total)
```
  - smear
```
protected void smear(Random rand,
         boolean hist)
```
  - smearEnergy
```
protected void smearEnergy(Random rand,
               double E,
               boolean hist)
```
  - smearPosition
```
protected void smearPosition(Random rand)
```
  - getMCParticle
```
public Particle getMCParticle()
```
  - smearPosition
```
abstract void smearPosition(Random rand,
                 double E,
                 boolean hist)
```
  - getHitContributions
```
public double[] 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
  - getClusters
```
public List getClusters()
```
    Description copied from interface: Cluster
    
    The clusters that have been combined to this cluster.
    
    Specified by:
    
    getClusters in interface Cluster
  - getSubdetectorEnergies
```
public double[] 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.
    
    Specified by:
    
    getSubdetectorEnergies in interface Cluster
  - getPositionError
```
public double[] getPositionError()
```
    Description copied from interface: Cluster
    
    Covariance matrix of the position (6 Parameters)
    
    Specified by:
    
    getPositionError 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. The definition of the bits has to be done elsewhere, e.g. in the run header. Bits 16-31 are used internally.
    
    Specified by:
    
    getType in interface Cluster
  - getITheta
```
public double 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
  - getIPhi
```
public double 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
  - getDirectionError
```
public double[] getDirectionError()
```
    Description copied from interface: Cluster
    
    Covariance matrix of the direction (3 Parameters)
    
    Specified by:
    
    getDirectionError in interface Cluster
  - getCalorimeterHits
```
public List getCalorimeterHits()
```
    Description copied from interface: Cluster
    
    The hits that have been combined to this cluster. Only available if CalorimeterHit objects have been saved with LCIO::RCHBIT_PTR==1.
    
    Specified by:
    
    getCalorimeterHits in interface Cluster
    
    See Also:
    CalorimeterHit
  - getShape
```
public double[] getShape()
```
    Description copied from interface: Cluster
    
    Shape parameters (6 Parameters) - TO DO: definition
    
    Specified by:
    
    getShape in interface Cluster
  - getPosition
```
public double[] getPosition()
```
    Description copied from interface: Cluster
    
    Position of the cluster.
    
    Specified by:
    
    getPosition in interface Cluster
  - getParticleType
```
public double[] getParticleType()
```
  - getParticleId
```
public int getParticleId()
```
    Specified by:
    
    getParticleId in interface Cluster
  - getSize
```
public int getSize()
```
    Description copied from interface: Cluster
    
    Number of hits in cluster. Hits on subclusters should be included, and hits belonging to more than one subclusters should be counted only once.
    
    Specified by:
    
    getSize in interface Cluster

Class ReconCluster

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parm

mcp

a

b

c

d

energy

energyError

neg_energy

sigma

phi

radius

theta

transDist

Constructor Detail

ReconCluster

Method Detail

getEnergy

getEnergyError

setEnergyError

getNegEnergy

getSigma

adjustEnergy

smear

smearEnergy

smearPosition

getMCParticle

smearPosition

getHitContributions

getClusters

getSubdetectorEnergies

getPositionError

getType

getITheta

getIPhi

getDirectionError

getCalorimeterHits

getShape

getPosition

getParticleType

getParticleId

getSize