MCParticle

All Superinterfaces:

Cloneable, LCObject

All Known Implementing Classes:

IMCParticle
```
public interface MCParticle
extends LCObject
```
The LCIO Monte Carlo particle.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BITBackscatter`
`static int`	`BITCreatedInSimulation`
`static int`	`BITDecayedInCalorimeter`
`static int`	`BITDecayedInTracker`
`static int`	`BITEndpoint`
`static int`	`BITLeftDetector`
`static int`	`BITOverlay`
`static int`	`BITStopped`
`static int`	`BITVertexIsNotEndpointOfParent`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float`	`getCharge()` Returns the particle's charge.
`int[]`	`getColorFlow()` Returns the color flow as defined by the generator.
`List`	`getDaughters()` Returns the daughters of this particle.
`double[]`	`getEndpoint()` Returns the endpoint of the particle in [mm] if the endpoint has been set explicetly.
`double`	`getEnergy()` Returns the energy of the particle (at the vertex) in [GeV] computed from the particle's momentum and mass - only float used in files.
`int`	`getGeneratorStatus()` Returns the status for particles as defined by the generator, typically 0 empty line 1 undecayed particle, stable in the generator 2 particle decayed in the generator 3 documentation line
`double`	`getMass()` Returns the mass of the particle in [GeV] - only float used in files.
`double[]`	`getMomentum()` Returns the particle's 3-momentum at the production vertex in [GeV] - only float used in files.
`double[]`	`getMomentumAtEndpoint()` Returns the particle's 3-momentum at the endpoint in [GeV] Only float used in files.
`List`	`getParents()` Returns the parents of this particle.
`int`	`getPDG()` Returns the PDG code of the particle.
`int`	`getSimulatorStatus()` Returns the status for particles from the simulation, e.g.
`float[]`	`getSpin()` Returns the spin (helicity) vector of the particle.
`float`	`getTime()` The creation time of the particle in [ns] wrt.
`double[]`	`getVertex()` Returns the production vertex of the particle in [mm].
`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`	`isOverlay()` True if the particle has been overlayed by the simulation (or digitization) program.
`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.

- Field Detail
  - BITEndpoint
```
static final int BITEndpoint
```
    See Also:
    
    Constant Field Values
  - BITCreatedInSimulation
```
static final int BITCreatedInSimulation
```
    See Also:
    
    Constant Field Values
  - BITBackscatter
```
static final int BITBackscatter
```
    See Also:
    
    Constant Field Values
  - BITVertexIsNotEndpointOfParent
```
static final int BITVertexIsNotEndpointOfParent
```
    See Also:
    
    Constant Field Values
  - BITDecayedInTracker
```
static final int BITDecayedInTracker
```
    See Also:
    
    Constant Field Values
  - BITDecayedInCalorimeter
```
static final int BITDecayedInCalorimeter
```
    See Also:
    
    Constant Field Values
  - BITLeftDetector
```
static final int BITLeftDetector
```
    See Also:
    
    Constant Field Values
  - BITStopped
```
static final int BITStopped
```
    See Also:
    
    Constant Field Values
  - BITOverlay
```
static final int BITOverlay
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getEnergy
```
double getEnergy()
```
    Returns the energy of the particle (at the vertex) in [GeV] computed from the particle's momentum and mass - only float used in files.
  - getSpin
```
float[] getSpin()
```
    Returns the spin (helicity) vector of the particle.
  - getColorFlow
```
int[] getColorFlow()
```
    Returns the color flow as defined by the generator.
  - getParents
```
List getParents()
```
    Returns the parents of this particle.
  - getDaughters
```
List getDaughters()
```
    Returns the daughters of this particle.
  - getPDG
```
int getPDG()
```
    Returns the PDG code of the particle.
  - getGeneratorStatus
```
int getGeneratorStatus()
```
    Returns the status for particles as defined by the generator, typically
    0 empty line
    1 undecayed particle, stable in the generator
    2 particle decayed in the generator
    3 documentation line
  - getSimulatorStatus
```
int getSimulatorStatus()
```
    Returns the status for particles from the simulation, e.g. decayed in flight. Bits 31-16 are used to decode the information. Use the followng boolean functions to determine the proper simulator status:
    
    See Also:
    
    isCreatedInSimulation(), isBackscatter(), vertexIsNotEndpointOfParent(), isDecayedInTracker(), isDecayedInCalorimeter(), hasLeftDetector(), isStopped(), isOverlay()
  - isCreatedInSimulation
```
boolean isCreatedInSimulation()
```
    True if the particle has been created by the simulation program (rather than the generator).
  - isBackscatter
```
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. 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.
  - vertexIsNotEndpointOfParent
```
boolean vertexIsNotEndpointOfParent()
```
    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.
  - isDecayedInTracker
```
boolean isDecayedInTracker()
```
    True if the particle decayed or interacted in a tracking region.
  - isDecayedInCalorimeter
```
boolean isDecayedInCalorimeter()
```
    True if the particle decayed or interacted (non-continuous interaction, particle terminated) in non-tracking region.
  - hasLeftDetector
```
boolean hasLeftDetector()
```
    True if the particle left the world volume undecayed.
  - isStopped
```
boolean isStopped()
```
    True if the particle lost all kinetic energy inside the world volume and did not decay
  - isOverlay
```
boolean isOverlay()
```
    True if the particle has been overlayed by the simulation (or digitization) program.
  - getVertex
```
double[] getVertex()
```
    Returns the production vertex of the particle in [mm].
  - getTime
```
float getTime()
```
    The creation time of the particle in [ns] wrt. the event, e.g. for preassigned decays or decays in flight from the simulator.
  - getEndpoint
```
double[] getEndpoint()
```
    Returns the endpoint of the particle in [mm] if the endpoint has been set explicetly. If not, the vertex of the first daughter that has vertexIsNotEndpointOfParent==false is returned. If no such daughter exists (0,0,0) is returned.
  - getMomentum
```
double[] getMomentum()
```
    Returns the particle's 3-momentum at the production vertex in [GeV] - only float used in files.
  - getMomentumAtEndpoint
```
double[] getMomentumAtEndpoint()
```
    Returns the particle's 3-momentum at the endpoint in [GeV] Only float used in files.
  - getMass
```
double getMass()
```
    Returns the mass of the particle in [GeV] - only float used in files.
  - getCharge
```
float getCharge()
```
    Returns the particle's charge.

Interface MCParticle

Field Summary

Method Summary

Field Detail

BITEndpoint

BITCreatedInSimulation

BITBackscatter

BITVertexIsNotEndpointOfParent

BITDecayedInTracker

BITDecayedInCalorimeter

BITLeftDetector

BITStopped

BITOverlay

Method Detail

getEnergy

getSpin

getColorFlow

getParents

getDaughters

getPDG

getGeneratorStatus

getSimulatorStatus

isCreatedInSimulation

isBackscatter

vertexIsNotEndpointOfParent

isDecayedInTracker

isDecayedInCalorimeter

hasLeftDetector

isStopped

isOverlay

getVertex

getTime

getEndpoint

getMomentum

getMomentumAtEndpoint

getMass

getCharge