pyrex.particle.Particle

class pyrex.particle.Particle(particle_id, vertex, direction, energy, interaction_model=<class 'pyrex.particle.CTWInteraction'>, interaction_type=None, weight=None)

Class for storing particle attributes.

Parameters

particle_id

Identification value of the particle type. Values should be from the Particle.Type enum, but integer or string values may work if carefully chosen. Particle.Type.undefined by default.

vertexarray_like

Vector position (m) of the particle.

directionarray_like

Vector direction of the particle’s velocity.

energyfloat

Energy (GeV) of the particle.

interaction_modeloptional

Class to use to describe interactions of the particle. Should inherit from (or behave like) the base Interaction class.

interaction_typeoptional

Value of the interaction type. Values should be from the Interaction.Type enum, but integer or string values may work if carefully chosen. By default, the interaction_model will choose an interaction type.

weightfloat, optional

Total Monte Carlo weight of the particle. The calculation of this weight depends on the particle generation method, but this value should be the total weight representing the probability of this particle’s event occurring.

See also

Interaction

Base class for describing neutrino interaction attributes.

Attributes

idParticle.Type

Identification value of the particle type.

vertexarray_like

Vector position (m) of the particle.

directionarray_like

(Unit) vector direction of the particle’s velocity.

energyfloat

Energy (GeV) of the particle.

interactionInteraction

Instance of the interaction_model class to be used for calculations related to interactions of the particle.

weightfloat

Total Monte Carlo weight of the particle

survival_weightfloat

Monte Carlo weight of the particle surviving to its vertex. Represents the probability that the particle does not interact along its path through the Earth.

interaction_weightfloat

Monte Carlo weight of the particle interacting at its vertex. Represents the probability that the the particle interacts specifically at its given vertex.

Methods

Type(value)

Enum containing possible particle types.