ClusterDiagnosticDriver (HPS Java 4.3-SNAPSHOT API)

java.lang.Object
- org.lcsim.util.Driver
- - org.hps.analysis.trigger.ClusterDiagnosticDriver

```
public final class ClusterDiagnosticDriver
extends org.lcsim.util.Driver
```
ClusterDiagnosticDriver performs diagnostic checks on run data to verify that clustering is being performed as expected and that there are no errors occurring. It takes GTP clusters created by the software simulation (simulated clusters) and compares them to GTP clusters reported by the hardware (hardware, or SSP, clusters).

Simulated clusters are compared to hardware clusters to find matches. Clusters are considered to match if they share the same crystal indices and time-stamp. Clusters are then "verified" by comparing their energies and hit counts. The thresholds for verification are programmable.

Statistics are produced for how well clusters matched and verified along with diagnostic plots. Additionally, two levels of verbose output may be enabled to provide detailed event readouts for the entire matching and verification process to aid in diagnosing issues.

Certain DAQ settings for the run are required for the diagnostic process. These are obtained via the ConfigurationManager class automatically. Note that a driver to initialize this class must be present in the event chain in order for the diagnostics to initialize and function.

Author:

Kyle McCarty

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
`private String`	`bankCollectionName` The LCIO collection containing the trigger banks.
`private String`	`clusterCollectionName` The LCIO collection containing GTP clusters.
`private List<Pair<Long,double[]>>`	`efficiencyPlotEntries` Stores entries for the efficiency over time plot.
`private double`	`energyBinSize` Defines the bin size used for energy plots.
`private double`	`energyVerificationThreshold` The maximum energy by which two matched clusters may vary and still be verified.
`private double`	`energyXMax` Defines the upper limit of the energy plot x-axes.
`private int`	`failedCloneBug`
`private static String`	`failedEnergyEnergyDiffPlot` Plots the difference in energy between matched clusters which failed due to energy.
`private static String`	`failedEnergyHitDiffPlot` Plots the difference in hit count between matched clusters which failed due to energy.
`private int`	`failedHitCountDeadtime` Indicates the number of failed cluster events that may have lost a hit due to deadtime issues.
`private static String`	`failedHitCountEnergyDiffPlot` Plots the difference in energy between matched clusters which failed due to hit count.
`private static String`	`failedHitCountHitDiffPlot` Plots the difference in hit count between matched clusters which failed due to hit count.
`private int`	`failedMatchEnergy` Indicates the number simulated/hardware cluster pairs that did not verify because the matched clusters did not in energy within the bounds set by the energy verification threshold.
`private int`	`failedMatchHitCount` Indicates the number simulated/hardware cluster pairs that did not verify because the matched clusters did not in hit count within the bounds set by the hit count verification threshold.
`private int`	`failedMatchPosition` Indicates the number simulated/hardware cluster pairs that did not verify because no two clusters were found with a matching seed position.
`private int`	`failedMatchTime` Indicates the number simulated/hardware cluster pairs that did not verify because no two clusters were found with a matching time-stamp.
`private int`	`failedNearSeedThreshold` Indicates the number of failed cluster events that have a seed hit near the seed energy threshold.
`private int`	`failedNegativeEnergyHit` Indicates the number of failed cluster events where the energies were identical, but hit count differed.
`private int`	`failedPositionDeadtime` Indicates the number of failed cluster events that occur within the dead time window of the event start and also have a t = 0 cluster with a hit on the same channel.
`private boolean`	`firstInstantiation` Indicates whether the DAQ configuration has updated before or not.
`private long`	`firstStartTime` Tracks the start time of the first observed event.
`private int`	`goodSimulatedClusterCount` Indicates the number of hardware clusters processed which were safe from pulse-clipping.
`private int`	`hardwareClusterCount` Indicates the number of hardware clusters processed.
`private String`	`hitCollectionName` The LCIO collection containing FADC hits.
`private int`	`hitVerificationThreshold` The maximum number of hits by which two matched clusters may vary and still be verified.
`private long`	`localEndTime` Tracks the current time of the current event for the purpose of identifying the end of a local sample.
`private int`	`localGoodSimulatedClusterCount` Tracks the number of pulse-clipping-safe simulated clusters in the local window.
`private int`	`localMatchedClusters` Tracks the number of matched clusters in the local window.
`private long`	`localStartTime` Tracks the start time of the current local sample.
`private long`	`localWindowSize` Defines the length of time over which statistics are collected in order to produce an entry into the efficiency over time plot.
`private LocalOutputLogger`	`logger` The event logger.
`private int`	`matchedClusters` Indicates the number simulated/hardware cluster pairs that were successfully verified.
`private static String`	`matchedClusters2DEnergyDiffPlot` Plots the 2D difference in energy between matched clusters.
`private static String`	`matchedClusters2DHitDiffPlot` Plots the 2D difference in hit count between matched clusters.
`private static String`	`matchedClustersEnergyDiffPlot` Plots the difference in energy between matched clusters.
`private static String`	`matchedClustersEnergyEfficiencyPlot` Plots the energy efficiency of matched cluster pairs.
`private static String`	`matchedClustersEnergyPlot` Plots the energy distribution of matched cluster pairs.
`private static String`	`matchedClustersHitDiffPlot` Plots the difference in hit count between matched clusters.
`private static String`	`matchedClustersTimeEfficiencyPlot` Plots the time efficiency of matched cluster pairs.
`private static String`	`matchedClustersTimePlot` Plots the time distribution of matched cluster pairs.
`private static String`	`MODULE_HEADER` Directory structure for all clustering diagnostic plots.
`private int`	`noiseEventThreshold` The number of hits required to label an event a "noise event" when `skipNoiseEvents` is enabled.
`private int`	`nsa` The number of integration samples after a threshold-crossing event used in hit pulse-processing.
`private int`	`nsb` The number of integration samples before a threshold-crossing event used in hit pulse-processing.
`private boolean`	`printOnFail` Whether events where at least one cluster fails to verify should produce a detailed event readout.
`private static String`	`runtimeEfficiencyPlot` Plots the efficiency over the course of the run.
`private int`	`simulatedClusterCount` Indicates the number of simulated clusters processed.
`private boolean`	`skipNoiseEvents` Whether events with more than `noiseEventThreshold` hits should be skipped.
`private static String`	`softwareClustersEnergyPlot` Plots the energy distribution of safe simulated clusters.
`private static String`	`softwareClustersTimePlot` Plots the time distribution of safe simulated clusters.
`private boolean`	`verbose` Whether every event should produce a detailed event printout.
`private int`	`windowWidth` The size of the event window in nanoseconds.

Fields inherited from class org.lcsim.util.Driver
HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors
Constructor and Description

ClusterDiagnosticDriver()

Constructors
Constructor and Description
`ClusterDiagnosticDriver()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`endOfData()` Prints out final run verification statistics and generates efficiency plots.
`private static List<org.lcsim.event.CalorimeterHit>`	`getCalorimeterHits(org.lcsim.event.EventHeader event, String hitCollectionName)` Gets the a of `CalorimeterHit` objects from the argument event from the LCIO collection `hitCollectionName`.
`private static Set<Point>`	`getClusterHitIndices(org.lcsim.event.Cluster cluster)`
`private static Set<Point>`	`getClusterPossibleHitIndices(org.lcsim.event.Cluster cluster)`
`private static List<SSPCluster>`	`getHardwareClusters(org.lcsim.event.EventHeader event, String bankCollectionName)` Gets the a of `SSPCluster` objects from the argument event from the SSP bank contained in the LCIO collection `bankCollectionName`.
`private static double`	`getRatioError(double num, double sigmaNum, double den, double sigmaDen)`
`private static List<org.lcsim.event.Cluster>`	`getSimulatedClusters(org.lcsim.event.EventHeader event, String clusterCollectionName)` Gets the a of `Cluster` objects from the argument event from the LCIO collection `clusterCollectionName`.
`private void`	`instantiatePlots()` Instantiates the diagnostics plots.
`private static boolean`	`isHitMatch(org.lcsim.event.Cluster simCluster, SSPCluster sspCluster, int hitWindow)` Performs the verification check for cluster hit counts.
`private static List<ClusterMatchedPair>`	`matchSimulatedToHardware(Collection<org.lcsim.event.Cluster> simulatedClusters, Collection<SSPCluster> hardwareClusters, double energyWindow, int hitWindow, LocalOutputLogger logger)` Performs cluster matching between a collection of simulated clusters and a collection of hardware clusters using the strictly time-compliant algorithm.
`void`	`process(org.lcsim.event.EventHeader event)` Obtains all necessary collections, performs cluster verification, and outputs event statistics.
`void`	`setBankCollectionName(String collection)` Sets the name of LCIO collection containing the trigger banks.
`void`	`setClusterCollectionName(String collection)` Sets the name of LCIO collection containing simulated GTP clusters.
`void`	`setEnergyAxisBinSize(double binSize)` Sets the size of the bins in energy plots.
`void`	`setEnergyAxisMaximum(double xMax)` Sets the maximum value of the x-axis for energy plots.
`void`	`setEnergyVerificationThreshold(double thresold)` Sets the maximum cluster energy by which a matched cluster pair may vary and still verify.
`void`	`setHitCollectionName(String collection)` Sets the name of LCIO collection containing hits.
`void`	`setHitVerificationThreshold(int thresold)` Sets the maximum number of hits by which a matched cluster pair may vary and still verify.
`void`	`setLocalWindowSize(int size)` Defines the size of the local window for use in the efficiency over time plot.
`void`	`setNoiseThreshold(int threshold)` Sets the total number of hits that must be present in an event in order for it to be considered a noise event.
`void`	`setPrintOnVerificationFailure(boolean state)` When enabled, events where at least one cluster which is not pulse-clipped will print a full event summary.
`void`	`setSkipNoiseEvents(boolean state)` Indicates whether events which exceed a certain number of total hits, defined by `noiseEventThreshold`, should be treated as noise events and skipped.
`void`	`setVerbose(boolean state)` Sets whether the full event verification summary should be printed on every event or not.
`void`	`startOfData()` Connects the driver to the DAQ configuration manager and updates DAQ settings as they become available.
`private static String`	`toString(org.lcsim.event.CalorimeterHit hit)` Converts a `CalorimeterHit` to a basic descriptive string.

Methods inherited from class org.lcsim.util.Driver
add, clearStatistics, contains, detectorChanged, drivers, 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
  - hardwareClusterCount
```
private int hardwareClusterCount
```
    Indicates the number of hardware clusters processed.
  - simulatedClusterCount
```
private int simulatedClusterCount
```
    Indicates the number of simulated clusters processed.
  - goodSimulatedClusterCount
```
private int goodSimulatedClusterCount
```
    Indicates the number of hardware clusters processed which were safe from pulse-clipping.
  - matchedClusters
```
private int matchedClusters
```
    Indicates the number simulated/hardware cluster pairs that were successfully verified.
  - failedMatchTime
```
private int failedMatchTime
```
    Indicates the number simulated/hardware cluster pairs that did not verify because no two clusters were found with a matching time-stamp.
  - failedMatchEnergy
```
private int failedMatchEnergy
```
    Indicates the number simulated/hardware cluster pairs that did not verify because the matched clusters did not in energy within the bounds set by the energy verification threshold.
  - failedMatchHitCount
```
private int failedMatchHitCount
```
    Indicates the number simulated/hardware cluster pairs that did not verify because the matched clusters did not in hit count within the bounds set by the hit count verification threshold.
  - failedMatchPosition
```
private int failedMatchPosition
```
    Indicates the number simulated/hardware cluster pairs that did not verify because no two clusters were found with a matching seed position.
  - failedNearSeedThreshold
```
private int failedNearSeedThreshold
```
    Indicates the number of failed cluster events that have a seed hit near the seed energy threshold.
  - failedPositionDeadtime
```
private int failedPositionDeadtime
```
    Indicates the number of failed cluster events that occur within the dead time window of the event start and also have a t = 0 cluster with a hit on the same channel.
  - failedHitCountDeadtime
```
private int failedHitCountDeadtime
```
    Indicates the number of failed cluster events that may have lost a hit due to deadtime issues.
  - failedNegativeEnergyHit
```
private int failedNegativeEnergyHit
```
    Indicates the number of failed cluster events where the energies were identical, but hit count differed.
  - failedCloneBug
```
private int failedCloneBug
```
  - localMatchedClusters
```
private int localMatchedClusters
```
    Tracks the number of matched clusters in the local window.
  - localWindowSize
```
private long localWindowSize
```
    Defines the length of time over which statistics are collected in order to produce an entry into the efficiency over time plot. Units are in nanoseconds.
  - localEndTime
```
private long localEndTime
```
    Tracks the current time of the current event for the purpose of identifying the end of a local sample.
  - localStartTime
```
private long localStartTime
```
    Tracks the start time of the current local sample.
  - firstStartTime
```
private long firstStartTime
```
    Tracks the start time of the first observed event.
  - localGoodSimulatedClusterCount
```
private int localGoodSimulatedClusterCount
```
    Tracks the number of pulse-clipping-safe simulated clusters in the local window.
  - efficiencyPlotEntries
```
private List<Pair<Long,double[]>> efficiencyPlotEntries
```
    Stores entries for the efficiency over time plot. The first entry in the pair represents the time of the local sample. This is defined with respect to the start of the first observed event. The second entry contains the values for the total and matched cluster counts. The first index corresponds to the total and the second index to the matched cluster counts.
  - noiseEventThreshold
```
private int noiseEventThreshold
```
    The number of hits required to label an event a "noise event" when skipNoiseEvents is enabled.
  - hitVerificationThreshold
```
private int hitVerificationThreshold
```
    The maximum number of hits by which two matched clusters may vary and still be verified.
  - energyVerificationThreshold
```
private double energyVerificationThreshold
```
    The maximum energy by which two matched clusters may vary and still be verified.
  - verbose
```
private boolean verbose
```
    Whether every event should produce a detailed event printout.
  - printOnFail
```
private boolean printOnFail
```
    Whether events where at least one cluster fails to verify should produce a detailed event readout.
  - skipNoiseEvents
```
private boolean skipNoiseEvents
```
    Whether events with more than noiseEventThreshold hits should be skipped.
  - energyXMax
```
private double energyXMax
```
    Defines the upper limit of the energy plot x-axes. Units of GeV.
  - energyBinSize
```
private double energyBinSize
```
    Defines the bin size used for energy plots. Units of GeV.
  - hitCollectionName
```
private String hitCollectionName
```
    The LCIO collection containing FADC hits.
  - bankCollectionName
```
private String bankCollectionName
```
    The LCIO collection containing the trigger banks.
  - clusterCollectionName
```
private String clusterCollectionName
```
    The LCIO collection containing GTP clusters.
  - nsa
```
private int nsa
```
    The number of integration samples after a threshold-crossing event used in hit pulse-processing. Used to determining if a hit is at risk of pulse-clipping.
  - nsb
```
private int nsb
```
    The number of integration samples before a threshold-crossing event used in hit pulse-processing. Used to determining if a hit is at risk of pulse-clipping.
  - windowWidth
```
private int windowWidth
```
    The size of the event window in nanoseconds. Used for time plot ranges and for determining the risk of pulse-clipping.
  - firstInstantiation
```
private boolean firstInstantiation
```
    Indicates whether the DAQ configuration has updated before or not. Used to prevent plots from being instantiated more than once.
  - logger
```
private LocalOutputLogger logger
```
    The event logger. Is used to store detailed event readouts, and if appropriate, print them to the terminal.
  - MODULE_HEADER
```
private static final String MODULE_HEADER
```
    Directory structure for all clustering diagnostic plots.
    
    See Also:
    
    Constant Field Values
  - softwareClustersTimePlot
```
private static final String softwareClustersTimePlot
```
    Plots the time distribution of safe simulated clusters.
    
    See Also:
    
    Constant Field Values
  - softwareClustersEnergyPlot
```
private static final String softwareClustersEnergyPlot
```
    Plots the energy distribution of safe simulated clusters.
    
    See Also:
    
    Constant Field Values
  - matchedClustersTimePlot
```
private static final String matchedClustersTimePlot
```
    Plots the time distribution of matched cluster pairs.
    
    See Also:
    
    Constant Field Values
  - matchedClustersEnergyPlot
```
private static final String matchedClustersEnergyPlot
```
    Plots the energy distribution of matched cluster pairs.
    
    See Also:
    
    Constant Field Values
  - matchedClustersTimeEfficiencyPlot
```
private static final String matchedClustersTimeEfficiencyPlot
```
    Plots the time efficiency of matched cluster pairs. Defined as matchedClustersTimePlot / softwareClustersTimePlot.
    
    See Also:
    
    Constant Field Values
  - matchedClustersEnergyEfficiencyPlot
```
private static final String matchedClustersEnergyEfficiencyPlot
```
    Plots the energy efficiency of matched cluster pairs. Defined as softwareClustersEnergyPlot / matchedClustersEnergyPlot.
    
    See Also:
    
    Constant Field Values
  - matchedClustersEnergyDiffPlot
```
private static final String matchedClustersEnergyDiffPlot
```
    Plots the difference in energy between matched clusters.
    
    See Also:
    
    Constant Field Values
  - matchedClustersHitDiffPlot
```
private static final String matchedClustersHitDiffPlot
```
    Plots the difference in hit count between matched clusters.
    
    See Also:
    
    Constant Field Values
  - failedEnergyEnergyDiffPlot
```
private static final String failedEnergyEnergyDiffPlot
```
    Plots the difference in energy between matched clusters which failed due to energy.
    
    See Also:
    
    Constant Field Values
  - failedHitCountEnergyDiffPlot
```
private static final String failedHitCountEnergyDiffPlot
```
    Plots the difference in energy between matched clusters which failed due to hit count.
    
    See Also:
    
    Constant Field Values
  - failedEnergyHitDiffPlot
```
private static final String failedEnergyHitDiffPlot
```
    Plots the difference in hit count between matched clusters which failed due to energy.
    
    See Also:
    
    Constant Field Values
  - failedHitCountHitDiffPlot
```
private static final String failedHitCountHitDiffPlot
```
    Plots the difference in hit count between matched clusters which failed due to hit count.
    
    See Also:
    
    Constant Field Values
  - matchedClusters2DEnergyDiffPlot
```
private static final String matchedClusters2DEnergyDiffPlot
```
    Plots the 2D difference in energy between matched clusters.
    
    See Also:
    
    Constant Field Values
  - matchedClusters2DHitDiffPlot
```
private static final String matchedClusters2DHitDiffPlot
```
    Plots the 2D difference in hit count between matched clusters.
    
    See Also:
    
    Constant Field Values
  - runtimeEfficiencyPlot
```
private static final String runtimeEfficiencyPlot
```
    Plots the efficiency over the course of the run.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClusterDiagnosticDriver
```
public ClusterDiagnosticDriver()
```
- Method Detail
  - getClusterHitIndices
```
private static final Set<Point> getClusterHitIndices(org.lcsim.event.Cluster cluster)
```
  - getClusterPossibleHitIndices
```
private static final Set<Point> getClusterPossibleHitIndices(org.lcsim.event.Cluster cluster)
```
  - getRatioError
```
private static final double getRatioError(double num,
                                          double sigmaNum,
                                          double den,
                                          double sigmaDen)
```
  - endOfData
```
public void endOfData()
```
    Prints out final run verification statistics and generates efficiency plots.
    
    Overrides:
    
    endOfData in class org.lcsim.util.Driver
  - process
```
public void process(org.lcsim.event.EventHeader event)
```
    Obtains all necessary collections, performs cluster verification, and outputs event statistics. Also handles logging.
    
    Overrides:
    
    process in class org.lcsim.util.Driver
  - startOfData
```
public void startOfData()
```
    Connects the driver to the DAQ configuration manager and updates DAQ settings as they become available.
    
    Overrides:
    
    startOfData in class org.lcsim.util.Driver
  - instantiatePlots
```
private void instantiatePlots()
```
    Instantiates the diagnostics plots. method is run once upon DAQ configuration initialization.
  - getCalorimeterHits
```
private static final List<org.lcsim.event.CalorimeterHit> getCalorimeterHits(org.lcsim.event.EventHeader event,
                                                                             String hitCollectionName)
```
    Gets the a of CalorimeterHit objects from the argument event from the LCIO collection hitCollectionName.
    
    Parameters:
    
    event - - The event object.
    
    hitCollectionName - - The name of the hit collection.
    
    Returns:
    
    Returns either a list of CalorimeterHit objects, or returns null if no collection was found.
  - getHardwareClusters
```
private static final List<SSPCluster> getHardwareClusters(org.lcsim.event.EventHeader event,
                                                          String bankCollectionName)
```
    Gets the a of SSPCluster objects from the argument event from the SSP bank contained in the LCIO collection bankCollectionName.
    
    Parameters:
    
    event - - The event object.
    
    bankCollectionName - - The name of the bank collection containing the SSP bank, which contains the cluster list.
    
    Returns:
    
    Returns either a list of SSPCluster objects, or returns null if no bank collection or no SSP bank was found.
  - getSimulatedClusters
```
private static final List<org.lcsim.event.Cluster> getSimulatedClusters(org.lcsim.event.EventHeader event,
                                                                        String clusterCollectionName)
```
    Gets the a of Cluster objects from the argument event from the LCIO collection clusterCollectionName.
    
    Parameters:
    
    event - - The event object.
    
    clusterCollectionName - - The name of the cluster collection.
    
    Returns:
    
    Returns either a list of Cluster objects, or returns null if no collection was found.
  - isHitMatch
```
private static final boolean isHitMatch(org.lcsim.event.Cluster simCluster,
                                        SSPCluster sspCluster,
                                        int hitWindow)
```
    Performs the verification check for cluster hit counts.
    
    Parameters:
    
    simCluster - - The simulated cluster to check.
    
    sspCluster - - The hardware cluster to check.
    
    hitWindow - - The range by which hit counts are allowed to differ between the clusters.
    
    Returns:
    
    Returns true if the hit counts match to within threshold and false otherwise.
  - matchSimulatedToHardware
```
private static final List<ClusterMatchedPair> matchSimulatedToHardware(Collection<org.lcsim.event.Cluster> simulatedClusters,
                                                                       Collection<SSPCluster> hardwareClusters,
                                                                       double energyWindow,
                                                                       int hitWindow,
                                                                       LocalOutputLogger logger)
```
    Performs cluster matching between a collection of simulated clusters and a collection of hardware clusters using the strictly time-compliant algorithm. Simulated clusters are matched with a hardware cluster by comparing the x- and y-indices of the two clusters, as well as their time-stamps. If all of these values match, the clusters are considered to be the same. The cluster then undergoes verification by requiring that both the cluster energies and hit counts are within a certain programmable range of one another. Matched clusters are then stored along with a flag that indicates whether they were properly verified or not. Simulated clusters that do not match any hardware cluster in both position and time are treated as failing to have verified.
    
    Parameters:
    
    simulatedClusters - - A collection of GTP clusters generated by the software simulation.
    
    hardwareClusters - - A collection of GTP clusters reported in the SSP bank by the hardware.
    
    energyWindow - - The window of allowed deviation between the simulated cluster and hardware cluster energies. Units are in GeV.
    
    hitWindow - - The window of allowed deviation between the simulated cluster and hardware cluster hit counts.
    
    logger - - The logger object to which diagnostic text should be written.
    
    Returns:
    
    Returns a List containing all the matched simulated/hardware cluster pairs as well as their verification statuses.
  - toString
```
private static final String toString(org.lcsim.event.CalorimeterHit hit)
```
    Converts a CalorimeterHit to a basic descriptive string.
    
    Parameters:
    
    hit - - The hit to be converted.
    
    Returns:
    
    Returns the hit object as a String.
  - setBankCollectionName
```
public void setBankCollectionName(String collection)
```
    Sets the name of LCIO collection containing the trigger banks.
    
    Parameters:
    
    collection - - The collection name.
  - setClusterCollectionName
```
public void setClusterCollectionName(String collection)
```
    Sets the name of LCIO collection containing simulated GTP clusters.
    
    Parameters:
    
    collection - - The collection name.
  - setEnergyAxisBinSize
```
public void setEnergyAxisBinSize(double binSize)
```
    Sets the size of the bins in energy plots.
    
    Parameters:
    
    binSize - - The bin width in units of GeV.
  - setEnergyAxisMaximum
```
public void setEnergyAxisMaximum(double xMax)
```
    Sets the maximum value of the x-axis for energy plots.
    
    Parameters:
    
    xMax - - The x-axis maximum, in units of GeV.
  - setEnergyVerificationThreshold
```
public void setEnergyVerificationThreshold(double thresold)
```
    Sets the maximum cluster energy by which a matched cluster pair may vary and still verify.
    
    Parameters:
    
    thresold - - The maximum difference in energy. Value is inclusive and in units of GeV.
  - setHitCollectionName
```
public void setHitCollectionName(String collection)
```
    Sets the name of LCIO collection containing hits.
    
    Parameters:
    
    collection - - The collection name.
  - setHitVerificationThreshold
```
public void setHitVerificationThreshold(int thresold)
```
    Sets the maximum number of hits by which a matched cluster pair may vary and still verify.
    
    Parameters:
    
    thresold - - The maximum difference in hits. Value is inclusive.
  - setLocalWindowSize
```
public void setLocalWindowSize(int size)
```
    Defines the size of the local window for use in the efficiency over time plot. Units are in seconds.
    
    Parameters:
    
    size - - The duration of local efficiency measurements.
  - setNoiseThreshold
```
public void setNoiseThreshold(int threshold)
```
    Sets the total number of hits that must be present in an event in order for it to be considered a noise event. This is only applied if skipNoiseEvents is set to true.
    
    Parameters:
    
    threshold - - The noise hit threshold.
  - setPrintOnVerificationFailure
```
public void setPrintOnVerificationFailure(boolean state)
```
    When enabled, events where at least one cluster which is not pulse-clipped will print a full event summary.
    
    Parameters:
    
    state - - true prints the event summary and false does not.
  - setSkipNoiseEvents
```
public void setSkipNoiseEvents(boolean state)
```
    Indicates whether events which exceed a certain number of total hits, defined by noiseEventThreshold, should be treated as noise events and skipped.
    
    Parameters:
    
    state - - true causes noise events to be skipped and false does not.
  - setVerbose
```
public void setVerbose(boolean state)
```
    Sets whether the full event verification summary should be printed on every event or not.
    
    Parameters:
    
    state - - true prints the event summary and false does not.

Class ClusterDiagnosticDriver

Nested Class Summary

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

Field Summary

Fields inherited from class org.lcsim.util.Driver

Constructor Summary

Method Summary

Methods inherited from class org.lcsim.util.Driver

Methods inherited from class java.lang.Object

Field Detail

hardwareClusterCount

simulatedClusterCount

goodSimulatedClusterCount

matchedClusters

failedMatchTime

failedMatchEnergy

failedMatchHitCount

failedMatchPosition

failedNearSeedThreshold

failedPositionDeadtime

failedHitCountDeadtime

failedNegativeEnergyHit

failedCloneBug

localMatchedClusters

localWindowSize

localEndTime

localStartTime

firstStartTime

localGoodSimulatedClusterCount

efficiencyPlotEntries

noiseEventThreshold

hitVerificationThreshold

energyVerificationThreshold

verbose

printOnFail

skipNoiseEvents

energyXMax

energyBinSize

hitCollectionName

bankCollectionName

clusterCollectionName

nsa

nsb

windowWidth

firstInstantiation

logger

MODULE_HEADER

softwareClustersTimePlot

softwareClustersEnergyPlot

matchedClustersTimePlot

matchedClustersEnergyPlot

matchedClustersTimeEfficiencyPlot

matchedClustersEnergyEfficiencyPlot

matchedClustersEnergyDiffPlot

matchedClustersHitDiffPlot

failedEnergyEnergyDiffPlot

failedHitCountEnergyDiffPlot

failedEnergyHitDiffPlot

failedHitCountHitDiffPlot

matchedClusters2DEnergyDiffPlot

matchedClusters2DHitDiffPlot

runtimeEfficiencyPlot

Constructor Detail

ClusterDiagnosticDriver

Method Detail

getClusterHitIndices

getClusterPossibleHitIndices

getRatioError

endOfData

process

startOfData

instantiatePlots

getCalorimeterHits

getHardwareClusters

getSimulatedClusters

isHitMatch

matchSimulatedToHardware

toString

setBankCollectionName

setClusterCollectionName