Reference
Contents
Index
LorentzVectorBase.PtEtaPhiMLorentzVectorBase.XYZELorentzVectorBase.boost_betaLorentzVectorBase.boost_gammaLorentzVectorBase.coordinate_namesLorentzVectorBase.coordinate_systemLorentzVectorBase.cos_phiLorentzVectorBase.cos_thetaLorentzVectorBase.energyLorentzVectorBase.etaLorentzVectorBase.massLorentzVectorBase.mass2LorentzVectorBase.minus_componentLorentzVectorBase.mtLorentzVectorBase.mt2LorentzVectorBase.phiLorentzVectorBase.plus_componentLorentzVectorBase.polar_angleLorentzVectorBase.ptLorentzVectorBase.pt2LorentzVectorBase.pxLorentzVectorBase.pyLorentzVectorBase.pzLorentzVectorBase.rapidityLorentzVectorBase.sin_phiLorentzVectorBase.spatial_magnitudeLorentzVectorBase.spatial_magnitude2
LorentzVectorBase.PtEtaPhiM — TypePtEtaPhiM <: AbstractCoordinateSystemCylindrical coordinate system for four-momenta. Using this requires the implementation of the following interface functions:
pt(::CustomFourMomentum)
eta(::CustomFourMomentum)
phi(::CustomFourMomentum)
mass(::CustomFourMomentum)LorentzVectorBase.XYZE — TypeXYZE <: AbstractCoordinateSystemCartesian coordinate system for four-momenta. Using this requires the implementation of the following interface functions:
px(::CustomFourMomentum)
py(::CustomFourMomentum)
pz(::CustomFourMomentum)
energy(::CustomFourMomentum)LorentzVectorBase.boost_beta — Methodboost_beta(::XYZE, mom )Return spatialmagnitude of the beta vector for a given four-momentum, i.e. the spatialmagnitude of the four-momentum divided by its 0-component.
If (px,py,pz,E) is a four-momentum, this is equivalent to sqrt(px^2 + py^2 + pz^2)/E.
LorentzVectorBase.boost_gamma — Methodboost_gamma(::XYZE,mom)Return the relativistic gamma factor for a given four-momentum, i.e. the inverse square root of one minus the beta vector squared.
If (px,py,pz,E) is a four-momentum with beta vector β, this is equivalent to 1/sqrt(1- β^2).
LorentzVectorBase.coordinate_names — Functioncoordinate_names(::AbstractCoordinateSystem)::Tuple{Symbols}LorentzVectorBase.coordinate_system — Functioncoordinate_system(::MomType)::CS where {CS <: AbstractCoordinateSystem}LorentzVectorBase.cos_phi — Methodcos_phi(::XYZE, mom)Return the cosine of the azimuthal angle for a given four-momentum.
This is an equivalent but faster version of cos(azimuthal_angle(mom)); see phi.
LorentzVectorBase.cos_theta — Methodcos_theta(::XYZE, mom)Return the cosine of the theta angle for a given four-momentum.
This is an equivalent but faster version of cos(polar_angle(::XYZE, mom)); see polar_angle.
LorentzVectorBase.energy — Functionenergy(mom)TBW
LorentzVectorBase.eta — Methodeta(::XYZE, mom)TBW
LorentzVectorBase.mass — Methodmass(::XYZE,mom)Return the the invariant mass of a given four-momentum, i.e. the square root of the minkowski dot with itself.
If (px,py,pz,E) is a four-momentum, this is equivalent to sqrt(E^2 - (px^2 + py^2 + pz^2)).
If the squared invariant mass m2 is negative, -sqrt(-m2) is returned.
LorentzVectorBase.mass2 — Methodmass2(::XYZE,mom)Return the squared invariant mass of a given four-momentum, i.e. the minkowski dot with itself.
If (px,py,pz,E) is a four-momentum, this is equivalent to E^2 - (px^2 + py^2 + pz^2).
LorentzVectorBase.minus_component — Methodminus_component(::XYZE, mom)Return the minus component for a given four-momentum in light-cone coordinates.
If (px,py,pz,E) is a four-momentum, this is equivalent to (E-pz)/2.
The light-cone coordinates are defined w.r.t. to the 3-axis.
The definition `p^- := (E - p_z)/2 differs from the usual definition of light-cone coordinates in general relativity.
LorentzVectorBase.mt — Methodmt(::XYZE,mom)Return the transverse momentum for a given four-momentum, i.e. the square root of its squared transverse mass.
If (px,py,pz,E) is a four-momentum, this is equivalent to sqrt(E^2 - pz^2).
The transverse components are defined w.r.t. to the 3-axis.
If the squared transverse mass mt2 is negative, -sqrt(-mt2) is returned.
LorentzVectorBase.mt2 — Methodmt2(::XYZE, mom)Return the squared transverse mass for a given four-momentum, i.e. the difference of its squared 0- and 3-component.
If (px,py,pz,E) is a four-momentum, this is equivalent to E^2 - pz^2.
The transverse components are defined w.r.t. to the 3-axis.
LorentzVectorBase.phi — Methodphi(::XYZE, mom)Return the phi angle for a given four-momentum, i.e. the azimuthal angle of its spatial components in spherical coordinates.
If (px,py,pz,E) is a four-momentum, this is equivalent to atan(py,px).
The spherical coordinates are defined w.r.t. to the 3-axis.
LorentzVectorBase.plus_component — Methodplus_component(::XYZE, mom)Return the plus component for a given four-momentum in light-cone coordinates.
If (px,py,pz,E) is a four-momentum, this is equivalent to (E+pz)/2.
The light-cone coordinates are defined w.r.t. to the 3-axis.
The definition `p^+ := (E + p_z)/2 differs from the usual definition of light-cone coordinates in general relativity.
LorentzVectorBase.polar_angle — Methodpolar_angle(::XYZE,mom)Return the theta angle for a given four-momentum, i.e. the polar angle of its spatial components in spherical coordinates.
If (px,py,pz,E) is a four-momentum with spatial_magnitude rho, this is equivalent to arccos(pz/rho), which is also equivalent to arctan(sqrt(px^2+py^2)/pz).
The spherical coordinates are defined w.r.t. to the 3-axis.
LorentzVectorBase.pt — Methodpt(::XYZE, mom)Return the transverse momentum for a given four-momentum, i.e. the spatial_magnitude of its transverse components.
If (px,py,pz,E) is a four-momentum, this is equivalent to sqrt(px^2 + py^2).
The transverse components are defined w.r.t. to the 3-axis.
LorentzVectorBase.pt2 — Methodpt2(::XYZE,mom)Return the squared transverse momentum for a given four-momentum, i.e. the sum of its squared 1- and 2-component.
If (px,py,pz,E) is a four-momentum, this is equivalent to px^2 + py^2.
The transverse components are defined w.r.t. to the 3-axis.
LorentzVectorBase.px — Functionpx(mom)TBW
LorentzVectorBase.py — Functionpy(mom)TBW
LorentzVectorBase.pz — Functionpz(mom)TBW
LorentzVectorBase.rapidity — Methodrapidity(::XYZE, mom)Return the rapidity for a given four-momentum.
If (px,py,pz,E) is a four-momentum, this is equivalent to 0.5*log((E+pz)/(E-pz)).
The transverse components are defined w.r.t. to the 3-axis.
LorentzVectorBase.sin_phi — Methodsin_phi(::XYZE,mom)Return the sine of the azimuthal angle for a given four-momentum.
This is an equivalent but faster version of sin(azimuthal_angle(mom)); see phi.
LorentzVectorBase.spatial_magnitude — Methodspatial_magnitude(::XYZE,mom)Return the spatial_magnitude of a given four-momentum, i.e. the euklidian norm spatial components.
If (px,py,pz,E) is a four-momentum, this is equivalent to sqrt(px^2 + py^2 + pz^2).
This function differs from a similar function for the TLorentzVector used in the famous ROOT library.
LorentzVectorBase.spatial_magnitude2 — Methodspatial_magnitude2(::XYZE, mom)Return the square of the spatial_magnitude of a given four-momentum, i.e. the sum of the squared spatial components.
If (px,py,pz,E) is a four-momentum, this is equivalent to px^2+ py^2 + pz^2.
This function differs from a similar function for the TLorentzVector used in the famous ROOT library.