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

Final state particles boosted to the hadronic center of mass system. More...

#include <DISFinalState.hh>

Inheritance diagram for Rivet::DISFinalState:
Rivet::FinalState Rivet::ParticleFinder Rivet::Projection Rivet::ProjectionApplier

Public Types

enum  BoostType { HCM, BREIT, LAB }
 Type of DIS boost to apply.
 
- Public Types inherited from Rivet::ParticleFinder
typedef Particle entity_type
 
typedef Particles collection_type
 

Public Member Functions

Constructors
 DISFinalState (const FinalState &fs, BoostType boosttype, const DISKinematics &kinematicsp=DISKinematics())
 
 DISFinalState (BoostType boosttype, const FinalState &fs=FinalState(), const DISKinematics &kinematicsp=DISKinematics())
 
 DISFinalState (const Cut &c, BoostType boosttype, const DISKinematics &kinematicsp=DISKinematics())
 
 DISFinalState (BoostType boosttype, const Cut &c, const DISKinematics &kinematicsp=DISKinematics())
 
 DISFinalState (const DISKinematics &kinematicsp, BoostType boosttype)
 
 DEFAULT_RIVET_PROJ_CLONE (DISFinalState)
 Clone on the heap.
 
- Public Member Functions inherited from Rivet::FinalState
virtual bool accept (const Particle &p) const
 Decide if a particle is to be accepted or not. More...
 
 FinalState (const Cut &c=Cuts::open())
 Construction using Cuts object.
 
 FinalState (const FinalState &fsp, const Cut &c)
 Construction using another FinalState and a Cuts object.
 
 FinalState (double mineta, double maxeta, double minpt=0.0 *GeV)
 
 DEFAULT_RIVET_PROJ_CLONE (FinalState)
 Clone on the heap.
 
- Public Member Functions inherited from Rivet::ParticleFinder
 ParticleFinder (const Cut &c=Cuts::OPEN)
 Construction using Cuts object.
 
virtual ~ParticleFinder ()
 Virtual destructor for inheritance.
 
virtual unique_ptr< Projectionclone () const =0
 Clone on the heap.
 
size_t size () const
 Count the final-state particles.
 
size_t size (const Cut &c) const
 Count the final-state particles after a Cut is applied.
 
size_t size (const ParticleSelector &s) const
 Count the final-state particles after a selection functor is applied.
 
bool empty () const
 Is this final state empty?
 
bool empty (const Cut &c) const
 Is this final state empty after a Cut is applied?
 
bool empty (const ParticleSelector &s) const
 Is this final state empty after a selection functor is applied?
 
virtual const Particles & particles () const
 Get the particles in no particular order, with no cuts.
 
Particles rawParticles () const
 
Particles particles (const Cut &c) const
 Get the particles with selection cuts. More...
 
Particles particles (const ParticleSelector &selector) const
 Get the particles with selection cuts via a functor. More...
 
Particles particles (const ParticleSorter &sorter, const Cut &c=Cuts::open()) const
 
Particles particles (const Cut &c, const ParticleSorter &sorter) const
 
Particles particles (const ParticleSelector &selector, const ParticleSorter &sorter) const
 
Particles particles (const ParticleSorter &sorter, const ParticleSelector &selector) const
 
Particles particlesByPt (const Cut &c=Cuts::open()) const
 
Particles particlesByPt (const ParticleSelector &selector) const
 
Particles particlesByPt (double ptmin) const
 
const collection_type & entities () const
 Template-usable interface common to JetAlg.
 
- Public Member Functions inherited from Rivet::Projection
virtual std::string name () const
 Get the name of the projection.
 
 Projection ()
 The default constructor.
 
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
 

Protected Member Functions

void project (const Event &e)
 Apply the projection on the supplied event. More...
 
int compare (const Projection &p) const
 Compare projections.
 
- 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

Final state particles boosted to the hadronic center of mass system.

NB. The DIS scattered lepton is not included in the final state particles.

Constructor & Destructor Documentation

◆ DISFinalState() [1/5]

Rivet::DISFinalState::DISFinalState ( const FinalState fs,
BoostType  boosttype,
const DISKinematics kinematicsp = DISKinematics() 
)
inline

Constructor with explicit FinalState

Note
The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn't be necessary.

References Rivet::ProjectionApplier::declare(), and Rivet::Projection::setName().

◆ DISFinalState() [2/5]

Rivet::DISFinalState::DISFinalState ( BoostType  boosttype,
const FinalState fs = FinalState(),
const DISKinematics kinematicsp = DISKinematics() 
)
inline

Constructor with optional FinalState

Note
The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn't be necessary.

◆ DISFinalState() [3/5]

Rivet::DISFinalState::DISFinalState ( const Cut &  c,
BoostType  boosttype,
const DISKinematics kinematicsp = DISKinematics() 
)
inline

Constructor with explicit cuts to define final-state particles

Note
The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn't be necessary.

◆ DISFinalState() [4/5]

Rivet::DISFinalState::DISFinalState ( BoostType  boosttype,
const Cut &  c,
const DISKinematics kinematicsp = DISKinematics() 
)
inline

Constructor with explicit cuts to define final-state particles

Note
The DISKinematics has no parameters, hence explicitly passing it as an arg shouldn't be necessary.

◆ DISFinalState() [5/5]

Rivet::DISFinalState::DISFinalState ( const DISKinematics kinematicsp,
BoostType  boosttype 
)
inline

Backward compatible constructor with default FinalState

Deprecated:
Prefer a version that doesn't need a DISKinematics argument

References DEFAULT_RIVET_PROJ_CLONE(), and project().

Member Function Documentation

◆ project()

void Rivet::DISFinalState::project ( const Event e)
protectedvirtual

The documentation for this class was generated from the following files: