org.hps.recon.ecal.cluster

Class ReconClusterDriver

java.lang.Object

org.lcsim.util.Driver

org.hps.recon.ecal.cluster.ClusterDriver

org.hps.recon.ecal.cluster.ReconClusterDriver

public class ReconClusterDriver
extends ClusterDriver

This is an implementation of ClusterDriver specialized for the ReconClusterer. It currently implements optional writing of a rejected hit list to the LCSim event.

Author:

Jeremy McCormick

See Also:

ReconClusterer

Nested Class Summary

Nested classes/interfaces inherited from class org.lcsim.util.Driver

org.lcsim.util.Driver.AbortRunException, org.lcsim.util.Driver.NextEventException

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	rejectedHitCollectionName
(package private) boolean	writeRejectedHitCollection

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

clusterer, createEmptyClusterCollection, cuts, ecal, ecalName, inputHitCollectionName, neighborMap, outputClusterCollectionName, raiseErrorNoHitCollection, skipNoClusterEvents, sortHits, storeHits, validateClusters, writeClusterCollection

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
ReconClusterDriver()

Method Summary

Modifier and Type	Method and Description
(package private) ReconClusterer	getReconClusterer()
void	process(org.lcsim.event.EventHeader event) Perform standard event processing, optionally writing the rejected hit list.
void	setClusterEnergyThreshold(double clusterEnergyThreshold)
void	setClusterer(Clusterer clusterer) Set the Clusterer which implements the clustering algorithm.
void	setClustererName(String clustererName) Set the Clusterer by name.
void	setHitEnergyThreshold(double hitEnergyThreshold)
void	setMinTime(double minTime)
void	setRejectedHitCollectionName(String rejectedHitCollectionName) Set the name of the list of rejected hits.
void	setSeedEnergyThreshold(double seedEnergyThreshold)
void	setTimeWindow(double timeWindow)
void	setUseTimeCut(boolean useTimeCut)
void	setWriteRejectedHitCollection(boolean writeRejectedHitCollection) This controls whether the rejected hit collection is written out.
void	startOfData() Perform job initialization.
(package private) void	writeRejectedHitList(org.lcsim.event.EventHeader event) Write the list of rejected hits to the event, according to current Driver parameter settings.

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

detectorChanged, getClusterer, printHitIDs, setCreateEmptyClusterCollection, setCuts, setEcalName, setInputHitCollectionName, setOutputClusterCollectionName, setRaiseErrorNoHitCollection, setSkipNoClusterEvents, setSortHits, setStoreHits, setValidateClusters, setWriteClusterCollection, validateClusters

Methods inherited from class org.lcsim.util.Driver

add, clearStatistics, contains, drivers, endOfData, getConditionsManager, getHistogramLevel, getLogger, getName, getRandom, printStatistics, processChildren, remove, resume, setHistogramLevel, setLogLevel, setRandom, suspend

Methods inherited from class java.lang.Object

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

Field Detail

rejectedHitCollectionName

String rejectedHitCollectionName

writeRejectedHitCollection

boolean writeRejectedHitCollection

Constructor Detail

ReconClusterDriver

public ReconClusterDriver()

Method Detail

setClusterer

public void setClusterer(Clusterer clusterer)

Description copied from class: ClusterDriver

Set the Clusterer which implements the clustering algorithm.

Overrides:

setClusterer in class ClusterDriver

Parameters:

clusterer - The Clusterer.

setClustererName

public void setClustererName(String clustererName)

Description copied from class: ClusterDriver

Set the Clusterer by name. This will use a factory method which first tries to use some hard-coded names from the cluster package. As a last resort, it will interpret the name as a canonical class name and try to instantiate it using the Class API.

Overrides:

setClustererName in class ClusterDriver

Parameters:

clustererName - The name or canonical class name of the Clusterer.

setHitEnergyThreshold

public void setHitEnergyThreshold(double hitEnergyThreshold)

setSeedEnergyThreshold

public void setSeedEnergyThreshold(double seedEnergyThreshold)

setClusterEnergyThreshold

public void setClusterEnergyThreshold(double clusterEnergyThreshold)

setMinTime

public void setMinTime(double minTime)

setTimeWindow

public void setTimeWindow(double timeWindow)

setUseTimeCut

public void setUseTimeCut(boolean useTimeCut)

startOfData

public void startOfData()

Perform job initialization.

Overrides:

startOfData in class ClusterDriver

setRejectedHitCollectionName

public void setRejectedHitCollectionName(String rejectedHitCollectionName)

Set the name of the list of rejected hits. By default, the name is null and so rejected hits will not be written unless this is called.

Parameters:

rejectedHitCollectionName - The name of the rejected hit list.

setWriteRejectedHitCollection

public void setWriteRejectedHitCollection(boolean writeRejectedHitCollection)

This controls whether the rejected hit collection is written out.

Parameters:

writeRejectedHitCollection - True to write rejected hit collection.

process

public void process(org.lcsim.event.EventHeader event)

Perform standard event processing, optionally writing the rejected hit list.

Overrides:

process in class ClusterDriver

writeRejectedHitList

void writeRejectedHitList(org.lcsim.event.EventHeader event)

Write the list of rejected hits to the event, according to current Driver parameter settings.

getReconClusterer

ReconClusterer getReconClusterer()