Rivet  1.8.3
Public Types | Public Member Functions | Protected Member Functions | List of all members
Rivet::FinalState Class Reference

Project out all final-state particles in an event. Probably the most important projection in Rivet! More...

#include <FinalState.hh>

Inheritance diagram for Rivet::FinalState:
Rivet::Projection Rivet::ProjectionApplier Rivet::LossyFinalState< ConstRandomFilter > Rivet::ChargedFinalState Rivet::ChargedLeptons Rivet::ClusteredPhotons Rivet::DISFinalState Rivet::HadronicFinalState Rivet::IdentifiedFinalState Rivet::InvMassFinalState Rivet::LeadingParticlesFinalState Rivet::LeptonClusters Rivet::LossyFinalState< FILTER > Rivet::MergedFinalState Rivet::NeutralFinalState Rivet::NonHadronicFinalState Rivet::UnstableFinalState Rivet::VetoedFinalState Rivet::VisibleFinalState Rivet::WFinder Rivet::ZFinder

Public Types

typedef Particle entity_type
typedef ParticleVector collection_type

Public Member Functions

virtual const ParticleVectorparticles () const
 Get the final-state particles.
template<typename F >
const ParticleVectorparticles (F sorter) const
 Get the final-state particles, ordered by supplied sorting function object.
const ParticleVectorparticlesByPt () const
 Get the final-state particles, ordered by decreasing $ p_T $.
const ParticleVectorparticlesByP () const
 Get the final-state particles, ordered by decreasing $ p $.
const ParticleVectorparticlesByE () const
 Get the final-state particles, ordered by decreasing $ E $.
const ParticleVectorparticlesByEt () const
 Get the final-state particles, ordered by decreasing $ E_T $.
const ParticleVectorparticlesByEta () const
 Get the final-state particles, ordered by increasing $ \eta $.
const ParticleVectorparticlesByModEta () const
 Get the final-state particles, ordered by increasing $ |\eta| $.
const ParticleVectorparticlesByRapidity () const
 Get the final-state particles, ordered by increasing $ y $.
const ParticleVectorparticlesByModRapidity () const
 Get the final-state particles, ordered by increasing $ |y| $.
virtual size_t size () const
 Access the projected final-state particles.
virtual bool empty () const
 Is this final state empty?
virtual bool isEmpty () const
virtual double ptMin () const
 Minimum- $ p_\perp $ requirement.
const collection_type & entities () const
 Template-usable interface common to JetAlg.
Standard constructors and destructors.
 FinalState (double mineta=-MAXRAPIDITY, double maxeta=MAXRAPIDITY, double minpt=0.0 *GeV)
 FinalState (const vector< pair< double, double > > &etaRanges, double minpt=0.0 *GeV)
virtual const Projectionclone () const
 Clone on the heap.
- Public Member Functions inherited from Rivet::Projection
bool before (const Projection &p) const
virtual const std::set< PdgIdPairbeamPairs () const
virtual std::string name () const
 Get the name of the projection.
ProjectionaddPdgIdPair (PdgId beam1, PdgId beam2)
 Add a colliding beam pair.
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.
 Projection ()
 The default constructor.
virtual ~Projection ()
 The destructor.
- Public Member Functions inherited from Rivet::ProjectionApplier
 ProjectionApplier ()
 Constructor.
std::set< ConstProjectionPtrgetProjections () const
 Get the contained projections, including recursion.
template<typename PROJ >
const PROJ & getProjection (const std::string &name) const
 Get the named projection, specifying return type via a template argument.
const ProjectiongetProjection (const std::string &name) const
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const PROJ &proj) const
 Apply the supplied projection on event.
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const Projection &proj) const
 Apply the supplied projection on event.
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const std::string &name) const
 Apply the named projection on event.

Protected Member Functions

virtual void project (const Event &e)
 Apply the projection to the event.
virtual int compare (const Projection &p) const
 Compare projections.
bool accept (const Particle &p) const
 Decide if a particle is to be accepted or not.
- Protected Member Functions inherited from Rivet::Projection
Cmp< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
- Protected Member Functions inherited from Rivet::ProjectionApplier
ProjectionHandlergetProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
template<typename PROJ >
const PROJ & addProjection (const PROJ &proj, const std::string &name)

Detailed Description

Project out all final-state particles in an event. Probably the most important projection in Rivet!

Constructor & Destructor Documentation

Rivet::FinalState::FinalState ( double  mineta = -MAXRAPIDITY,
double  maxeta = MAXRAPIDITY,
double  minpt = 0.0*GeV 
)
Rivet::FinalState::FinalState ( const vector< pair< double, double > > &  etaRanges,
double  minpt = 0.0*GeV 
)

A constructor which allows to specify multiple eta ranges and the min $ p_T $ (in GeV).

Todo:
Properly check whether any of these eta ranges (or their combination) are actually open

References Rivet::ProjectionApplier::addProjection(), FinalState(), Rivet::isZero(), and Rivet::Projection::setName().

Member Function Documentation

virtual bool Rivet::FinalState::isEmpty ( ) const
inlinevirtual
Deprecated:
Is this final state empty?
void Rivet::FinalState::project ( const Event e)
protectedvirtual

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