org.lcsim.recon.util

Class PfoSelector

java.lang.Object

org.lcsim.util.Driver

org.lcsim.recon.util.PfoSelector

public class PfoSelector
extends Driver

A driver to select ReconstructedParticles from a collection based on their track and cluster times. This is used to estimate the capability of rejecting machine induced backgrounds by timing information, i.e. at CLIC.

A large number of selection cuts can be adjusted to control the selection behavior for charged particles, neutral hadrons and photons. PFOs going into the far forward region of the detector are treated separately, due to the expected higher occupancy in that region.

This is an adapted version of the Marlin processor CLICPfoSelector, written by Mark Thomson.

Author:

Christian Grefe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	PfoSelector.ClusterTimes A container to hold results from the cluster times calculation.
class	PfoSelector.pfoComparator Class to compare ReconstructedParticles first based on their type and then on their energy.
private class	PfoSelector.TravelTime A container to hold the traveling time of a particle.

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

Driver.AbortRunException, Driver.NextEventException

Field Summary

Fields

Modifier and Type	Field and Description
protected double	chargedPfoLooseTimingCut
protected double	chargedPfoNegativeLooseTimingCut
protected double	chargedPfoNegativeTightTimingCut
protected double	chargedPfoPtCut
protected double	chargedPfoPtCutForLooseTiming
protected double	chargedPfoTightTimingCut
protected boolean	checkKaonCorrection
protected boolean	checkProtonCorrection
protected double	clusterLessPfoTrackTimeCut
protected boolean	correctHitTimesForTimeOfFlight
protected int	ecalNumSides
protected double	ecalPhi0
protected double	ecalRadius
protected double	ecalZ
protected List<Calorimeter.CalorimeterType>	emCalorimeters
protected double	farForwardCosTheta
protected double	forwardCosThetaForHighEnergyNeutralHadrons
protected double	forwardHighEnergyNeutralHadronsEnergy
protected double	hCalBarrelLooseTimingCut
protected double	hCalBarrelTightTimingCut
protected double	hCalEndCapTimingFactor
protected HelixSwimmer	helixSwimmer
protected String	inputPfoCollection
protected boolean	keepKShorts
protected double	maxMomentumForClusterLessPfos
protected int	minECalHitsForTiming
protected int	minHCalEndCapHitsForTiming
protected double	minimumEnergyForNeutronTiming
protected double	minMomentumForClusterLessPfos
protected double	minPtForClusterLessPfos
protected double	neutralFarForwardLooseTimingCut
protected double	neutralFarForwardTightTimingCut
protected double	neutralHadronBarrelPtCutForLooseTiming
protected double	neutralHadronLooseTimingCut
protected double	neutralHadronPtCut
protected double	neutralHadronPtCutForLooseTiming
protected double	neutralHadronTightTimingCut
protected String	outputPfoCollection
protected double	pfoEnergyToDisplay
protected double	photonFarForwardLooseTimingCut
protected double	photonFarForwardTightTimingCut
protected double	photonLooseTimingCut
protected double	photonPtCut
protected double	photonPtCutForLooseTiming
protected double	photonTightTimingCut
protected double	ptCutForTightTiming
protected boolean	useClusterLessPfos
protected boolean	useNeutronTiming

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
PfoSelector()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	detectorChanged(Detector detector) Called by the framework before process method when the detector geometry changes.
protected PfoSelector.ClusterTimes	getClusterTimes(Cluster cluster) Calculates an energy weighted mean time of the cluster and the number of hits in the cluster.
protected void	print(int histogramLevel, String message) Helper method to write a message to the output stream if the histogram level set for the driver is equal or higher than the given value.
protected void	print(int histogramLevel, String message, boolean error) Helper method to write a message to the output stream if the histogram level set for the driver is equal or higher than the given value.
protected void	process(EventHeader event) Called by the framework to process an event.
void	setChargedPfoLooseTimingCut(double chargedPfoLooseTimingCut)
void	setChargedPfoNegativeLooseTimingCut(double chargedPfoNegativeLooseTimingCut)
void	setChargedPfoNegativeTightTimingCut(double chargedPfoNegativeTightTimingCut)
void	setChargedPfoPtCut(double chargedPfoPtCut)
void	setChargedPfoPtCutForLooseTiming(double chargedPfoPtCutForLooseTiming)
void	setChargedPfoTightTimingCut(double chargedPfoTightTimingCut)
void	setCheckKaonCorrection(boolean checkKaonCorrection)
void	setCheckProtonCorrection(boolean checkProtonCorrection)
void	setClusterLessPfoTrackTimeCut(double clusterLessPfoTrackTimeCut)
void	setCorrectHitTimesForTimeOfFlight(boolean correctHitTimesForTimeOfFlight)
void	setFarForwardCosTheta(double farForwardCosTheta)
void	setForwardCosThetaForHighEnergyNeutralHadrons(double forwardCosThetaForHighEnergyNeutralHadrons)
void	setForwardHighEnergyNeutralHadronsEnergy(double forwardHighEnergyNeutralHadronsEnergy)
void	setHCalBarrelLooseTimingCut(double hCalBarrelLooseTimingCut)
void	setHCalBarrelTightTimingCut(double hCalBarrelTightTimingCut)
void	setHCalEndCapTimingFactor(double hCalEndCapTimingFactor)
void	setInputPfoCollection(String inputPfoCollection)
void	setKeepKShorts(boolean keepKShorts)
void	setMaxMomentumForClusterLessPfos(double maxMomentumForClusterLessPfos)
void	setMinECalHitsForTiming(int minECalHitsForTiming)
void	setMinHCalEndCapHitsForTiming(int minHCalEndCapHitsForTiming)
void	setMinimumEnergyForNeutronTiming(double minimumEnergyForNeutronTiming)
void	setMinMomentumForClusterLessPfos(double minMomentumForClusterLessPfos)
void	setMinPtForClusterLessPfos(double minPtForClusterLessPfos)
void	setNeutralFarForwardLooseTimingCut(double neutralFarForwardLooseTimingCut)
void	setNeutralFarForwardTightTimingCut(double neutralFarForwardTightTimingCut)
void	setNeutralHadronBarrelPtCutForLooseTiming(double neutralHadronBarrelPtCutForLooseTiming)
void	setNeutralHadronLooseTimingCut(double neutralHadronLooseTimingCut)
void	setNeutralHadronPtCut(double neutralHadronPtCut)
void	setNeutralHadronPtCutForLooseTiming(double neutralHadronPtCutForLooseTiming)
void	setNeutralHadronTightTimingCut(double neutralHadronTightTimingCut)
void	setOutputPfoCollection(String outputPfoCollection)
void	setPfoEnergyToDisplay(double pfoEnergyToDisplay)
void	setPhotonFarForwardLooseTimingCut(double photonFarForwardLooseTimingCut)
void	setPhotonFarForwardTightTimingCut(double photonFarForwardTightTimingCut)
void	setPhotonLooseTimingCut(double photonLooseTimingCut)
void	setPhotonPtCut(double photonPtCut)
void	setPhotonPtCutForLooseTiming(double photonPtCutForLooseTiming)
void	setPhotonTightTimingCut(double photonTightTimingCut)
void	setPtCutForTightTiming(double ptCutForTightTiming)
void	setUseClusterLessPfos(boolean useClusterLessPfos)
void	setUseNeutronTiming(boolean useNeutronTiming)
protected PfoSelector.TravelTime	timeAtEcal(Track track) Calculates the time it took the track to reach the face of the calorimeter.

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, startOfData, suspend

Methods inherited from class java.lang.Object

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

Field Detail

inputPfoCollection

protected String inputPfoCollection

outputPfoCollection

protected String outputPfoCollection

correctHitTimesForTimeOfFlight

protected boolean correctHitTimesForTimeOfFlight

checkProtonCorrection

protected boolean checkProtonCorrection

checkKaonCorrection

protected boolean checkKaonCorrection

keepKShorts

protected boolean keepKShorts

useNeutronTiming

protected boolean useNeutronTiming

useClusterLessPfos

protected boolean useClusterLessPfos

pfoEnergyToDisplay

protected double pfoEnergyToDisplay

minimumEnergyForNeutronTiming

protected double minimumEnergyForNeutronTiming

forwardCosThetaForHighEnergyNeutralHadrons

protected double forwardCosThetaForHighEnergyNeutralHadrons

forwardHighEnergyNeutralHadronsEnergy

protected double forwardHighEnergyNeutralHadronsEnergy

farForwardCosTheta

protected double farForwardCosTheta

ptCutForTightTiming

protected double ptCutForTightTiming

photonPtCut

protected double photonPtCut

photonPtCutForLooseTiming

protected double photonPtCutForLooseTiming

photonLooseTimingCut

protected double photonLooseTimingCut

photonTightTimingCut

protected double photonTightTimingCut

chargedPfoPtCut

protected double chargedPfoPtCut

chargedPfoPtCutForLooseTiming

protected double chargedPfoPtCutForLooseTiming

chargedPfoLooseTimingCut

protected double chargedPfoLooseTimingCut

chargedPfoTightTimingCut

protected double chargedPfoTightTimingCut

chargedPfoNegativeLooseTimingCut

protected double chargedPfoNegativeLooseTimingCut

chargedPfoNegativeTightTimingCut

protected double chargedPfoNegativeTightTimingCut

neutralHadronPtCut

protected double neutralHadronPtCut

neutralHadronPtCutForLooseTiming

protected double neutralHadronPtCutForLooseTiming

neutralHadronLooseTimingCut

protected double neutralHadronLooseTimingCut

neutralHadronTightTimingCut

protected double neutralHadronTightTimingCut

neutralFarForwardLooseTimingCut

protected double neutralFarForwardLooseTimingCut

neutralFarForwardTightTimingCut

protected double neutralFarForwardTightTimingCut

photonFarForwardLooseTimingCut

protected double photonFarForwardLooseTimingCut

photonFarForwardTightTimingCut

protected double photonFarForwardTightTimingCut

hCalBarrelLooseTimingCut

protected double hCalBarrelLooseTimingCut

hCalBarrelTightTimingCut

protected double hCalBarrelTightTimingCut

hCalEndCapTimingFactor

protected double hCalEndCapTimingFactor

neutralHadronBarrelPtCutForLooseTiming

protected double neutralHadronBarrelPtCutForLooseTiming

minECalHitsForTiming

protected int minECalHitsForTiming

minHCalEndCapHitsForTiming

protected int minHCalEndCapHitsForTiming

minMomentumForClusterLessPfos

protected double minMomentumForClusterLessPfos

maxMomentumForClusterLessPfos

protected double maxMomentumForClusterLessPfos

minPtForClusterLessPfos

protected double minPtForClusterLessPfos

clusterLessPfoTrackTimeCut

protected double clusterLessPfoTrackTimeCut

ecalRadius

protected double ecalRadius

ecalZ

protected double ecalZ

ecalPhi0

protected double ecalPhi0

ecalNumSides

protected int ecalNumSides

helixSwimmer

protected HelixSwimmer helixSwimmer

emCalorimeters

protected List<Calorimeter.CalorimeterType> emCalorimeters

Constructor Detail

PfoSelector

public PfoSelector()

Method Detail

detectorChanged

protected void detectorChanged(Detector detector)

Description copied from class: Driver

Called by the framework before process method when the detector geometry changes. This method is gauranteed to be called once before the first call to process.

Overrides:

detectorChanged in class Driver

process

protected void process(EventHeader event)

Description copied from class: Driver

Called by the framework to process an event. Don't forget to call super.process(event) to cause the child processes to be executed. In addition the process event call can throw some special exceptions:

• NextEventException - aborts further processing of this event
• StopRunException - causes event processing to be stopped

Overrides:

process in class Driver

Parameters:

event - The event to be processed

See Also:

Driver.NextEventException, Driver.AbortRunException

setInputPfoCollection

public void setInputPfoCollection(String inputPfoCollection)

setOutputPfoCollection

public void setOutputPfoCollection(String outputPfoCollection)

setCorrectHitTimesForTimeOfFlight

public void setCorrectHitTimesForTimeOfFlight(boolean correctHitTimesForTimeOfFlight)

setCheckKaonCorrection

public void setCheckKaonCorrection(boolean checkKaonCorrection)

setCheckProtonCorrection

public void setCheckProtonCorrection(boolean checkProtonCorrection)

setKeepKShorts

public void setKeepKShorts(boolean keepKShorts)

setUseNeutronTiming

public void setUseNeutronTiming(boolean useNeutronTiming)

setUseClusterLessPfos

public void setUseClusterLessPfos(boolean useClusterLessPfos)

setPfoEnergyToDisplay

public void setPfoEnergyToDisplay(double pfoEnergyToDisplay)

setMinimumEnergyForNeutronTiming

public void setMinimumEnergyForNeutronTiming(double minimumEnergyForNeutronTiming)

setForwardCosThetaForHighEnergyNeutralHadrons

public void setForwardCosThetaForHighEnergyNeutralHadrons(double forwardCosThetaForHighEnergyNeutralHadrons)

setForwardHighEnergyNeutralHadronsEnergy

public void setForwardHighEnergyNeutralHadronsEnergy(double forwardHighEnergyNeutralHadronsEnergy)

setFarForwardCosTheta

public void setFarForwardCosTheta(double farForwardCosTheta)

setPtCutForTightTiming

public void setPtCutForTightTiming(double ptCutForTightTiming)

setPhotonPtCut

public void setPhotonPtCut(double photonPtCut)

setPhotonPtCutForLooseTiming

public void setPhotonPtCutForLooseTiming(double photonPtCutForLooseTiming)

setPhotonLooseTimingCut

public void setPhotonLooseTimingCut(double photonLooseTimingCut)

setPhotonTightTimingCut

public void setPhotonTightTimingCut(double photonTightTimingCut)

setChargedPfoPtCut

public void setChargedPfoPtCut(double chargedPfoPtCut)

setChargedPfoPtCutForLooseTiming

public void setChargedPfoPtCutForLooseTiming(double chargedPfoPtCutForLooseTiming)

setChargedPfoLooseTimingCut

public void setChargedPfoLooseTimingCut(double chargedPfoLooseTimingCut)

setChargedPfoTightTimingCut

public void setChargedPfoTightTimingCut(double chargedPfoTightTimingCut)

setChargedPfoNegativeLooseTimingCut

public void setChargedPfoNegativeLooseTimingCut(double chargedPfoNegativeLooseTimingCut)

setChargedPfoNegativeTightTimingCut

public void setChargedPfoNegativeTightTimingCut(double chargedPfoNegativeTightTimingCut)

setNeutralHadronPtCut

public void setNeutralHadronPtCut(double neutralHadronPtCut)

setNeutralHadronPtCutForLooseTiming

public void setNeutralHadronPtCutForLooseTiming(double neutralHadronPtCutForLooseTiming)

setNeutralHadronLooseTimingCut

public void setNeutralHadronLooseTimingCut(double neutralHadronLooseTimingCut)

setNeutralHadronTightTimingCut

public void setNeutralHadronTightTimingCut(double neutralHadronTightTimingCut)

setNeutralFarForwardLooseTimingCut

public void setNeutralFarForwardLooseTimingCut(double neutralFarForwardLooseTimingCut)

setNeutralFarForwardTightTimingCut

public void setNeutralFarForwardTightTimingCut(double neutralFarForwardTightTimingCut)

setPhotonFarForwardLooseTimingCut

public void setPhotonFarForwardLooseTimingCut(double photonFarForwardLooseTimingCut)

setPhotonFarForwardTightTimingCut

public void setPhotonFarForwardTightTimingCut(double photonFarForwardTightTimingCut)

setHCalBarrelLooseTimingCut

public void setHCalBarrelLooseTimingCut(double hCalBarrelLooseTimingCut)

setHCalBarrelTightTimingCut

public void setHCalBarrelTightTimingCut(double hCalBarrelTightTimingCut)

setHCalEndCapTimingFactor

public void setHCalEndCapTimingFactor(double hCalEndCapTimingFactor)

setNeutralHadronBarrelPtCutForLooseTiming

public void setNeutralHadronBarrelPtCutForLooseTiming(double neutralHadronBarrelPtCutForLooseTiming)

setMinECalHitsForTiming

public void setMinECalHitsForTiming(int minECalHitsForTiming)

setMinHCalEndCapHitsForTiming

public void setMinHCalEndCapHitsForTiming(int minHCalEndCapHitsForTiming)

setMinMomentumForClusterLessPfos

public void setMinMomentumForClusterLessPfos(double minMomentumForClusterLessPfos)

setMaxMomentumForClusterLessPfos

public void setMaxMomentumForClusterLessPfos(double maxMomentumForClusterLessPfos)

setMinPtForClusterLessPfos

public void setMinPtForClusterLessPfos(double minPtForClusterLessPfos)

setClusterLessPfoTrackTimeCut

public void setClusterLessPfoTrackTimeCut(double clusterLessPfoTrackTimeCut)

timeAtEcal

protected PfoSelector.TravelTime timeAtEcal(Track track)

Calculates the time it took the track to reach the face of the calorimeter. It calculates the time of flight along the line of sight between the origin and the impact point on at the calorimeter. It also calculates the minimum time it took to travel along the helix assuming its mass to be a charged pion.

Parameters:

track - The track which travel time should be calculated

Returns:

The minimum time along the helix and the time of flight along the line of sight

getClusterTimes

protected PfoSelector.ClusterTimes getClusterTimes(Cluster cluster)

Calculates an energy weighted mean time of the cluster and the number of hits in the cluster. Also calculates the mean time of the cluster fractions present in the ECal and the HCal endcap.

Parameters:

cluster - The cluster to be analysed

Returns:

The calculated cluster times

print

protected void print(int histogramLevel,
         String message)

Helper method to write a message to the output stream if the histogram level set for the driver is equal or higher than the given value.

Parameters:

histogramLevel - The level at which the message is printed

message - The message, which will be printed to the stream

print

protected void print(int histogramLevel,
         String message,
         boolean error)

Helper method to write a message to the output stream if the histogram level set for the driver is equal or higher than the given value.

Parameters:

histogramLevel - The level at which the message is printed

message - The message, which will be printed to the stream

error - If true, writes to error stream instead of standard