public class GTPClusterDriver extends ClusterDriver
GTPClusterDriver
is an implementation of the
ClusterDriver
class that defines employs the readout
variant of the GTP hardware clustering algorithm. Specifics on the
behavior of this algorithm can be found in its documentation.GTPClusterDriver
allows for all of the variable settings
used by the GTP algorithm to be defined. It also can be set to
"verbose" mode, where it will output detailed information on each
event and the cluster forming process. This is disabled by default,
but can be enabled for debugging purposes.GTPClusterDriver
is designed to read from Monte Carlo
data organized into 2-ns beam bunches. It can not be used for hardware
readout data, or Monte Carlo formatted in this style. For this data,
the GTPOnlineClusterer
should be employed instead.GTPClusterer
Modifier and Type | Field and Description |
---|---|
private GTPClusterer |
gtp
An instance of the clustering algorithm object for producing
cluster objects.
|
clusterer, createEmptyClusterCollection, cuts, ecal, ecalName, inputHitCollectionName, neighborMap, outputClusterCollectionName, raiseErrorNoHitCollection, skipNoClusterEvents, sortHits, storeHits, validateClusters, writeClusterCollection
Constructor and Description |
---|
GTPClusterDriver()
Instantiates a new
GTPClusterer , which will produce
clusters using the GTP algorithm in the 2-ns beam bunch scheme. |
Modifier and Type | Method and Description |
---|---|
void |
setAsymmetricWindow(boolean asymmetricWindow)
Sets whether the behavior of the hit inclusion window with respect
to the hit verification window.
|
void |
setClusterWindow(int clusterWindow)
Sets the size of the hit verification temporal window.
|
void |
setLimitClusterRange(boolean limitClusterRange)
Deprecated.
|
void |
setSeedEnergyThreshold(double seedEnergyThreshold)
Sets the minimum seed energy needed for a hit to be considered
for forming a cluster.
|
void |
setVerbose(boolean verbose)
Sets whether the clustering algorithm should output diagnostic
text or not.
|
void |
setWriteClusterCollection(boolean state)
Defines whether the output of this clusterer should be persisted
to LCIO or not.
|
detectorChanged, getClusterer, printHitIDs, process, setClusterer, setClustererName, setCreateEmptyClusterCollection, setCuts, setEcalName, setInputHitCollectionName, setOutputClusterCollectionName, setRaiseErrorNoHitCollection, setSkipNoClusterEvents, setSortHits, setStoreHits, setValidateClusters, startOfData, validateClusters
private final GTPClusterer gtp
public GTPClusterDriver()
GTPClusterer
, which will produce
clusters using the GTP algorithm in the 2-ns beam bunch scheme.
It will, by default, use a 50 MeV seed energy cut with +/- 2 a
clock-cycle verification and inclusion window.@Deprecated public void setLimitClusterRange(boolean limitClusterRange)
false
,
both windows will be identical in size. Otherwise, the inclusion
window will be equal in size after the seed hit, but encompass
only one clock-cycle before the seed hit. This should be replaced
by the method setAsymmetricWindow
.limitClusterRange
- - true
indicates that the
asymmetric window should be used and false
that it
should not.public void setClusterWindow(int clusterWindow)
(2 * clusterWindow) + 1
clock-cycles in length. (i.e., it will be a length of
clusterWindow
before the seed hit, a length of
clusterWindow
after the seed hit, plus the cycle
that includes the seed hit.) Time length is in clock-cycles.clusterWindow
- - The number of clock-cycles around the
hit in one direction.public void setSeedEnergyThreshold(double seedEnergyThreshold)
seedEnergyThreshold
- - The minimum cluster seed energy in
GeV.public void setAsymmetricWindow(boolean asymmetricWindow)
false
,
both windows will be identical in size. Otherwise, the inclusion
window will be equal in size after the seed hit, but encompass
only one clock-cycle before the seed hit.asymmetricWindow
- - true
indicates that the
asymmetric window should be used and false
that it
should not.public void setVerbose(boolean verbose)
verbose
- - true
indicates that the driver should
output diagnostic text and false
that it should not.public void setWriteClusterCollection(boolean state)
setWriteClusterCollection
in class ClusterDriver
state
- - true
indicates that clusters will
be persisted, and false
that they will not.Copyright © 2019. All rights reserved.