org.lcsim.event

Interface CalorimeterHit

All Superinterfaces:

HasDetectorElement, Hit, Identifiable

All Known Subinterfaces:

SimCalorimeterHit

All Known Implementing Classes:

BaseCalorimeterHit, BaseSimCalorimeterHit, SIOCalorimeterHit, SIOSimCalorimeterHit

public interface CalorimeterHit
extends Hit

This class represents a hit in a calorimeter detector which has an energy deposition in GeV, a time in nanoseconds, and an ID identifying its cell or channel in the detector.

The super-interface gives access to subdetector, identifiers, iddecoder, etc.

Author:

Tony Johnson , Jeremy McCormick

See Also:

Hit

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CalorimeterHit.CorrectedEnergyComparator CalorimeterHit corrected energy comparator.
static class	CalorimeterHit.RawEnergyComparator CalorimeterHit raw energy comparator.
static class	CalorimeterHit.TimeComparator CalorimeterHit time comparator.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCellID() Get the ID of the cell or channel.
double	getCorrectedEnergy() Get the corrected energy deposition in GeV.
double	getEnergyError() Get the energy error.
double[]	getPosition() Get the position of the hit in millimeters with the global coordinate system.
double	getRawEnergy() Get the raw energy deposition in GeV.
double	getTime() Get the time of the earliest energy contribution to this hit in nanoseconds.
int	getType() Get the type of the hit.

Methods inherited from interface org.lcsim.event.Hit

getBarrelEndcapFlag, getDetectorIdentifierHelper, getIDDecoder, getIdentifierFieldValue, getLayerNumber, getMetaData, getPositionVec, getSubdetector, getSystemId, setMetaData

Methods inherited from interface org.lcsim.detector.HasDetectorElement

getDetectorElement, setDetectorElement

Methods inherited from interface org.lcsim.detector.identifier.Identifiable

getExpandedIdentifier, getIdentifier, getIdentifierHelper

Method Detail

getRawEnergy

double getRawEnergy()

Get the raw energy deposition in GeV.

Returns:

The raw energy deposition.

getCorrectedEnergy

double getCorrectedEnergy()

Get the corrected energy deposition in GeV.

Returns:

The corrected energy deposition

getEnergyError

double getEnergyError()

Get the energy error. (Units???)

Returns:

The energy error.

getCellID

long getCellID()

Get the ID of the cell or channel. This can be converted to a physical position using a IDDecoder object obtained from the hit or from the collection's MetaData object.

Returns:

The cell or channel ID of the hit.

getTime

double getTime()

Get the time of the earliest energy contribution to this hit in nanoseconds.

Returns:

The hit time in nanoseconds.

getPosition

double[] getPosition()

Get the position of the hit in millimeters with the global coordinate system. If the hit position is stored in the LCIO data, this will be returned directly. Otherwise the IDDecoder is used to get the hit position from the hit ID.

Specified by:

getPosition in interface Hit

Returns:

The position in millimeters as a double array of length 3.

getType

int getType()

Get the type of the hit. Mapping of integer types to type names through collection parameters "CalorimeterHitTypeNames" and "CalorimeterHitTypeValues".

Returns:

The type of the hit.