hep.lcio.implementation.event

Class ISimCalorimeterHit

java.lang.Object

hep.lcio.implementation.event.ISimCalorimeterHit

All Implemented Interfaces:

LCObject, SimCalorimeterHit, Cloneable

public class ISimCalorimeterHit
extends Object
implements SimCalorimeterHit

A default implementation of SimCalorimeterHit

Constructor Summary

Constructors

Constructor and Description
ISimCalorimeterHit()

Method Summary

Modifier and Type	Method and Description
void	addMCParticleContribution(MCParticle p, float energy, float time, int pdg)
void	addMCParticleContribution(MCParticle p, float energy, float time, int pdg, float[] stepPos)
int	getCellID0() Returns the detector specific (geometrical) cell id.
int	getCellID1() Returns the second detector specific (geometrical) cell id.
float	getEnergy() Returns the energy of the hit in [GeV].
float	getEnergyCont(int i) Returns the energy in [GeV] of the i-th contribution to the hit.
int	getNMCContributions() Returns the number of MC contributions to the hit.
int	getNMCParticles() Returns the number of MC contributions to the hit.
MCParticle	getParticleCont(int i) Returns the MCParticle that caused the shower responsible for this contribution to the hit.
int	getPDGCont(int i) Returns the PDG code of the shower particle that caused this contribution.
float[]	getPosition() Returns the position of the hit in world coordinates.
float[]	getStepPosition(int i) Returns the position where the energy deposited (step) occurred optional, only if bit LCIO::CHBIT_STEP is set.
float	getTimeCont(int i) Returns the time of the i-th in [ns] contribution to the hit.
void	setCellID0(int cellID)
void	setCellID1(int cellID)
void	setEnergy(float energy)
void	setPosition(float[] pos)

Methods inherited from class java.lang.Object

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

Constructor Detail

ISimCalorimeterHit

public ISimCalorimeterHit()

Method Detail

setCellID0

public void setCellID0(int cellID)

getCellID0

public int getCellID0()

Description copied from interface: SimCalorimeterHit

Returns the detector specific (geometrical) cell id.

Specified by:

getCellID0 in interface SimCalorimeterHit

setCellID1

public void setCellID1(int cellID)

getCellID1

public int getCellID1()

Description copied from interface: SimCalorimeterHit

Returns the second detector specific (geometrical) cell id. 0 if information is not stored - check the flag word (bit CHBIT_ID1) of the collection. Default is to store only cellid0.

Specified by:

getCellID1 in interface SimCalorimeterHit

setEnergy

public void setEnergy(float energy)

getEnergy

public float getEnergy()

Description copied from interface: SimCalorimeterHit

Returns the energy of the hit in [GeV].

Specified by:

getEnergy in interface SimCalorimeterHit

getEnergyCont

public float getEnergyCont(int i)

Description copied from interface: SimCalorimeterHit

Returns the energy in [GeV] of the i-th contribution to the hit.

Specified by:

getEnergyCont in interface SimCalorimeterHit

See Also:

SimCalorimeterHit.getNMCContributions()

getNMCParticles

public int getNMCParticles()

Description copied from interface: SimCalorimeterHit

Returns the number of MC contributions to the hit. 0 if information is not stored. Renamed to getNMCContributions.

Specified by:

getNMCParticles in interface SimCalorimeterHit

See Also:

SimCalorimeterHit.getNMCContributions()

getPDGCont

public int getPDGCont(int i)

Description copied from interface: SimCalorimeterHit

Returns the PDG code of the shower particle that caused this contribution. Check the flag word bit LCIO.CHBIT_STEP of the collection whether this information is available.

Specified by:

getPDGCont in interface SimCalorimeterHit

See Also:

SimCalorimeterHit.getNMCContributions()

getStepPosition

public float[] getStepPosition(int i)

Description copied from interface: SimCalorimeterHit

Returns the position where the energy deposited (step) occurred optional, only if bit LCIO::CHBIT_STEP is set.

Specified by:

getStepPosition in interface SimCalorimeterHit

getParticleCont

public MCParticle getParticleCont(int i)

Description copied from interface: SimCalorimeterHit

Returns the MCParticle that caused the shower responsible for this contribution to the hit. This is the particle that flew into the calorimeter and not the shower particle that made the energy deposition.

Specified by:

getParticleCont in interface SimCalorimeterHit

See Also:

SimCalorimeterHit.getNMCContributions()

setPosition

public void setPosition(float[] pos)

getPosition

public float[] getPosition()

Description copied from interface: SimCalorimeterHit

Returns the position of the hit in world coordinates. NULL if information is not stored - check the flag word (bit CHBIT_LONG) of the collection.

Specified by:

getPosition in interface SimCalorimeterHit

getTimeCont

public float getTimeCont(int i)

Description copied from interface: SimCalorimeterHit

Returns the time of the i-th in [ns] contribution to the hit.

Specified by:

getTimeCont in interface SimCalorimeterHit

See Also:

SimCalorimeterHit.getNMCContributions()

addMCParticleContribution

public void addMCParticleContribution(MCParticle p,
                                      float energy,
                                      float time,
                                      int pdg)

addMCParticleContribution

public void addMCParticleContribution(MCParticle p,
                                      float energy,
                                      float time,
                                      int pdg,
                                      float[] stepPos)

getNMCContributions

public int getNMCContributions()

Description copied from interface: SimCalorimeterHit

Returns the number of MC contributions to the hit. 0 if information is not stored. There are two levels of detail: if collection flag bit LCIO.CHBIT_STEP==1 then all simulator steps' contributions to the hit are stored, otherwise there is only one contribution for every particle entering the calorimeter.

Specified by:

getNMCContributions in interface SimCalorimeterHit