org.lcsim.event.base

Class BaseMCParticle.Status

java.lang.Object

org.lcsim.event.base.BaseMCParticle.Status

All Implemented Interfaces:

MCParticle.SimulatorStatus

Enclosing class:

BaseMCParticle

protected class BaseMCParticle.Status
extends Object
implements MCParticle.SimulatorStatus

Field Summary

Fields

Modifier and Type	Field and Description
private static int	BITBackscatter
private static int	BITCreatedInSimulation
private static int	BITDecayedInCalorimeter
private static int	BITDecayedInTracker
private static int	BITEndpoint
private static int	BITLeftDetector
private static int	BITStopped
private static int	BITVertexIsNotEndpointOfParent
(package private) int	simulatorStatus

Constructor Summary

Constructors

Constructor and Description
BaseMCParticle.Status(int v)

Method Summary

Methods

Modifier and Type	Method and Description
int	getValue() Get the raw undecoded simulator status
boolean	hasLeftDetector() True if the particle left the world volume undecayed.
boolean	isBackscatter() True if the particle was created by the simulator as a result of an interaction or decay in non-tracking region, e.g.
boolean	isCreatedInSimulation() True if the particle has been created by the simulation program (rather than the generator).
boolean	isDecayedInCalorimeter() True if the particle decayed or interacted (non-continuous interaction, particle terminated) in non-tracking region.
boolean	isDecayedInTracker() True if the particle decayed or interacted in a tracking region.
boolean	isStopped() True if the particle lost all kinetic energy inside the world volume and did not decay.
boolean	vertexIsNotEndpointOfParent() True if the particle was created as a result of a continuous process where the parent particle continues, i.e.

Methods inherited from class java.lang.Object

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

Field Detail

simulatorStatus

int simulatorStatus

BITEndpoint

private static final int BITEndpoint

See Also:

Constant Field Values

BITCreatedInSimulation

private static final int BITCreatedInSimulation

See Also:

Constant Field Values

BITBackscatter

private static final int BITBackscatter

See Also:

Constant Field Values

BITVertexIsNotEndpointOfParent

private static final int BITVertexIsNotEndpointOfParent

See Also:

Constant Field Values

BITDecayedInTracker

private static final int BITDecayedInTracker

See Also:

Constant Field Values

BITDecayedInCalorimeter

private static final int BITDecayedInCalorimeter

See Also:

Constant Field Values

BITLeftDetector

private static final int BITLeftDetector

See Also:

Constant Field Values

BITStopped

private static final int BITStopped

See Also:

Constant Field Values

Constructor Detail

BaseMCParticle.Status

public BaseMCParticle.Status(int v)

Method Detail

vertexIsNotEndpointOfParent

public boolean vertexIsNotEndpointOfParent()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle was created as a result of a continuous process where the parent particle continues, i.e. hard ionization, Bremsstrahlung, elastic interactions, etc.

Specified by:

vertexIsNotEndpointOfParent in interface MCParticle.SimulatorStatus

isStopped

public boolean isStopped()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle lost all kinetic energy inside the world volume and did not decay.

Specified by:

isStopped in interface MCParticle.SimulatorStatus

isDecayedInTracker

public boolean isDecayedInTracker()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle decayed or interacted in a tracking region.

Specified by:

isDecayedInTracker in interface MCParticle.SimulatorStatus

isDecayedInCalorimeter

public boolean isDecayedInCalorimeter()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle decayed or interacted (non-continuous interaction, particle terminated) in non-tracking region.

Specified by:

isDecayedInCalorimeter in interface MCParticle.SimulatorStatus

isCreatedInSimulation

public boolean isCreatedInSimulation()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle has been created by the simulation program (rather than the generator).

Specified by:

isCreatedInSimulation in interface MCParticle.SimulatorStatus

isBackscatter

public boolean isBackscatter()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle was created by the simulator as a result of an interaction or decay in non-tracking region, e.g. a calorimeter. By convention, such particles are not saved. However, if this particle creates a tracker hit, the particle is added to the MCParticle list with this flag set, and the parent set to the particle that initially decayed or interacted in a non-tracking region.

Specified by:

isBackscatter in interface MCParticle.SimulatorStatus

hasLeftDetector

public boolean hasLeftDetector()

Description copied from interface: MCParticle.SimulatorStatus

True if the particle left the world volume undecayed.

Specified by:

hasLeftDetector in interface MCParticle.SimulatorStatus

getValue

public int getValue()

Description copied from interface: MCParticle.SimulatorStatus

Get the raw undecoded simulator status

Specified by:

getValue in interface MCParticle.SimulatorStatus