org.lcsim.event

Interface MCParticle

All Superinterfaces:

Particle

All Known Implementing Classes:

BaseMCParticle, LCSimFactory.GeneratorParticle, SIOMCParticle

public interface MCParticle
extends Particle

A simulated track.

Version:

$Id: MCParticle.java,v 1.7 2011/08/24 18:51:17 jeremy Exp $

Author:

Tony Johnson, Jeremy McCormick

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MCParticle.SimulatorStatus Simulation flags.

Field Summary

Fields inherited from interface hep.physics.particle.Particle

DOCUMENTATION, FINAL_STATE, INTERMEDIATE

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getColorFlow() Get the color flow of particle.
List<MCParticle>	getDaughters() Get the daughters of this particle.
Hep3Vector	getEndPoint() The endpoint of the simulated track.
List<MCParticle>	getParents() Get the parents of this particle.
MCParticle.SimulatorStatus	getSimulatorStatus() If this event has been simulated by Geant4 this method will return the simulation status.
float[]	getSpin() Get the X, Y, and Z spin components of this particle.

Methods inherited from interface hep.physics.particle.Particle

asFourVector, getCharge, getEnergy, getGeneratorStatus, getMass, getMomentum, getOrigin, getOriginX, getOriginY, getOriginZ, getPDGID, getProductionTime, getPX, getPY, getPZ, getType

Method Detail

getParents

List<MCParticle> getParents()

Get the parents of this particle.

Specified by:

getParents in interface Particle

Returns:

The particle's parents.

getDaughters

List<MCParticle> getDaughters()

Get the daughters of this particle.

Specified by:

getDaughters in interface Particle

Returns:

The particle daughters.

getSimulatorStatus

MCParticle.SimulatorStatus getSimulatorStatus()

If this event has been simulated by Geant4 this method will return the simulation status.

Returns:

The particle's simulator status.

getEndPoint

Hep3Vector getEndPoint()

The endpoint of the simulated track.

Returns:

The particle's end point.

Throws:

RuntimeException - if endpoint is not available.

getSpin

float[] getSpin()

Get the X, Y, and Z spin components of this particle.

Returns:

The particle's spin components.

getColorFlow

int[] getColorFlow()

Get the color flow of particle.

Returns:

The particle's color flow.