org.lcsim.mc.fast.util

Class CreateFinalStateMCParticleList

java.lang.Object

org.lcsim.util.Driver

org.lcsim.mc.fast.util.CreateFinalStateMCParticleList

public class CreateFinalStateMCParticleList
extends Driver

CreateFinalStateMCParticleList writes a list of Final state MCParticles to event. The choices are GeneratorFS(Gen) and SimulatorFS(Sim). The final state particles are those at the end of the decay/interaction chain for the choice(Gen or Sim). By default no particles created without destroying the parent are included. This can be overridden by the setKeepContinuousXXX methods. Decays and interactions beyond a radius or z position can be ignored by using the setRadiusCut and setZCut methods. The collection name of the final state particles can also be set.

Author:

Ron Cassell

Nested Class Summary

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

Driver.AbortRunException, Driver.NextEventException

Field Summary

Fields

Modifier and Type	Field and Description
private MCParticleClassifier	cl
private String	CollectionName
private MCParticleClassifier.MCPClass	fs
private String	FStype
private int	itype
private boolean	keepce
private boolean	keepch
private boolean	keepcp
private double	Rcut
private static String[]	types
private double	Zcut

Fields inherited from class org.lcsim.util.Driver

HLEVEL_DEFAULT, HLEVEL_FULL, HLEVEL_HIGH, HLEVEL_NORMAL, HLEVEL_OFF

Constructor Summary

Constructors

Constructor and Description
CreateFinalStateMCParticleList(String type) Set up the defaults for creating the lists.

Method Summary

Methods

Modifier and Type	Method and Description
MCParticle	getFirstContinuousParticle(MCParticle p) Find and return the top VNEOP particle in parentage chain
boolean	keepThis(MCParticle p, MCParticle pp) Decide if a particle resulting from continuous production should be kept as a final state particle.
void	process(EventHeader event) Process and event.
void	setCollectionName(String name) Set the output collection name
void	setKeepContinuousElectrons() Keep electrons created without destroying parent.
void	setKeepContinuousHadrons() Keep hadrons created without destroying parent.
void	setKeepContinuousPhotons() Keep photons created without destroying parent.
void	setRadiusCut(double rc) Set a radius cut beyond which interactions and decays are ignored.
void	setZCut(double zc) Set a z cut beyond which interactions and decays are ignored.

Methods inherited from class org.lcsim.util.Driver

add, clearStatistics, contains, detectorChanged, 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

fs

private MCParticleClassifier.MCPClass fs

FStype

private String FStype

CollectionName

private String CollectionName

Rcut

private double Rcut

Zcut

private double Zcut

keepce

private boolean keepce

keepcp

private boolean keepcp

keepch

private boolean keepch

types

private static final String[] types

itype

private int itype

cl

private MCParticleClassifier cl

Constructor Detail

CreateFinalStateMCParticleList

public CreateFinalStateMCParticleList(String type)

Set up the defaults for creating the lists. Type parameter must be Gen or Sim.

Parameters:

type -

Method Detail

setCollectionName

public void setCollectionName(String name)

Set the output collection name

Parameters:

name -

setRadiusCut

public void setRadiusCut(double rc)

Set a radius cut beyond which interactions and decays are ignored.

Parameters:

rc -

setZCut

public void setZCut(double zc)

Set a z cut beyond which interactions and decays are ignored.

Parameters:

zc -

setKeepContinuousElectrons

public void setKeepContinuousElectrons()

Keep electrons created without destroying parent. (deltas, comptons)

setKeepContinuousPhotons

public void setKeepContinuousPhotons()

Keep photons created without destroying parent. (brem, nuclear elastic and pseudo-elastic)

setKeepContinuousHadrons

public void setKeepContinuousHadrons()

Keep hadrons created without destroying parent. (nuclear elastic and pseudo-elastic)

process

public void process(EventHeader event)

Process and event. Create the final state particle list and store it in event.

Overrides:

process in class Driver

Parameters:

event -

See Also:

Driver.NextEventException, Driver.AbortRunException

keepThis

public boolean keepThis(MCParticle p,
               MCParticle pp)

Decide if a particle resulting from continuous production should be kept as a final state particle.

Parameters:

p - - particle in question

pp - - first continuous production particle in parentage chain of p

getFirstContinuousParticle

public MCParticle getFirstContinuousParticle(MCParticle p)

Find and return the top VNEOP particle in parentage chain

Parameters:

p - - particle in question