org.hps.recon.ecal.cluster

Class SimpleCosmicClusterer

java.lang.Object

org.hps.recon.ecal.cluster.AbstractClusterer

org.hps.recon.ecal.cluster.SimpleCosmicClusterer

All Implemented Interfaces:

EventListener, Clusterer, org.lcsim.conditions.ConditionsListener

Direct Known Subclasses:

DualThresholdCosmicClusterer

public class SimpleCosmicClusterer
extends AbstractClusterer

This algorithm clusters an input list of CalorimeterHits using an iterative nearest neighbor algorithm.

There is a set of cuts applied on the initial cluster list that includes the following defaults:

• must have at least 3 hits total in the cluster
• must have at least three rows of crystals with hits
• must have no more than 2 hits in each row of crystals

This algorithm does not cluster across the beam gap. Separate clusters are made for the top and bottom sets of crystals.

Author:

Jeremy McCormick , Tim "THammer" Nelson

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxHitsPerRow
protected int	minClusterSize
protected int	minRows

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

cuts, ecal, neighborMap

Constructor Summary

Constructors

Constructor and Description
SimpleCosmicClusterer() Default constructor that sets cut names and default values.

Method Summary

Modifier and Type	Method and Description
protected List<org.lcsim.event.Cluster>	applyCuts(List<org.lcsim.event.Cluster> clusterList) Apply selection cuts to cluster list and return filtered list.
List<org.lcsim.event.Cluster>	createClusters(org.lcsim.event.EventHeader event, List<org.lcsim.event.CalorimeterHit> hitList) This method implements the cosmic clustering algorithm which uses a iterative nearest neighbor algorithm.
ClusterType	getClusterType() Get the type code for the clusters produced by this algorithm.
void	initialize() Initialize some instance variables from cut settings.

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

minClusterSize

protected int minClusterSize

minRows

protected int minRows

maxHitsPerRow

protected int maxHitsPerRow

Constructor Detail

SimpleCosmicClusterer

SimpleCosmicClusterer()

Default constructor that sets cut names and default values.

Method Detail

initialize

public void initialize()

Initialize some instance variables from cut settings.

Specified by:

initialize in interface Clusterer

Overrides:

initialize in class AbstractClusterer

createClusters

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

This method implements the cosmic clustering algorithm which uses a iterative nearest neighbor algorithm. It uses each hit as a seed and tries to then extend the cluster by adding neighboring hits. Clustered hits are added to a list which is checked so that they are not reused.

Specified by:

createClusters in interface Clusterer

Specified by:

createClusters in class AbstractClusterer

Parameters:

hitList - The input hit list of hits.

event - The current LCSim event.

Returns:

A list of calorimeter hits that can be turned into clusters.

applyCuts

protected List<org.lcsim.event.Cluster> applyCuts(List<org.lcsim.event.Cluster> clusterList)

Apply selection cuts to cluster list and return filtered list.

Parameters:

clusterList - The input hit lists.

Returns:

The hit lists that passed the cuts.

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.