ReconParticleDriver (HPS Java 4.3-SNAPSHOT API)

java.lang.Object
- org.lcsim.util.Driver
- - org.hps.recon.particle.ReconParticleDriver

Direct Known Subclasses:

HpsReconParticleDriver, TestRunReconParticleDriver
```
public abstract class ReconParticleDriver
extends org.lcsim.util.Driver
```
Driver used to create reconstructed particles and matching clusters and tracks.

Author:

Omar Moreno, Mathew Graham

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
`protected List<org.lcsim.event.ReconstructedParticle>`	`beamConV0Candidates` Stores reconstructed V0 candidate particles generated with beam spot constraints.
`protected String`	`beamConV0CandidatesColName` LCIO collection name for V0 candidate particles generated with beam spot constraints.
`protected List<org.lcsim.event.Vertex>`	`beamConV0Vertices` Stores reconstructed V0 candidate vertices generated with beam spot constraints.
`protected String`	`beamConV0VerticesColName` LCIO collection name for V0 candidate vertices generated with beam spot constraints.
`protected double`	`beamEnergy`
`protected double[]`	`beamPosition`
`protected double[]`	`beamSize`
`protected double`	`bField`
`protected StandardCuts`	`cuts`
`protected boolean`	`debug` Indicates whether debug text should be output or not.
`private boolean`	`disablePID`
`(package private) HPSEcal3`	`ecal`
`private String`	`ecalClustersCollectionName` LCIO collection name for calorimeter clusters.
`static int`	`ELECTRON`
`private List<org.lcsim.event.ReconstructedParticle>`	`electrons` Stores reconstructed electron particles.
`protected boolean`	`enableTrackClusterMatchPlots`
`protected List<org.lcsim.event.ReconstructedParticle>`	`finalStateParticles` Stores particles reconstructed from an event.
`private String`	`finalStateParticlesColName` LCIO collection name for reconstructed particles.
`private int`	`flipSign`
`(package private) org.lcsim.event.RelationalTable`	`hitToRotated`
`(package private) org.lcsim.event.RelationalTable`	`hitToStrips`
`protected boolean`	`isMC`
`boolean`	`isMonteCarlo` Indicates whether this is Monte Carlo or data
`(package private) TrackClusterMatcher`	`matcher` Utility used to determine if a track and cluster are matched
`private double`	`MAXNSIGMAPOSITIONMATCH`
`static int`	`MOLLER_BOT`
`static int`	`MOLLER_TOP`
`private String`	`OtherElectronsColName`
`static int`	`POSITRON`
`private List<org.lcsim.event.ReconstructedParticle>`	`positrons` Stores reconstructed positron particles.
`private String`	`simpleName` The simple name of the class used for debug print statements.
`protected List<org.lcsim.event.ReconstructedParticle>`	`targetConV0Candidates` Stores reconstructed V0 candidate particles generated with target constraints.
`protected String`	`targetConV0CandidatesColName` LCIO collection name for V0 candidate particles generated with target constraints.
`protected List<org.lcsim.event.Vertex>`	`targetConV0Vertices` Stores reconstructed V0 candidate vertices generated with target constraints.
`protected String`	`targetConV0VerticesColName` LCIO collection name for V0 candidate vertices generated with target constraints.
`private String`	`trackCollectionName` LCIO collection name for tracks.
`(package private) String[]`	`trackCollectionNames`
`protected List<org.lcsim.event.ReconstructedParticle>`	`unconstrainedV0Candidates` Stores reconstructed V0 candidate particles generated without constraints.
`protected String`	`unconstrainedV0CandidatesColName` LCIO collection name for V0 candidate particles generated without constraints.
`protected List<org.lcsim.event.Vertex>`	`unconstrainedV0Vertices` Stores reconstructed V0 candidate vertices generated without constraints.
`protected String`	`unconstrainedV0VerticesColName` LCIO collection name for V0 candidate vertices generated without constraints.
`(package private) boolean`	`useCorrectedClusterPositionsForMatching`

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

Constructor Summary

Constructors
Constructor and Description

ReconParticleDriver()

Constructors
Constructor and Description
`ReconParticleDriver()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`detectorChanged(org.lcsim.geometry.Detector detector)` Updates the magnetic field parameters to match the appropriate values for the current detector settings.
`protected void`	`endOfData()`
`protected abstract void`	`findVertices(List<org.lcsim.event.ReconstructedParticle> electrons, List<org.lcsim.event.ReconstructedParticle> positrons)` Generates reconstructed V0 candidate particles and vertices from sets of positrons and electrons.
`protected List<org.lcsim.event.ReconstructedParticle>`	`makeReconstructedParticles(List<org.lcsim.event.Cluster> clusters, List<List<org.lcsim.event.Track>> trackCollections)` Create the set of final state particles from the event tracks and clusters.
`protected abstract List<org.lcsim.event.ReconstructedParticle>`	`particleCuts(List<org.lcsim.event.ReconstructedParticle> finalStateParticles)`
`protected void`	`printDebug(String debugMessage)` Prints a message as per `System.out.println` to the output stream if the verbose debug output option is enabled.
`protected void`	`process(org.lcsim.event.EventHeader event)` Processes the track and cluster collections in the event into reconstructed particles and V0 candidate particles and vertices.
`void`	`setBeamConV0CandidatesColName(String beamConV0CandidatesColName)` Sets the name of the LCIO collection for beam spot constrained V0 candidate particles.
`void`	`setBeamConV0VerticesColName(String beamConV0VerticesColName)` Sets the name of the LCIO collection for beam spot constrained V0 candidate vertices.
`void`	`setBeamPositionX(double X)` Sets the beam position in the x-direction.
`void`	`setBeamPositionY(double Y)` Sets the beam position in the y-direction in mm.
`void`	`setBeamPositionZ(double Z)` Sets the beam position in the z-direction in mm.
`void`	`setBeamSigmaX(double sigmaX)` Sets the beam size sigma in the x-direction.
`void`	`setBeamSigmaY(double sigmaY)` Sets the beam size sigma in the y-direction.
`void`	`setDebug(boolean debug)` Indicates whether verbose debug text should be written out during runtime or note.
`void`	`setDisablePID(boolean disablePID)` Disable setting the PID of an Ecal cluster.
`void`	`setEcalClusterCollectionName(String ecalClustersCollectionName)` Sets the LCIO collection name for calorimeter cluster data.
`void`	`setFinalStateParticlesColName(String finalStateParticlesColName)` Sets the name of the LCIO collection for reconstructed particles.
`void`	`setIsMC(boolean state)` Sets the condition of whether the data is Monte Carlo or not.
`void`	`setMaxElectronP(double input)`
`void`	`setMaxMatchChisq(double input)`
`void`	`setMaxMatchDt(double input)`
`void`	`setNSigmaPositionMatch(double nsigma)` Set the requirement on cluster-track position matching in terms of N-sigma.
`void`	`setOtherElectronsColName(String input)`
`void`	`setSnapToEdge(boolean val)`
`void`	`setTargetConV0CandidatesColName(String targetConV0CandidatesColName)` Sets the name of the LCIO collection for target constrained V0 candidate particles.
`void`	`setTargetConV0VerticesColName(String targetConV0VerticesColName)` Sets the name of the LCIO collection for target constrained V0 candidate vertices.
`void`	`setTrackClusterMatchPlots(boolean input)`
`void`	`setTrackClusterTimeOffset(double input)`
`void`	`setTrackCollectionName(String trackCollectionName)` Sets the LCIO collection name for particle track data.
`void`	`setTrackCollectionNames(String[] trackCollectionNames)` Set the names of the LCIO track collections used as input.
`void`	`setUnconstrainedV0CandidatesColName(String unconstrainedV0CandidatesColName)` Sets the name of the LCIO collection for unconstrained V0 candidate particles.
`void`	`setUnconstrainedV0VerticesColName(String unconstrainedV0VerticesColName)` Sets the name of the LCIO collection for unconstrained V0 candidate vertices.
`void`	`setUseCorrectedClusterPositionsForMatching(boolean val)`
`protected void`	`startOfData()` Sets the LCIO collection names to their default values if they are not already defined.

Methods inherited from class org.lcsim.util.Driver
add, clearStatistics, contains, 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
  - matcher
```
TrackClusterMatcher matcher
```
    Utility used to determine if a track and cluster are matched
  - trackCollectionNames
```
String[] trackCollectionNames
```
  - ELECTRON
```
public static final int ELECTRON
```
    See Also:
    
    Constant Field Values
  - POSITRON
```
public static final int POSITRON
```
    See Also:
    
    Constant Field Values
  - MOLLER_TOP
```
public static final int MOLLER_TOP
```
    See Also:
    
    Constant Field Values
  - MOLLER_BOT
```
public static final int MOLLER_BOT
```
    See Also:
    
    Constant Field Values
  - MAXNSIGMAPOSITIONMATCH
```
private double MAXNSIGMAPOSITIONMATCH
```
  - ecal
```
HPSEcal3 ecal
```
  - isMC
```
protected boolean isMC
```
  - disablePID
```
private boolean disablePID
```
  - cuts
```
protected StandardCuts cuts
```
  - hitToRotated
```
org.lcsim.event.RelationalTable hitToRotated
```
  - hitToStrips
```
org.lcsim.event.RelationalTable hitToStrips
```
  - enableTrackClusterMatchPlots
```
protected boolean enableTrackClusterMatchPlots
```
  - useCorrectedClusterPositionsForMatching
```
boolean useCorrectedClusterPositionsForMatching
```
  - debug
```
protected boolean debug
```
    Indicates whether debug text should be output or not.
  - isMonteCarlo
```
public boolean isMonteCarlo
```
    Indicates whether this is Monte Carlo or data
  - simpleName
```
private final String simpleName
```
    The simple name of the class used for debug print statements.
  - electrons
```
private List<org.lcsim.event.ReconstructedParticle> electrons
```
    Stores reconstructed electron particles.
  - positrons
```
private List<org.lcsim.event.ReconstructedParticle> positrons
```
    Stores reconstructed positron particles.
  - finalStateParticles
```
protected List<org.lcsim.event.ReconstructedParticle> finalStateParticles
```
    Stores particles reconstructed from an event.
  - unconstrainedV0Candidates
```
protected List<org.lcsim.event.ReconstructedParticle> unconstrainedV0Candidates
```
    Stores reconstructed V0 candidate particles generated without constraints.
  - beamConV0Candidates
```
protected List<org.lcsim.event.ReconstructedParticle> beamConV0Candidates
```
    Stores reconstructed V0 candidate particles generated with beam spot constraints.
  - targetConV0Candidates
```
protected List<org.lcsim.event.ReconstructedParticle> targetConV0Candidates
```
    Stores reconstructed V0 candidate particles generated with target constraints.
  - unconstrainedV0Vertices
```
protected List<org.lcsim.event.Vertex> unconstrainedV0Vertices
```
    Stores reconstructed V0 candidate vertices generated without constraints.
  - beamConV0Vertices
```
protected List<org.lcsim.event.Vertex> beamConV0Vertices
```
    Stores reconstructed V0 candidate vertices generated with beam spot constraints.
  - targetConV0Vertices
```
protected List<org.lcsim.event.Vertex> targetConV0Vertices
```
    Stores reconstructed V0 candidate vertices generated with target constraints.
  - ecalClustersCollectionName
```
private String ecalClustersCollectionName
```
    LCIO collection name for calorimeter clusters.
  - trackCollectionName
```
private String trackCollectionName
```
    LCIO collection name for tracks.
  - finalStateParticlesColName
```
private String finalStateParticlesColName
```
    LCIO collection name for reconstructed particles.
  - OtherElectronsColName
```
private String OtherElectronsColName
```
  - unconstrainedV0CandidatesColName
```
protected String unconstrainedV0CandidatesColName
```
    LCIO collection name for V0 candidate particles generated without constraints.
  - beamConV0CandidatesColName
```
protected String beamConV0CandidatesColName
```
    LCIO collection name for V0 candidate particles generated with beam spot constraints.
  - targetConV0CandidatesColName
```
protected String targetConV0CandidatesColName
```
    LCIO collection name for V0 candidate particles generated with target constraints.
  - unconstrainedV0VerticesColName
```
protected String unconstrainedV0VerticesColName
```
    LCIO collection name for V0 candidate vertices generated without constraints.
  - beamConV0VerticesColName
```
protected String beamConV0VerticesColName
```
    LCIO collection name for V0 candidate vertices generated with beam spot constraints.
  - targetConV0VerticesColName
```
protected String targetConV0VerticesColName
```
    LCIO collection name for V0 candidate vertices generated with target constraints.
  - beamSize
```
protected double[] beamSize
```
  - beamPosition
```
protected double[] beamPosition
```
  - bField
```
protected double bField
```
  - beamEnergy
```
protected double beamEnergy
```
  - flipSign
```
private int flipSign
```
- Constructor Detail
  - ReconParticleDriver
```
public ReconParticleDriver()
```
- Method Detail
  - setTrackClusterMatchPlots
```
public void setTrackClusterMatchPlots(boolean input)
```
  - setUseCorrectedClusterPositionsForMatching
```
public void setUseCorrectedClusterPositionsForMatching(boolean val)
```
  - setIsMC
```
public void setIsMC(boolean state)
```
    Sets the condition of whether the data is Monte Carlo or not. This is used to smear the cluster energy corrections so that the energy resolution is consistent with data. False by default.
    
    Parameters:
    
    isMC -
  - setBeamConV0CandidatesColName
```
public void setBeamConV0CandidatesColName(String beamConV0CandidatesColName)
```
    Sets the name of the LCIO collection for beam spot constrained V0 candidate particles.
    
    Parameters:
    
    beamConV0CandidatesColName - - The LCIO collection name.
  - setBeamConV0VerticesColName
```
public void setBeamConV0VerticesColName(String beamConV0VerticesColName)
```
    Sets the name of the LCIO collection for beam spot constrained V0 candidate vertices.
    
    Parameters:
    
    beamConV0VerticesColName - - The LCIO collection name.
  - setBeamPositionX
```
public void setBeamPositionX(double X)
```
    Sets the beam position in the x-direction.
    
    Parameters:
    
    X - - The beam position at the target in the x-direction in mm.
  - setBeamSigmaX
```
public void setBeamSigmaX(double sigmaX)
```
    Sets the beam size sigma in the x-direction.
    
    Parameters:
    
    sigmaX - - The standard deviation of the beam width in the x-direction.
  - setBeamPositionY
```
public void setBeamPositionY(double Y)
```
    Sets the beam position in the y-direction in mm.
    
    Parameters:
    
    Y - - The position of the beam in the y-direction in mm.
  - setBeamSigmaY
```
public void setBeamSigmaY(double sigmaY)
```
    Sets the beam size sigma in the y-direction.
    
    Parameters:
    
    sigmaY - - The standard deviation of the beam width in the y-direction.
  - setBeamPositionZ
```
public void setBeamPositionZ(double Z)
```
    Sets the beam position in the z-direction in mm.
    
    Parameters:
    
    Z - - The position of the beam in the y-direction in mm.
  - setDebug
```
public void setDebug(boolean debug)
```
    Indicates whether verbose debug text should be written out during runtime or note. Defaults to false .
    
    Parameters:
    
    debug - - true indicates that debug text should be written and false that it should be suppressed.
  - setEcalClusterCollectionName
```
public void setEcalClusterCollectionName(String ecalClustersCollectionName)
```
    Sets the LCIO collection name for calorimeter cluster data.
    
    Parameters:
    
    ecalClustersCollectionName - - The LCIO collection name.
  - setFinalStateParticlesColName
```
public void setFinalStateParticlesColName(String finalStateParticlesColName)
```
    Sets the name of the LCIO collection for reconstructed particles.
    
    Parameters:
    
    finalStateParticlesColName - - The LCIO collection name.
  - setTargetConV0CandidatesColName
```
public void setTargetConV0CandidatesColName(String targetConV0CandidatesColName)
```
    Sets the name of the LCIO collection for target constrained V0 candidate particles.
    
    Parameters:
    
    targetConV0CandidatesColName - - The LCIO collection name.
  - setOtherElectronsColName
```
public void setOtherElectronsColName(String input)
```
  - setTargetConV0VerticesColName
```
public void setTargetConV0VerticesColName(String targetConV0VerticesColName)
```
    Sets the name of the LCIO collection for target constrained V0 candidate vertices.
    
    Parameters:
    
    targetConV0VerticesColName - - The LCIO collection name.
  - setTrackCollectionName
```
public void setTrackCollectionName(String trackCollectionName)
```
    Sets the LCIO collection name for particle track data.
    
    Parameters:
    
    trackCollectionName - - The LCIO collection name.
  - setUnconstrainedV0CandidatesColName
```
public void setUnconstrainedV0CandidatesColName(String unconstrainedV0CandidatesColName)
```
    Sets the name of the LCIO collection for unconstrained V0 candidate particles.
    
    Parameters:
    
    unconstrainedV0CandidatesColName - - The LCIO collection name.
  - setUnconstrainedV0VerticesColName
```
public void setUnconstrainedV0VerticesColName(String unconstrainedV0VerticesColName)
```
    Sets the name of the LCIO collection for unconstrained V0 candidate vertices.
    
    Parameters:
    
    unconstrainedV0VerticesColName - - The LCIO collection name.
  - setTrackCollectionNames
```
public void setTrackCollectionNames(String[] trackCollectionNames)
```
    Set the names of the LCIO track collections used as input.
    
    Parameters:
    
    trackCollectionNames - Array of collection names. If not set, use all Track collections in the event.
  - setNSigmaPositionMatch
```
public void setNSigmaPositionMatch(double nsigma)
```
    Set the requirement on cluster-track position matching in terms of N-sigma.
    
    Parameters:
    
    nsigma -
  - setDisablePID
```
public void setDisablePID(boolean disablePID)
```
    Disable setting the PID of an Ecal cluster.
  - detectorChanged
```
protected void detectorChanged(org.lcsim.geometry.Detector detector)
```
    Updates the magnetic field parameters to match the appropriate values for the current detector settings.
    
    Overrides:
    
    detectorChanged in class org.lcsim.util.Driver
  - setMaxMatchChisq
```
public void setMaxMatchChisq(double input)
```
  - setMaxElectronP
```
public void setMaxElectronP(double input)
```
  - setMaxMatchDt
```
public void setMaxMatchDt(double input)
```
  - setTrackClusterTimeOffset
```
public void setTrackClusterTimeOffset(double input)
```
  - particleCuts
```
protected abstract List<org.lcsim.event.ReconstructedParticle> particleCuts(List<org.lcsim.event.ReconstructedParticle> finalStateParticles)
```
  - findVertices
```
protected abstract void findVertices(List<org.lcsim.event.ReconstructedParticle> electrons,
                                     List<org.lcsim.event.ReconstructedParticle> positrons)
```
    Generates reconstructed V0 candidate particles and vertices from sets of positrons and electrons. Implementing methods should place the reconstructed vertices and candidate particles into the appropriate class variable lists in ReconParticleDriver.
    
    Parameters:
    
    electrons - - The list of electrons.
    
    positrons - - The list of positrons.
  - makeReconstructedParticles
```
protected List<org.lcsim.event.ReconstructedParticle> makeReconstructedParticles(List<org.lcsim.event.Cluster> clusters,
                                                                                 List<List<org.lcsim.event.Track>> trackCollections)
```
    Create the set of final state particles from the event tracks and clusters. Clusters will be matched with tracks when this is possible.
    
    Parameters:
    
    clusters - - The list of event clusters.
    
    trackCollections - - The list of event tracks.
    
    Returns:
    
    Returns a List collection containing all of the ReconstructedParticle objects generated from the argument data.
  - printDebug
```
protected void printDebug(String debugMessage)
```
    Prints a message as per System.out.println to the output stream if the verbose debug output option is enabled.
    
    Parameters:
    
    debugMessage - - The message to print.
  - process
```
protected void process(org.lcsim.event.EventHeader event)
```
    Processes the track and cluster collections in the event into reconstructed particles and V0 candidate particles and vertices. These reconstructed particles are then stored in the event.
    
    Overrides:
    
    process in class org.lcsim.util.Driver
    
    Parameters:
    
    event - - The event to process.
  - startOfData
```
protected void startOfData()
```
    Sets the LCIO collection names to their default values if they are not already defined.
    
    Overrides:
    
    startOfData in class org.lcsim.util.Driver
  - endOfData
```
protected void endOfData()
```
    Overrides:
    
    endOfData in class org.lcsim.util.Driver
  - setSnapToEdge
```
public void setSnapToEdge(boolean val)
```

Class ReconParticleDriver

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

matcher

trackCollectionNames

ELECTRON

POSITRON

MOLLER_TOP

MOLLER_BOT

MAXNSIGMAPOSITIONMATCH

ecal

isMC

disablePID

cuts

hitToRotated

hitToStrips

enableTrackClusterMatchPlots

useCorrectedClusterPositionsForMatching

debug

isMonteCarlo

simpleName

electrons

positrons

finalStateParticles

unconstrainedV0Candidates

beamConV0Candidates

targetConV0Candidates

unconstrainedV0Vertices

beamConV0Vertices

targetConV0Vertices

ecalClustersCollectionName

trackCollectionName

finalStateParticlesColName

OtherElectronsColName

unconstrainedV0CandidatesColName

beamConV0CandidatesColName

targetConV0CandidatesColName

unconstrainedV0VerticesColName

beamConV0VerticesColName

targetConV0VerticesColName

beamSize

beamPosition

bField

beamEnergy

flipSign

Constructor Detail

ReconParticleDriver

Method Detail

setTrackClusterMatchPlots

setUseCorrectedClusterPositionsForMatching

setIsMC

setBeamConV0CandidatesColName

setBeamConV0VerticesColName

setBeamPositionX

setBeamSigmaX

setBeamPositionY

setBeamSigmaY

setBeamPositionZ

setDebug

setEcalClusterCollectionName

setFinalStateParticlesColName

setTargetConV0CandidatesColName

setOtherElectronsColName

setTargetConV0VerticesColName

setTrackCollectionName

setUnconstrainedV0CandidatesColName

setUnconstrainedV0VerticesColName

setTrackCollectionNames

setNSigmaPositionMatch

setDisablePID

detectorChanged

setMaxMatchChisq

setMaxElectronP