org.hps.recon.ecal.cluster

Class ReconClusterer

java.lang.Object

org.hps.recon.ecal.cluster.AbstractClusterer

org.hps.recon.ecal.cluster.ReconClusterer

All Implemented Interfaces:

EventListener, Clusterer, org.lcsim.conditions.ConditionsListener

public class ReconClusterer
extends AbstractClusterer

This class creates clusters from a CalorimeterHit input collection.

This clustering logic is based on that from the CLAS-Note-2005-001.

The analysis and position corrections are described in HPS Note 2014-001.

The algorithm sorts hits from highest to lowest energy and builds clusters around each local maximum/seed hit. Common hits are distributed between clusters when minimum between two clusters. There is a threshold cut for minimum hit energy, minimum cluster energy, and minimum seed hit energy. There is also a timing threshold with respect to the seed hit. All of these parameters are tunable and should be refined with more analysis. Energy corrections are applied separately.

Author:

Holly Szumila-Vance , Kyle McCarty , Jeremy McCormick

See Also:

AbstractClusterer, Clusterer

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double	clusterEnergyThreshold
(package private) Map<Point,double[]>	correctedPositionMap
(package private) double	hitEnergyThreshold
(package private) double	minTime
(package private) List<org.lcsim.event.CalorimeterHit>	rejectedHitList
(package private) double	seedEnergyThreshold
(package private) double	timeWindow
(package private) boolean	useTimeCut

Fields inherited from class org.hps.recon.ecal.cluster.AbstractClusterer

cuts, ecal, neighborMap

Constructor Summary

Constructors

Constructor and Description
ReconClusterer()

Method Summary

Modifier and Type	Method and Description
private void	addToMap(org.lcsim.event.CalorimeterHit hit) This constructs a mapping of a crystal to an x,y position at the face of the ecal.
private void	calculatePosition(org.lcsim.event.base.BaseCluster cluster) Calculates the position of each cluster with no correction for particle type as documented in HPS Note 2014-001.
List<org.lcsim.event.Cluster>	createClusters(org.lcsim.event.EventHeader event, List<org.lcsim.event.CalorimeterHit> hitList) This is the primary method for sub-classes to implement their clustering algorithm.
private boolean	equalEnergies(org.lcsim.event.CalorimeterHit hit, org.lcsim.event.CalorimeterHit neighbor) Handles pathological case where multiple neighboring crystals have EXACTLY the same energy.
ClusterType	getClusterType() Get the type code for the clusters produced by this algorithm.
(package private) List<org.lcsim.event.CalorimeterHit>	getRejectedHitList() Get the list of rejected hits that was made from processing the last event.
void	initialize() By default nothing is done in this method, but start of job initialization can happen here like reading cut settings into instance variables for convenience.
(package private) void	setUseTimeCut(boolean useTimeCut)

Methods inherited from class org.hps.recon.ecal.cluster.AbstractClusterer

conditionsChanged, createBasicCluster, getClusterTypeEncoding, getCuts, getIdentifierHelper

Methods inherited from class java.lang.Object

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

Field Detail

hitEnergyThreshold

double hitEnergyThreshold

seedEnergyThreshold

double seedEnergyThreshold

clusterEnergyThreshold

double clusterEnergyThreshold

useTimeCut

boolean useTimeCut

minTime

double minTime

timeWindow

double timeWindow

correctedPositionMap

Map<Point,double[]> correctedPositionMap

rejectedHitList

List<org.lcsim.event.CalorimeterHit> rejectedHitList

Constructor Detail

ReconClusterer

ReconClusterer()

Method Detail

setUseTimeCut

void setUseTimeCut(boolean useTimeCut)

initialize

public void initialize()

Description copied from class: AbstractClusterer

By default nothing is done in this method, but start of job initialization can happen here like reading cut settings into instance variables for convenience. This is called in the startOfData method of ClusterDriver.

Specified by:

initialize in interface Clusterer

Overrides:

initialize in class AbstractClusterer

getRejectedHitList

List<org.lcsim.event.CalorimeterHit> getRejectedHitList()

Get the list of rejected hits that was made from processing the last event.

Returns:

The list of rejected hit.

createClusters

public List<org.lcsim.event.Cluster> createClusters(org.lcsim.event.EventHeader event,
                                                    List<org.lcsim.event.CalorimeterHit> hitList)

Description copied from class: AbstractClusterer

This is the primary method for sub-classes to implement their clustering algorithm.

Specified by:

createClusters in interface Clusterer

Specified by:

createClusters in class AbstractClusterer

Parameters:

event - The current LCSim event.

hitList - the list of hits

Returns:

the list of created clusters

equalEnergies

private boolean equalEnergies(org.lcsim.event.CalorimeterHit hit,
                              org.lcsim.event.CalorimeterHit neighbor)

Handles pathological case where multiple neighboring crystals have EXACTLY the same energy.

Parameters:

hit -

neighbor - Neighbor to hit

Returns:

boolean value of if the hit is a seed

calculatePosition

private void calculatePosition(org.lcsim.event.base.BaseCluster cluster)

Calculates the position of each cluster with no correction for particle type as documented in HPS Note 2014-001.

Parameters:

cluster -

addToMap

private void addToMap(org.lcsim.event.CalorimeterHit hit)

This constructs a mapping of a crystal to an x,y position at the face of the ecal. This fills the correctedPositionMap with the position of a crystal's face from the index x,y of the crystal.

Parameters:

hit -

getClusterType

public ClusterType getClusterType()

Description copied from class: AbstractClusterer

Get the type code for the clusters produced by this algorithm.

Specified by:

getClusterType in interface Clusterer

Specified by:

getClusterType in class AbstractClusterer

Returns:

The type code of the cluster.