rivet is hosted by Hepforge, IPPP Durham
Rivet  2.7.0
Rivet::Beam Class Reference

Project out the incoming beams. More...

#include <Beam.hh>

Inheritance diagram for Rivet::Beam:
Rivet::Projection Rivet::ProjectionApplier

Public Member Functions

 Beam ()
 Default (and only) constructor.
 
 DEFAULT_RIVET_PROJ_CLONE (Beam)
 Clone on the heap.
 
FourVector pv () const
 Get the beam interaction primary vertex (PV) position.
 
virtual void project (const Event &e)
 Project on to the Event.
 
Beam particles and kinematics
const ParticlePair & beams () const
 The pair of beam particles in the current collision.
 
PdgIdPair beamIds () const
 
double sqrtS () const
 Get centre of mass energy, $ \sqrt{s} $.
 
FourMomentum cmsBoostVec () const
 Get the Lorentz boost to the beam centre-of-mass.
 
LorentzTransform cmsTransform () const
 Get the Lorentz transform to the beam centre-of-mass.
 
Vector3 cmsBetaVec () const
 Get the beta factor vector for the Lorentz boost to the beam centre-of-mass.
 
Vector3 cmsGammaVec () const
 Get the gamma factor vector for the Lorentz boost to the beam centre-of-mass.
 
Per-nucleon beam kinematics
double asqrtS () const
 Get per-nucleon centre of mass energy, $ \sqrt{s}/(A_1 + A_2) $.
 
Vector3 acmsBetaVec () const
 Get the Lorentz boost to the per-nucleon beam centre-of-mass.
 
Vector3 acmsGammaVec () const
 Get the Lorentz boost to the per-nucleon beam centre-of-mass.
 
LorentzTransform acmsTransform () const
 Get the Lorentz transform to the per-nucleon beam centre-of-mass.
 
- Public Member Functions inherited from Rivet::Projection
virtual std::string name () const
 Get the name of the projection.
 
 Projection ()
 The default constructor.
 
virtual unique_ptr< Projectionclone () const =0
 Clone on the heap.
 
virtual ~Projection ()
 The destructor.
 
bool before (const Projection &p) const
 
virtual const std::set< PdgIdPair > beamPairs () const
 
ProjectionaddPdgIdPair (PdgId beam1, PdgId beam2)
 
- Public Member Functions inherited from Rivet::ProjectionApplier
 ProjectionApplier ()
 Constructor.
 
void markAsOwned () const
 Mark this object as owned by a proj-handler.
 
std::set< ConstProjectionPtr > getProjections () const
 Get the contained projections, including recursion.
 
bool hasProjection (const std::string &name) const
 Does this applier have a projection registered under the name name?
 
template<typename PROJ >
const PROJ & getProjection (const std::string &name) const
 
template<typename PROJ >
const PROJ & get (const std::string &name) const
 
const ProjectiongetProjection (const std::string &name) const
 
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const Projection &proj) const
 Apply the supplied projection on event evt. More...
 
template<typename PROJ >
const PROJ & apply (const Event &evt, const Projection &proj) const
 
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const PROJ &proj) const
 Apply the supplied projection on event evt. More...
 
template<typename PROJ >
const PROJ & apply (const Event &evt, const PROJ &proj) const
 
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const std::string &name) const
 
template<typename PROJ >
const PROJ & apply (const Event &evt, const std::string &name) const
 
template<typename PROJ >
const PROJ & apply (const std::string &name, const Event &evt) const
 

Additional Inherited Members

- Protected Member Functions inherited from Rivet::Projection
LoggetLog () const
 Get a Log object based on the getName() property of the calling projection object.
 
void setName (const std::string &name)
 Used by derived classes to set their name.
 
Cmp< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
 
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
 
virtual Projectionoperator= (const Projection &)
 Block Projection copying.
 
- Protected Member Functions inherited from Rivet::ProjectionApplier
LoggetLog () const
 
ProjectionHandlergetProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
 
template<typename PROJ >
const PROJ & declareProjection (const PROJ &proj, const std::string &name)
 Register a contained projection. More...
 
template<typename PROJ >
const PROJ & declare (const PROJ &proj, const std::string &name)
 Register a contained projection (user-facing version) More...
 
template<typename PROJ >
const PROJ & declare (const std::string &name, const PROJ &proj)
 Register a contained projection (user-facing, arg-reordered version) More...
 
template<typename PROJ >
const PROJ & addProjection (const PROJ &proj, const std::string &name)
 Register a contained projection (user-facing version) More...
 

Detailed Description

Project out the incoming beams.

Member Function Documentation

◆ beamIds()

PdgIdPair Rivet::Beam::beamIds ( ) const
inline

The pair of beam particle PDG codes in the current collision

Deprecated:
Use pids(beams())

References beams(), and Rivet::pids().


The documentation for this class was generated from the following files:
  • include/Rivet/Projections/Beam.hh
  • src/Projections/Beam.cc