org.lcsim.event.base

Class BaseCluster

java.lang.Object

org.lcsim.event.base.BaseCluster

All Implemented Interfaces:

Cluster

public class BaseCluster
extends Object
implements Cluster

This is a concrete implementation of the Cluster LCIO interface.

This version is an overhaul of the previous base class, with the following changes:

• Added several constructors with argument lists, including one that is fully qualified and another that takes a list of hits only.
• Removed the prior implementation of subdetector energies in favor of a simple set method. (This part of the API is basically unused anyways.)
• Added set methods for all class variables, where they were missing.
• Added access to particle ID based on the official API.
• Added a few utility methods for adding lists of hits and clusters.
• Added a method for setting a hit contribution that is different from the corrected energy.
• Simplified the calculateProperties() method so that it doesn't do a bunch of array copies.
• Added a copy constructor and implementation of clone() method.

Author:

Jeremy McCormick , Norman Graf

See Also:

Cluster, CalorimeterHit, ClusterPropertyCalculator, TensorClusterPropertyCalculator

Field Summary

Fields

Modifier and Type	Field and Description
protected ClusterPropertyCalculator	calc
protected List<Cluster>	clusters
protected double[]	directionError
protected double	energy
protected double	energyError
protected List<Double>	hitContributions
protected List<CalorimeterHit>	hits
protected double	iphi
protected double	itheta
protected boolean	needsPropertyCalculation
protected int	pid
protected double[]	position
protected double[]	positionError
protected double[]	shapeParameters
protected double[]	subdetectorEnergies
protected int	type

Constructor Summary

Constructors

Constructor and Description
BaseCluster() The no argument constructor.
BaseCluster(Cluster cluster) Copy constructor, which will create new arrays and lists in this object so the copied cluster's data is not incorrectly referenced.
BaseCluster(List<CalorimeterHit> hits) Basic constructor that takes a list of hits.
BaseCluster(List<CalorimeterHit> hits, double energy, double energyError, double[] position, double[] positionError, double iphi, double itheta, double[] directionError, double[] shapeParameters, int type, int pid) Almost fully qualified constructor, if the cluster's properties are already calculated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCluster(Cluster cluster) Add a sub-cluster to the cluster.
void	addClusters(List<Cluster> clusters) Add a list of sub-clusters to the cluster.
void	addHit(CalorimeterHit hit) Add a hit to the cluster with default energy contribution.
void	addHit(CalorimeterHit hit, double contribution) Add a hit to the cluster with specified energy contribution.
void	addHits(List<CalorimeterHit> hits) Add a list of hits to the cluster.
void	calculateProperties() Calculate the properties of this cluster using the current ClusterPropertyCalculator.
(package private) void	checkCalculateProperties() Calculate properties if needs property calculation.
Object	clone() Clone to a new object using the copy constructor.
List<CalorimeterHit>	getCalorimeterHits() Get the list of CalorimeterHits of this cluster.
List<Cluster>	getClusters() Get the clusters that are part of this cluster.
double[]	getDirectionError() Get the direction error of the cluster as a double array of size 6.
double	getEnergy() Get the energy of the cluster, which by default will be the sum of the CalorimeterHit corrected energy values.
double	getEnergyError() Get the energy error.
double[]	getHitContributions() Get the individual hit contribution energies.
double	getIPhi() Get the intrinsic phi direction of the cluster.
double	getITheta() Get the intrinsic theta direction of the cluster.
int	getParticleId() Get the PDG ID of the particle hypothesis.
double[]	getPosition() Get the position of the cluster as a double array of size 3.
double[]	getPositionError() Get the position error of the cluster as a double array of size 6.
double[]	getShape() Get the shape parameters of the cluster as a double array of unspecified size.
int	getSize() Get the number of hits in the cluster, including hits in sub-clusters.
double[]	getSubdetectorEnergies() Get the list of subdetector energy contributions.
int	getType() Get a value defining the type of this cluster.
boolean	hasPropertyCalculator() Return true if property calculator is set.
boolean	needsPropertyCalculation() Return true if cluster is flagged as needed a property calculation.
void	removeHit(CalorimeterHit hit) Remove a hit from the cluster.
void	setDirectionError(double[] directionError) Set the direction error of the cluster.
void	setEnergy(double energy) Set a total energy of this cluster, overriding any energy value that may have been automatically calculated from hit energies.
void	setEnergyError(double energyError) Set the error on the energy measurement.
void	setIPhi(double iphi) Set the intrinsic phi of the cluster.
void	setITheta(double itheta) Set the intrinsic theta of the cluster.
void	setNeedsPropertyCalculation(boolean needsPropertyCalculation) Manually set whether the cluster needs property calculation.
void	setParticleId(int pid) Get the PDG ID of the particle hypothesis.
void	setPosition(double[] position) Set the position of the cluster.
void	setPositionError(double[] positionError) Set the position error of the cluster.
void	setPropertyCalculator(ClusterPropertyCalculator calc) Set a property calculator for computing position, etc.
void	setShapeParameters(double[] shapeParameters) Set the shape parameters of the cluster.
void	setSubdetectorEnergies(double[] subdetectorEnergies) Set the subdetector energies.
void	setType(int type) Set the type of the cluster.

Methods inherited from class java.lang.Object

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

Field Detail

calc

protected ClusterPropertyCalculator calc

clusters

protected List<Cluster> clusters

directionError

protected double[] directionError

energy

protected double energy

energyError

protected double energyError

hitContributions

protected List<Double> hitContributions

hits

protected List<CalorimeterHit> hits

iphi

protected double iphi

itheta

protected double itheta

needsPropertyCalculation

protected boolean needsPropertyCalculation

pid

protected int pid

position

protected double[] position

positionError

protected double[] positionError

shapeParameters

protected double[] shapeParameters

subdetectorEnergies

protected double[] subdetectorEnergies

type

protected int type

Constructor Detail

BaseCluster

public BaseCluster()

The no argument constructor.

BaseCluster

public BaseCluster(Cluster cluster)

Copy constructor, which will create new arrays and lists in this object so the copied cluster's data is not incorrectly referenced.

The hits in the CalorimeterHit list are not themselves copied.

Parameters:

cluster - the BaseCluster to copy

BaseCluster

public BaseCluster(List<CalorimeterHit> hits)

Basic constructor that takes a list of hits. It will apply the default energy calculation.

Parameters:

hits - the list of CalorimeterHits

BaseCluster

public BaseCluster(List<CalorimeterHit> hits,
           double energy,
           double energyError,
           double[] position,
           double[] positionError,
           double iphi,
           double itheta,
           double[] directionError,
           double[] shapeParameters,
           int type,
           int pid)

Almost fully qualified constructor, if the cluster's properties are already calculated. The energy given here will override the value calculated from the hits. If this is not desired, then another constructor should be used instead. This constructor does not allow setting hit contributions that are different from the hit energies.

Parameters:

hits - the list of hits

energy - the total energy

energyError - the energy error

position - the position

positionError - the position error

iphi - the intrinsic phi

itheta - the intrinsic theta

directionError - the direction error

shapeParameters - the shape parameters

Method Detail

addCluster

public void addCluster(Cluster cluster)

Add a sub-cluster to the cluster.

Parameters:

cluster - the cluster to add

addClusters

public void addClusters(List<Cluster> clusters)

Add a list of sub-clusters to the cluster.

Parameters:

the - list of clusters to add

addHit

public void addHit(CalorimeterHit hit)

Add a hit to the cluster with default energy contribution.

Parameters:

hit - the hit to add

addHit

public void addHit(CalorimeterHit hit,
          double contribution)

Add a hit to the cluster with specified energy contribution.

Parameters:

hit - the hit to add

contribution - the energy contribution of the hit [GeV]

addHits

public void addHits(List<CalorimeterHit> hits)

Add a list of hits to the cluster.

Parameters:

the - list of hits to add

calculateProperties

public void calculateProperties()

Calculate the properties of this cluster using the current ClusterPropertyCalculator. The calculated properties will be set on the following class variables:
position, positionError, iphi, itheta, directionError, and shapeParameters. Then needsPropertyCalculation will be set to false until the cluster's state changes.

checkCalculateProperties

void checkCalculateProperties()

Calculate properties if needs property calculation.

clone

public Object clone()

Clone to a new object using the copy constructor.

Overrides:

clone in class Object

Returns:

the new object

getCalorimeterHits

public List<CalorimeterHit> getCalorimeterHits()

Get the list of CalorimeterHits of this cluster. The hits are not necessarily unique in the list.

Specified by:

getCalorimeterHits in interface Cluster

Returns:

the hits comprising the cluster

See Also:

CalorimeterHit

getClusters

public List<Cluster> getClusters()

Get the clusters that are part of this cluster.

Specified by:

getClusters in interface Cluster

Returns:

the clusters comprising the cluster

getDirectionError

public double[] getDirectionError()

Get the direction error of the cluster as a double array of size 6.

Specified by:

getDirectionError in interface Cluster

Returns:

the direction error of the cluster

getEnergy

public double getEnergy()

Get the energy of the cluster, which by default will be the sum of the CalorimeterHit corrected energy values.

Specified by:

getEnergy in interface Cluster

Returns:

the energy of the cluster

getEnergyError

public double getEnergyError()

Get the energy error.

Specified by:

getEnergyError in interface Cluster

Returns:

the energy error

getHitContributions

public double[] getHitContributions()

Get the individual hit contribution energies. This should be an array of the same size as the hit list. By default this array contains the hit's corrected energies, but the contributions may be set to different values on a per hit basis using the addHit(CalorimeterHit, double) method.

Specified by:

getHitContributions in interface Cluster

Returns:

the individual hit contribution energies

getIPhi

public double getIPhi()

Get the intrinsic phi direction of the cluster.

Specified by:

getIPhi in interface Cluster

Returns:

the intrinsic phi direction of the cluster

getITheta

public double getITheta()

Get the intrinsic theta direction of the cluster.

Specified by:

getITheta in interface Cluster

Returns:

the intrinsic theta direction of the cluster

getParticleId

public int getParticleId()

Get the PDG ID of the particle hypothesis.

Specified by:

getParticleId in interface Cluster

Returns:

the PID

getPosition

public double[] getPosition()

Get the position of the cluster as a double array of size 3.

Specified by:

getPosition in interface Cluster

Returns:

the position of the cluster

getPositionError

public double[] getPositionError()

Get the position error of the cluster as a double array of size 6.

Specified by:

getPositionError in interface Cluster

Returns:

the position error of the cluster

getShape

public double[] getShape()

Get the shape parameters of the cluster as a double array of unspecified size.

Specified by:

getShape in interface Cluster

Returns:

the shape parameters of the cluster

getSize

public int getSize()

Get the number of hits in the cluster, including hits in sub-clusters. Hits belonging to more than one cluster are counted once.

Specified by:

getSize in interface Cluster

Returns:

the size of the cluster

getSubdetectorEnergies

public double[] getSubdetectorEnergies()

Get the list of subdetector energy contributions. The ordering and meaning of this array is unspecified by this class.

Specified by:

getSubdetectorEnergies in interface Cluster

Returns:

the list of subdetector energy contributions

getType

public int getType()

Get a value defining the type of this cluster.

Specified by:

getType in interface Cluster

Returns:

the type of this cluster

hasPropertyCalculator

public boolean hasPropertyCalculator()

Return true if property calculator is set.

Returns:

true if property calculator is set

needsPropertyCalculation

public boolean needsPropertyCalculation()

Return true if cluster is flagged as needed a property calculation.

Returns:

true if cluster needs property calculation

removeHit

public void removeHit(CalorimeterHit hit)

Remove a hit from the cluster.

Parameters:

hit - the hit to remove

setDirectionError

public void setDirectionError(double[] directionError)

Set the direction error of the cluster.

Parameters:

directionError - the direction error of the cluster

Throws:

IllegalArgumentException - if array is wrong size

setEnergy

public void setEnergy(double energy)

Set a total energy of this cluster, overriding any energy value that may have been automatically calculated from hit energies.

Parameters:

energy - the total energy of this cluster

setEnergyError

public void setEnergyError(double energyError)

Set the error on the energy measurement.

Parameters:

energyError - the error on the energ measurement

setIPhi

public void setIPhi(double iphi)

Set the intrinsic phi of the cluster.

Parameters:

iphi - the intrinsic phi of the cluster

setITheta

public void setITheta(double itheta)

Set the intrinsic theta of the cluster.

Parameters:

iphi - The intrinsic theta of the cluster.

setNeedsPropertyCalculation

public void setNeedsPropertyCalculation(boolean needsPropertyCalculation)

Manually set whether the cluster needs property calculation.

Parameters:

needsPropertyCalculation - true if cluster needs property calculation

setParticleId

public void setParticleId(int pid)

Get the PDG ID of the particle hypothesis.

setPosition

public void setPosition(double[] position)

Set the position of the cluster.

Parameters:

position - the position of the cluster

Throws:

IllegalArgumentException - if array is wrong size

setPositionError

public void setPositionError(double[] positionError)

Set the position error of the cluster.

Parameters:

positionError - the position error of the cluster

Throws:

IllegalArgumentException - if array is wrong size

setPropertyCalculator

public void setPropertyCalculator(ClusterPropertyCalculator calc)

Set a property calculator for computing position, etc.

Parameters:

calc - the property calculator

setShapeParameters

public void setShapeParameters(double[] shapeParameters)

Set the shape parameters of the cluster.

Parameters:

shapeParameters - the shape parameters

setSubdetectorEnergies

public void setSubdetectorEnergies(double[] subdetectorEnergies)

Set the subdetector energies.

Parameters:

subdetectorEnergies - the subdetector energies

setType

public void setType(int type)

Set the type of the cluster.

Parameters:

type - the type of the cluster