Class Particle¶
Defined in File Particle.hpp
Class Documentation¶
-
class
ActsFatras
::
Particle
¶ Particle identity information and kinematic state.
Also stores some simulation-specific properties.
Public Types
-
using
Scalar
= Acts::ActsScalar¶
-
using
Vector3
= Acts::ActsVector<3>¶
-
using
Vector4
= Acts::ActsVector<4>¶
Public Functions
-
Particle
() = default¶ Construct a default particle with invalid identity.
-
Particle
(Barcode particleId, Acts::PdgParticle pdg, Scalar charge, Scalar mass)¶ Construct a particle at rest with explicit mass and charge.
- Warning
It is the users responsibility that charge and mass match the PDG particle number.
- Parameters
particleId
: Particle identifier within an eventpdg
: PDG idcharge
: Particle charge in native unitsmass
: Particle mass in native units
-
Particle
(Barcode particleId, Acts::PdgParticle pdg)¶ Construct a particle at rest from a PDG particle number.
Charge and mass are retrieved from the particle data table.
- Parameters
particleId
: Particle identifier within an eventpdg
: PDG particle number
-
Particle &
correctEnergy
(Scalar delta)¶ Change the energy by the given amount.
Energy loss corresponds to a negative change. If the updated energy would result in an unphysical value, the particle is put to rest, i.e. its absolute momentum is set to zero.
-
constexpr
operator bool
() const¶ Check if the particle is alive, i.e. is not at rest.
-
constexpr bool
operator!
() const¶ Check if the particle is dead, i.e is at rest.
-
constexpr Scalar
pathInL0
() const¶ Accumulated path within material measured in interaction lengths.
-
constexpr Acts::PdgParticle
pdg
() const¶ PDG particle number that identifies the type.
-
auto
position
() const¶ Three-position, i.e. spatial coordinates without the time.
-
constexpr ProcessType
process
() const¶ Which type of process generated this particle.
-
Particle &
setDirection
(Scalar dx, Scalar dy, Scalar dz)¶ Set the direction three-vector from scalar components.
-
constexpr Particle &
setMaterialPassed
(Scalar pathInX0, Scalar pathInL0)¶ Set the accumulated material measured in radiation/interaction lengths.
- Parameters
pathInX0
: accumulated material measured in radiation lengthspathInL0
: accumulated material measured in interaction lengths
-
Particle &
setPosition4
(const Vector3 &position, Scalar time)¶ Set the space-time position four-vector from three-position and time.
-
Particle &
setPosition4
(Scalar x, Scalar y, Scalar z, Scalar time)¶ Set the space-time position four-vector from scalar components.
-
Particle &
setProcess
(ProcessType proc)¶ Set the process type that generated this particle.
-
constexpr Particle &
setProperTime
(Scalar properTime)¶ Set the proper time in the particle rest frame.
- Parameters
properTime
: passed proper time in the rest frame
-
using