public interface Clusterer
extends org.lcsim.conditions.ConditionsListener
Cluster
,
CalorimeterHit
,
EventHeader
,
NumericalCuts
Modifier and Type | Method and Description |
---|---|
org.lcsim.event.base.BaseCluster |
createBasicCluster()
Create a basic
Cluster with the correct type for this algorithm. |
List<org.lcsim.event.Cluster> |
createClusters(org.lcsim.event.EventHeader event,
List<org.lcsim.event.CalorimeterHit> hits)
Create a list of output clusters from input hits.
|
ClusterType |
getClusterType()
Get the type of
Cluster created by this algorithm. |
int |
getClusterTypeEncoding()
Get the integer encoding of the
Cluster type. |
NumericalCuts |
getCuts()
Get numerical cut settings.
|
void |
initialize()
Perform start of job initialization on this object.
|
List<org.lcsim.event.Cluster> createClusters(org.lcsim.event.EventHeader event, List<org.lcsim.event.CalorimeterHit> hits)
event
- The current LCSim event.hits
- The list of hits.void initialize()
Perform start of job initialization on this object.
This method would typically be used to cache cluster cut values
from the NumericalCuts
into instance variables for
convenience and runtime performance purposes. If the cuts
have certain constraints on their reasonable values for the
algorithm, then this method should throw an IllegalArgumentException
if the parameter value is invalid.
The Detector object from LCSim is not available yet when this
method is typically called, so the conditions system should not
be used. Instead, the inherited callback method
ConditionsListener.conditionsChanged(org.lcsim.conditions.ConditionsEvent)
can be used to configure the class depending on the available
conditions when they are available.
NumericalCuts getCuts()
ClusterType getClusterType()
Cluster
created by this algorithm.int getClusterTypeEncoding()
Cluster
type.
This is a convenience method, and it is declared as final in the abstract implementation.org.lcsim.event.base.BaseCluster createBasicCluster()
Cluster
with the correct type for this algorithm.Copyright © 2019. All rights reserved.