Rivet API documentation
 |
Rivet 4.1.3
|
Rivet::ParticleBase Class Referenceabstract
Base class for particle-like things like Particle and Jet. More...
#include <ParticleBase.hh>
Inheritance diagram for Rivet::ParticleBase:
Public Member Functions | |
| ParticleBase () | |
| Default constructor. | |
| virtual | ~ParticleBase () |
| Virtual destructor. | |
Effective momentum accessors | |
| virtual const FourMomentum & | momentum () const =0 |
| Get the equivalent momentum four-vector (const). | |
| const FourMomentum & | mom () const |
| Get the equivalent momentum four-vector (const) (alias). | |
| const FourMomentum & | p4 () const |
| Get the equivalent momentum four-vector (const) (alias). | |
| operator const FourMomentum & () const | |
| Cast operator for conversion to FourMomentum. | |
Convenience access to the effective 4-vector properties | |
| double | E () const |
| Get the energy directly. | |
| double | energy () const |
| Get the energy directly (alias). | |
| double | E2 () const |
| Get the energy-squared. | |
| double | energy2 () const |
| Get the energy-squared (alias). | |
| double | pt () const |
| Get the \( p_T \) directly. | |
| double | pT () const |
| Get the \( p_T \) directly (alias). | |
| double | perp () const |
| Get the \( p_T \) directly (alias). | |
| double | pt2 () const |
| Get the \( p_T^2 \) directly. | |
| double | pT2 () const |
| Get the \( p_T^2 \) directly (alias). | |
| double | perp2 () const |
| Get the \( p_T^2 \) directly (alias). | |
| double | Et () const |
| Get the \( E_T \) directly. | |
| double | Et2 () const |
| Get the \( E_T^2 \) directly. | |
| double | mass () const |
| Get the mass directly. | |
| double | mass2 () const |
| Get the mass**2 directly. | |
| double | pseudorapidity () const |
| Get the \( \eta \) directly. | |
| double | eta () const |
| Get the \( \eta \) directly (alias). | |
| double | abspseudorapidity () const |
| Get the \( |\eta| \) directly. | |
| double | abseta () const |
| Get the \( |\eta| \) directly (alias). | |
| double | rapidity () const |
| Get the \( y \) directly. | |
| double | rap () const |
| Get the \( y \) directly (alias). | |
| double | absrapidity () const |
| Get the \( |y| \) directly. | |
| double | absrap () const |
| Get the \( |y| \) directly (alias). | |
| double | azimuthalAngle (const PhiMapping mapping=ZERO_2PI) const |
| Azimuthal angle \( \phi \). | |
| double | phi (const PhiMapping mapping=ZERO_2PI) const |
| Get the \( \phi \) directly. | |
| ThreeMomentum | p3 () const |
| Get the 3-momentum directly. | |
| double | p () const |
| Get the 3-momentum magnitude directly. | |
| double | p2 () const |
| Get the 3-momentum magnitude-squared directly. | |
| Vector3 | ptvec () const |
| Get the transverse 3-momentum directly. | |
| Vector3 | pTvec () const |
| Get the transverse 3-momentum directly. | |
| double | px () const |
| x component of momentum. | |
| double | py () const |
| y component of momentum. | |
| double | pz () const |
| z component of momentum. | |
| double | px2 () const |
| x component of momentum, squared. | |
| double | py2 () const |
| y component of momentum, squared. | |
| double | pz2 () const |
| z component of momentum, squared. | |
| double | polarAngle () const |
| Angle subtended by the 3-vector and the z-axis. | |
| double | theta () const |
| Synonym for polarAngle. | |
| double | angle (const ParticleBase &v) const |
| Angle between this vector and another. | |
| double | angle (const FourVector &v) const |
| Angle between this vector and another. | |
| double | angle (const Vector3 &v3) const |
| Angle between this vector and another (3-vector). | |
| double | dot (const ParticleBase &v) const |
| Lorentz dot product between this 4-vector and another. | |
| double | dot (const FourVector &v) const |
| Angle between this 4-vector and another. | |
Detailed Description
Member Function Documentation
◆ momentum()
|
pure virtual |
Get the equivalent momentum four-vector (const).
Implemented in Rivet::Jet, and Rivet::Particle.
Referenced by abseta(), abspseudorapidity(), absrap(), absrapidity(), angle(), angle(), angle(), azimuthalAngle(), dot(), dot(), E(), E2(), energy(), energy2(), Et(), Et2(), eta(), mass(), mass2(), mom(), operator const FourMomentum &(), p(), p2(), p3(), p4(), phi(), polarAngle(), pseudorapidity(), pt(), pt2(), pTvec(), ptvec(), px(), px2(), py(), py2(), pz(), pz2(), rap(), rapidity(), and theta().
The documentation for this class was generated from the following file:
- /builds/hepcedar/rivet/include/Rivet/ParticleBase.hh
Generated on for Rivet by
1.15.0