IMCParticle

java.lang.Object
- hep.lcio.implementation.event.IMCParticle

All Implemented Interfaces:

LCObject, MCParticle, Cloneable
```
public class IMCParticle
extends Object
implements MCParticle
```
A default implementation of MCParticle.

Field Summary
- Fields inherited from interface hep.lcio.event.MCParticle
  BITBackscatter, BITCreatedInSimulation, BITDecayedInCalorimeter, BITDecayedInTracker, BITEndpoint, BITLeftDetector, BITOverlay, BITStopped, BITVertexIsNotEndpointOfParent

Constructor Summary

Constructors
Constructor and Description

IMCParticle()

Constructors
Constructor and Description
`IMCParticle()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDaughter(MCParticle daughter)`
`float`	`getCharge()` Returns the particle's charge.
`int[]`	`getColorFlow()` Returns the color flow as defined by the generator.
`MCParticle`	`getDaughter(int i)`
`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.
`int`	`getNumberOfDaughters()`
`int`	`getNumberOfParents()`
`MCParticle`	`getParent(int i)`
`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
`void`	`removeAllDaughters()`
`void`	`removeDaughter(MCParticle daughter)`
`void`	`setBackscatter(boolean val)`
`void`	`setCharge(float charge)`
`void`	`setColorFlow(int[] cflow)`
`void`	`setCreatedInSimulation(boolean val)`
`void`	`setDecayedInCalorimeter(boolean val)`
`void`	`setDecayedInTracker(boolean val)`
`void`	`setEndpoint(double[] pos)`
`void`	`setGeneratorStatus(int status)`
`void`	`setHasLeftDetector(boolean val)`
`void`	`setMass(float mass)`
`void`	`setMomentum(double[] momentum)`
`void`	`setMomentum(double px, double py, double pz)`
`void`	`setMomentum(float[] momentum)`
`void`	`setMomentumAtEndpoint(double[] momemtum)`
`void`	`setMomentumAtEndpoint(float[] momemtum)`
`void`	`setOverlay(boolean val)`
`void`	`setPDG(int pdg)`
`void`	`setSimulatorStatus(int status)`
`void`	`setSpin(float[] spin)`
`void`	`setStopped(boolean val)`
`void`	`setTime(float f)`
`void`	`setVertex(double[] pos)`
`void`	`setVertexIsNotEndpointOfParent(boolean val)`
`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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IMCParticle
```
public IMCParticle()
```
- Method Detail
  - setSpin
```
public void setSpin(float[] spin)
```
  - getSpin
```
public float[] getSpin()
```
    Description copied from interface: MCParticle
    
    Returns the spin (helicity) vector of the particle.
    
    Specified by:
    
    getSpin in interface MCParticle
  - setColorFlow
```
public void setColorFlow(int[] cflow)
```
  - getColorFlow
```
public int[] getColorFlow()
```
    Description copied from interface: MCParticle
    
    Returns the color flow as defined by the generator.
    
    Specified by:
    
    getColorFlow in interface MCParticle
  - setCharge
```
public void setCharge(float charge)
```
  - getCharge
```
public float getCharge()
```
    Description copied from interface: MCParticle
    
    Returns the particle's charge.
    
    Specified by:
    
    getCharge in interface MCParticle
  - getDaughter
```
public MCParticle getDaughter(int i)
```
  - setEndpoint
```
public void setEndpoint(double[] pos)
```
  - getEndpoint
```
public double[] getEndpoint()
```
    Description copied from interface: MCParticle
    
    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.
    
    Specified by:
    
    getEndpoint in interface MCParticle
  - getEnergy
```
public double getEnergy()
```
    Description copied from interface: MCParticle
    
    Returns the energy of the particle (at the vertex) in [GeV] computed from the particle's momentum and mass - only float used in files.
    
    Specified by:
    
    getEnergy in interface MCParticle
  - setGeneratorStatus
```
public void setGeneratorStatus(int status)
```
  - getGeneratorStatus
```
public int getGeneratorStatus()
```
    Description copied from interface: MCParticle
    
    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
    
    Specified by:
    
    getGeneratorStatus in interface MCParticle
  - setMass
```
public void setMass(float mass)
```
  - getMass
```
public double getMass()
```
    Description copied from interface: MCParticle
    
    Returns the mass of the particle in [GeV] - only float used in files.
    
    Specified by:
    
    getMass in interface MCParticle
  - setMomentum
```
public void setMomentum(float[] momentum)
```
  - setMomentum
```
public void setMomentum(double[] momentum)
```
  - setMomentum
```
public void setMomentum(double px,
                        double py,
                        double pz)
```
  - getMomentum
```
public double[] getMomentum()
```
    Description copied from interface: MCParticle
    
    Returns the particle's 3-momentum at the production vertex in [GeV] - only float used in files.
    
    Specified by:
    
    getMomentum in interface MCParticle
  - getMomentumAtEndpoint
```
public double[] getMomentumAtEndpoint()
```
    Description copied from interface: MCParticle
    
    Returns the particle's 3-momentum at the endpoint in [GeV] Only float used in files.
    
    Specified by:
    
    getMomentumAtEndpoint in interface MCParticle
  - setMomentumAtEndpoint
```
public void setMomentumAtEndpoint(float[] momemtum)
```
  - setMomentumAtEndpoint
```
public void setMomentumAtEndpoint(double[] momemtum)
```
  - getNumberOfDaughters
```
public int getNumberOfDaughters()
```
  - getNumberOfParents
```
public int getNumberOfParents()
```
  - setPDG
```
public void setPDG(int pdg)
```
  - getPDG
```
public int getPDG()
```
    Description copied from interface: MCParticle
    
    Returns the PDG code of the particle.
    
    Specified by:
    
    getPDG in interface MCParticle
  - getParent
```
public MCParticle getParent(int i)
```
  - setSimulatorStatus
```
public void setSimulatorStatus(int status)
```
  - getSimulatorStatus
```
public int getSimulatorStatus()
```
    Description copied from interface: MCParticle
    
    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:
    
    Specified by:
    
    getSimulatorStatus in interface MCParticle
    
    See Also:
    
    MCParticle.isCreatedInSimulation(), MCParticle.isBackscatter(), MCParticle.vertexIsNotEndpointOfParent(), MCParticle.isDecayedInTracker(), MCParticle.isDecayedInCalorimeter(), MCParticle.hasLeftDetector(), MCParticle.isStopped(), MCParticle.isOverlay()
  - setVertex
```
public void setVertex(double[] pos)
```
  - getVertex
```
public double[] getVertex()
```
    Description copied from interface: MCParticle
    
    Returns the production vertex of the particle in [mm].
    
    Specified by:
    
    getVertex in interface MCParticle
  - addDaughter
```
public void addDaughter(MCParticle daughter)
```
  - removeAllDaughters
```
public void removeAllDaughters()
```
  - removeDaughter
```
public void removeDaughter(MCParticle daughter)
```
  - hasLeftDetector
```
public boolean hasLeftDetector()
```
    Description copied from interface: MCParticle
    
    True if the particle left the world volume undecayed.
    
    Specified by:
    
    hasLeftDetector in interface MCParticle
  - isBackscatter
```
public boolean isBackscatter()
```
    Description copied from interface: MCParticle
    
    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
  - isCreatedInSimulation
```
public boolean isCreatedInSimulation()
```
    Description copied from interface: MCParticle
    
    True if the particle has been created by the simulation program (rather than the generator).
    
    Specified by:
    
    isCreatedInSimulation in interface MCParticle
  - isDecayedInCalorimeter
```
public boolean isDecayedInCalorimeter()
```
    Description copied from interface: MCParticle
    
    True if the particle decayed or interacted (non-continuous interaction, particle terminated) in non-tracking region.
    
    Specified by:
    
    isDecayedInCalorimeter in interface MCParticle
  - isDecayedInTracker
```
public boolean isDecayedInTracker()
```
    Description copied from interface: MCParticle
    
    True if the particle decayed or interacted in a tracking region.
    
    Specified by:
    
    isDecayedInTracker in interface MCParticle
  - isStopped
```
public boolean isStopped()
```
    Description copied from interface: MCParticle
    
    True if the particle lost all kinetic energy inside the world volume and did not decay
    
    Specified by:
    
    isStopped in interface MCParticle
  - isOverlay
```
public boolean isOverlay()
```
    Description copied from interface: MCParticle
    
    True if the particle has been overlayed by the simulation (or digitization) program.
    
    Specified by:
    
    isOverlay in interface MCParticle
  - setBackscatter
```
public void setBackscatter(boolean val)
```
  - setCreatedInSimulation
```
public void setCreatedInSimulation(boolean val)
```
  - setDecayedInCalorimeter
```
public void setDecayedInCalorimeter(boolean val)
```
  - setDecayedInTracker
```
public void setDecayedInTracker(boolean val)
```
  - setHasLeftDetector
```
public void setHasLeftDetector(boolean val)
```
  - setStopped
```
public void setStopped(boolean val)
```
  - setOverlay
```
public void setOverlay(boolean val)
```
  - setVertexIsNotEndpointOfParent
```
public void setVertexIsNotEndpointOfParent(boolean val)
```
  - vertexIsNotEndpointOfParent
```
public boolean vertexIsNotEndpointOfParent()
```
    Description copied from interface: MCParticle
    
    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
  - getDaughters
```
public List getDaughters()
```
    Description copied from interface: MCParticle
    
    Returns the daughters of this particle.
    
    Specified by:
    
    getDaughters in interface MCParticle
  - getParents
```
public List getParents()
```
    Description copied from interface: MCParticle
    
    Returns the parents of this particle.
    
    Specified by:
    
    getParents in interface MCParticle
  - getTime
```
public float getTime()
```
    Description copied from interface: MCParticle
    
    The creation time of the particle in [ns] wrt. the event, e.g. for preassigned decays or decays in flight from the simulator.
    
    Specified by:
    
    getTime in interface MCParticle
  - setTime
```
public void setTime(float f)
```

Class IMCParticle

Field Summary

Fields inherited from interface hep.lcio.event.MCParticle

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IMCParticle

Method Detail

setSpin

getSpin

setColorFlow

getColorFlow

setCharge

getCharge

getDaughter

setEndpoint

getEndpoint

getEnergy

setGeneratorStatus

getGeneratorStatus

setMass

getMass

setMomentum

setMomentum

setMomentum

getMomentum

getMomentumAtEndpoint

setMomentumAtEndpoint

setMomentumAtEndpoint

getNumberOfDaughters

getNumberOfParents

setPDG

getPDG

getParent

setSimulatorStatus

getSimulatorStatus

setVertex

getVertex

addDaughter

removeAllDaughters

removeDaughter

hasLeftDetector

isBackscatter

isCreatedInSimulation

isDecayedInCalorimeter

isDecayedInTracker

isStopped

isOverlay

setBackscatter

setCreatedInSimulation

setDecayedInCalorimeter

setDecayedInTracker

setHasLeftDetector

setStopped

setOverlay

setVertexIsNotEndpointOfParent

vertexIsNotEndpointOfParent

getDaughters

getParents

getTime

setTime