MipStub (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.recon.cat.MipStub

All Implemented Interfaces:

Cluster
```
public final class MipStub
extends Object
implements Cluster
```
Simple data format for Minimum ionizing particles in the ECAL. MipStub is used within the Garfield track finding package for calorimeter assisted tracking with the SiD

Version:

$Id: MipStub.java,v 1.3 2012/07/23 10:56:43 grefe Exp $

Author:

E. von Toerne

See Also:
EmcalMipStubs, GarfieldTrackFinder

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`angleBaseDir`
`double[]`	`base`
`private double`	`baseError`
`private Cluster`	`cluster`
`int`	`debugLevel`
`double[]`	`dir`
`private double`	`dirXYError`
`private double`	`dirZError`
`double`	`energy`
`private double`	`energyError`
`private boolean`	`isEndcap`
`(package private) static double`	`k_cm`
`double`	`kappa`
`private double`	`kappaError`
`private MCParticle[]`	`mcParticles`
`private int`	`minLayer`
`private int`	`nHits`

Constructor Summary

Constructors
Constructor and Description
`MipStub()` Default constructor
`MipStub(double[] p, double[] d, double ka, int nHit, boolean isNdCap, int minLay)` standard constructor
`MipStub(double[] p, double[] d, double ka, int nHit, boolean isNdCap, int minLay, Cluster cluster)` Standard constructor that also takes a reference to the original cluster (temporary, D.O.)

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`charge()`
`(package private) void`	`debug()`
`double`	`getAngleBaseDir()`
`double`	`getBaseError()`
`List<CalorimeterHit>`	`getCalorimeterHits()` The hits that have been combined to this cluster.
`List<Cluster>`	`getClusters()` The clusters that have been combined to this cluster.
`double[]`	`getDirectionError()` Covariance matrix of the direction (3 Parameters)
`double`	`getDirXYError()`
`double`	`getDirZError()`
`double`	`getEnergy()` Energy of the 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.
`double`	`getKappaError()`
`MCParticle[]`	`getMCParticles()`
`int`	`getMinLayer()`
`int`	`getnHits()`
`int`	`getParticleId()`
`double`	`getPhi()`
`double[]`	`getPosition()` Position of the cluster.
`double[]`	`getPositionError()` Covariance matrix of the position (6 Parameters)
`double[]`	`getShape()` Shape parameters (6 Parameters) - TO DO: definition
`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.
`boolean`	`isEndcap()`
`double`	`kappa()`
`private void`	`normalizeDir()` normalizes the direction vector.
`List`	`plot()` prepares graphic presentation of a mipstub by providing a list of positions this plot routine uses quite a bit of memory.
`private void`	`setAngleBaseDir()` calculates the angle from base to the dir vector in the xy plane.
`private void`	`setBaseError()`
`private void`	`setDirError()` calculates a rough error estimate for direction vector in XY plane based on `nHits` only
`void`	`setEnergyError(double energyError)`
`void`	`setKappa(double ka)`
`private void`	`setKappaError()`
`void`	`setMCParticles(MCParticle[] mcParticles)`

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

- Field Detail
  - base
```
public double[] base
```
  - dir
```
public double[] dir
```
  - kappa
```
public double kappa
```
  - baseError
```
private double baseError
```
  - dirXYError
```
private double dirXYError
```
  - dirZError
```
private double dirZError
```
  - kappaError
```
private double kappaError
```
  - isEndcap
```
private boolean isEndcap
```
  - energy
```
public double energy
```
  - energyError
```
private double energyError
```
  - angleBaseDir
```
public double angleBaseDir
```
  - k_cm
```
static final double k_cm
```
    See Also:
    Constant Field Values
  - debugLevel
```
public int debugLevel
```
  - nHits
```
private int nHits
```
  - minLayer
```
private int minLayer
```
  - mcParticles
```
private MCParticle[] mcParticles
```
  - cluster
```
private Cluster cluster
```
- Constructor Detail
  - MipStub
```
public MipStub()
```
    Default constructor
  - MipStub
```
public MipStub(double[] p,
       double[] d,
       double ka,
       int nHit,
       boolean isNdCap,
       int minLay)
```
    standard constructor
    
    Parameters:
    p - base, which is also the entrance point into the ECAL
    d - direction of MIP at entrance point
    ka - curvature (one over curvature radius)
    nHit - number of hits in cluster
    isNdCap - boolean, true if MipStub and its cluster is in Endcap
    minLay - Minimum layer in ECAL (approx. 0 for MIPS)
  - MipStub
```
public MipStub(double[] p,
       double[] d,
       double ka,
       int nHit,
       boolean isNdCap,
       int minLay,
       Cluster cluster)
```
    Standard constructor that also takes a reference to the original cluster (temporary, D.O.)
    
    Parameters:
    p - base, which is also the entrance point into the ECAL
    d - direction of MIP at entrance point
    ka - curvature (one over curvature radius)
    nHit - number of hits in cluster
    isNdCap - boolean, true if MipStub and its cluster is in Endcap
    minLay - Minimum layer in ECAL (approx. 0 for MIPS)
    cluster - Cluster from which this MIP stub was created
- Method Detail
  - kappa
```
public double kappa()
```
  - getnHits
```
public int getnHits()
```
  - getPhi
```
public double getPhi()
```
  - getAngleBaseDir
```
public double getAngleBaseDir()
```
  - getDirXYError
```
public double getDirXYError()
```
  - getDirZError
```
public double getDirZError()
```
  - getBaseError
```
public double getBaseError()
```
  - getKappaError
```
public double getKappaError()
```
  - getMinLayer
```
public int getMinLayer()
```
  - isEndcap
```
public boolean isEndcap()
```
  - charge
```
public int charge()
```
  - getMCParticles
```
public MCParticle[] getMCParticles()
```
  - 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)
```
  - setMCParticles
```
public void setMCParticles(MCParticle[] mcParticles)
```
  - setKappa
```
public void setKappa(double ka)
```
  - normalizeDir
```
private void normalizeDir()
```
    normalizes the direction vector. convention here follows GarfieldHelix xy-projection of dir is of length one.
    
    See Also:
    GarfieldHelix
  - setAngleBaseDir
```
private void setAngleBaseDir()
```
    calculates the angle from base to the dir vector in the xy plane.
  - setDirError
```
private void setDirError()
```
    calculates a rough error estimate for direction vector in XY plane based on nHits only
  - setBaseError
```
private void setBaseError()
```
  - setKappaError
```
private void setKappaError()
```
  - debug
```
void debug()
```
  - plot
```
public List plot()
```
    prepares graphic presentation of a mipstub by providing a list of positions this plot routine uses quite a bit of memory.
  - 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
  - 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
  - getShape
```
public double[] getShape()
```
    Description copied from interface: Cluster
    
    Shape parameters (6 Parameters) - TO DO: definition
    
    Specified by:
    
    getShape 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
  - getPosition
```
public double[] getPosition()
```
    Description copied from interface: Cluster
    
    Position of the cluster.
    
    Specified by:
    
    getPosition 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
  - 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
  - getEnergy
```
public double getEnergy()
```
    Description copied from interface: Cluster
    
    Energy of the cluster.
    
    Specified by:
    
    getEnergy 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
  - getClusters
```
public List<Cluster> getClusters()
```
    Description copied from interface: Cluster
    
    The clusters that have been combined to this cluster.
    
    Specified by:
    
    getClusters in interface Cluster
  - getCalorimeterHits
```
public List<CalorimeterHit> 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
  - 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
  - getParticleId
```
public int getParticleId()
```
    Specified by:
    
    getParticleId in interface Cluster

Class MipStub

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

base

dir

kappa

baseError

dirXYError

dirZError

kappaError

isEndcap

energy

energyError

angleBaseDir

k_cm

debugLevel

nHits

minLayer

mcParticles

cluster

Constructor Detail

MipStub

MipStub

MipStub

Method Detail

kappa

getnHits

getPhi

getAngleBaseDir

getDirXYError

getDirZError

getBaseError

getKappaError

getMinLayer

isEndcap

charge

getMCParticles

getEnergyError

setEnergyError

setMCParticles

setKappa

normalizeDir

setAngleBaseDir

setDirError

setBaseError

setKappaError

debug

plot

getType

getSubdetectorEnergies

getShape

getPositionError

getPosition

getITheta

getIPhi

getHitContributions

getEnergy

getDirectionError

getClusters

getCalorimeterHits

getSize

getParticleId