class Rivet::ParticleBase

Rivet::ParticleBase

Base class for particle-like things like Particle and Jet.

#include <ParticleBase.hh>

Inherited by Rivet::Jet, Rivet::Particle

Public Functions

Name
virtual const FourMomentum &momentum() const =0
Get equivalent single momentum four-vector (const).
const FourMomentum &mom() const
Get equivalent single momentum four-vector (const) (alias).
operator const FourMomentum &() const
Cast operator for conversion to FourMomentum.
doubleE() const
Get the energy directly.
doubleenergy() const
Get the energy directly (alias).
doubleE2() const
Get the energy-squared.
doubleenergy2() const
Get the energy-squared (alias).
doublept() const
Get the ( p_T ) directly.
doublepT() const
Get the ( p_T ) directly (alias).
doubleperp() const
Get the ( p_T ) directly (alias).
doublept2() const
Get the ( p_T^2 ) directly.
doublepT2() const
Get the ( p_T^2 ) directly (alias).
doubleperp2() const
Get the ( p_T^2 ) directly (alias).
doubleEt() const
Get the ( E_T ) directly.
doubleEt2() const
Get the ( E_T^2 ) directly.
doublemass() const
Get the mass directly.
doublemass2() const
Get the mass**2 directly.
doublepseudorapidity() const
Get the ( \eta ) directly.
doubleeta() const
Get the ( \eta ) directly (alias).
doubleabspseudorapidity() const
Get the (
doubleabseta() const
Get the (
doublerapidity() const
Get the ( y ) directly.
doublerap() const
Get the ( y ) directly (alias).
doubleabsrapidity() const
Get the (
doubleabsrap() const
Get the (
doubleazimuthalAngle(const PhiMapping mapping =ZERO_2PI) const
Azimuthal angle ( \phi ).
doublephi(const PhiMapping mapping =ZERO_2PI) const
Get the ( \phi ) directly.
Vector3p3() const
Get the 3-momentum directly.
doublep() const
Get the 3-momentum magnitude directly.
doublep2() const
Get the 3-momentum magnitude-squared directly.
Vector3ptvec() const
Get the transverse 3-momentum directly.
Vector3pTvec() const
Get the transverse 3-momentum directly.
doublepx() const
x component of momentum.
doublepy() const
y component of momentum.
doublepz() const
z component of momentum.
doublepx2() const
x component of momentum, squared.
doublepy2() const
y component of momentum, squared.
doublepz2() const
z component of momentum, squared.
doublepolarAngle() const
Angle subtended by the 3-vector and the z-axis.
doubletheta() const
Synonym for polarAngle.
doubleangle(const ParticleBase & v) const
Angle between this vector and another.
doubleangle(const FourVector & v) const
Angle between this vector and another.
doubleangle(const Vector3 & v3) const
Angle between this vector and another (3-vector)
doubledot(const ParticleBase & v) const
Lorentz dot product between this 4-vector and another.
doubledot(const FourVector & v) const
Angle between this 4-vector and another.
ParticleBase()
Default constructor.
virtual~ParticleBase()
Virtual destructor.

Public Functions Documentation

function momentum

virtual const FourMomentum & momentum() const =0

Get equivalent single momentum four-vector (const).

Reimplemented by: Rivet::Jet::momentum, Rivet::DressedLepton::momentum

function mom

inline const FourMomentum & mom() const

Get equivalent single momentum four-vector (const) (alias).

function operator const FourMomentum &

inline operator const FourMomentum &() const

Cast operator for conversion to FourMomentum.

function E

inline double E() const

Get the energy directly.

function energy

inline double energy() const

Get the energy directly (alias).

function E2

inline double E2() const

Get the energy-squared.

function energy2

inline double energy2() const

Get the energy-squared (alias).

function pt

inline double pt() const

Get the ( p_T ) directly.

function pT

inline double pT() const

Get the ( p_T ) directly (alias).

function perp

inline double perp() const

Get the ( p_T ) directly (alias).

function pt2

inline double pt2() const

Get the ( p_T^2 ) directly.

function pT2

inline double pT2() const

Get the ( p_T^2 ) directly (alias).

function perp2

inline double perp2() const

Get the ( p_T^2 ) directly (alias).

function Et

inline double Et() const

Get the ( E_T ) directly.

function Et2

inline double Et2() const

Get the ( E_T^2 ) directly.

function mass

inline double mass() const

Get the mass directly.

function mass2

inline double mass2() const

Get the mass**2 directly.

function pseudorapidity

inline double pseudorapidity() const

Get the ( \eta ) directly.

function eta

inline double eta() const

Get the ( \eta ) directly (alias).

function abspseudorapidity

inline double abspseudorapidity() const

Get the ( |\eta| ) directly.

function abseta

inline double abseta() const

Get the ( |\eta| ) directly (alias).

function rapidity

inline double rapidity() const

Get the ( y ) directly.

function rap

inline double rap() const

Get the ( y ) directly (alias).

function absrapidity

inline double absrapidity() const

Get the ( |y| ) directly.

function absrap

inline double absrap() const

Get the ( |y| ) directly (alias).

function azimuthalAngle

inline double azimuthalAngle(
    const PhiMapping mapping =ZERO_2PI
) const

Azimuthal angle ( \phi ).

function phi

inline double phi(
    const PhiMapping mapping =ZERO_2PI
) const

Get the ( \phi ) directly.

function p3

inline Vector3 p3() const

Get the 3-momentum directly.

function p

inline double p() const

Get the 3-momentum magnitude directly.

function p2

inline double p2() const

Get the 3-momentum magnitude-squared directly.

function ptvec

inline Vector3 ptvec() const

Get the transverse 3-momentum directly.

function pTvec

inline Vector3 pTvec() const

Get the transverse 3-momentum directly.

function px

inline double px() const

x component of momentum.

function py

inline double py() const

y component of momentum.

function pz

inline double pz() const

z component of momentum.

function px2

inline double px2() const

x component of momentum, squared.

function py2

inline double py2() const

y component of momentum, squared.

function pz2

inline double pz2() const

z component of momentum, squared.

function polarAngle

inline double polarAngle() const

Angle subtended by the 3-vector and the z-axis.

function theta

inline double theta() const

Synonym for polarAngle.

function angle

inline double angle(
    const ParticleBase & v
) const

Angle between this vector and another.

function angle

inline double angle(
    const FourVector & v
) const

Angle between this vector and another.

function angle

inline double angle(
    const Vector3 & v3
) const

Angle between this vector and another (3-vector)

function dot

inline double dot(
    const ParticleBase & v
) const

Lorentz dot product between this 4-vector and another.

function dot

inline double dot(
    const FourVector & v
) const

Angle between this 4-vector and another.

function ParticleBase

inline ParticleBase()

Default constructor.

function ~ParticleBase

inline virtual ~ParticleBase()

Virtual destructor.


Updated on 2022-08-07 at 20:17:17 +0100