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:

Public Types
typedef Particle	entity_type
typedef ParticleVector	collection_type
Public Member Functions
virtual const ParticleVector &	particles () const
	Get the final-state particles.
template<typename F >
const ParticleVector &	particles (F sorter) const
	Get the final-state particles, ordered by supplied sorting function object.
const ParticleVector &	particlesByPt () const
	Get the final-state particles, ordered by decreasing .
const ParticleVector &	particlesByP () const
	Get the final-state particles, ordered by decreasing .
const ParticleVector &	particlesByE () const
	Get the final-state particles, ordered by decreasing .
const ParticleVector &	particlesByEt () const
	Get the final-state particles, ordered by decreasing .
const ParticleVector &	particlesByEta () const
	Get the final-state particles, ordered by increasing $\eta$ .
const ParticleVector &	particlesByModEta () const
	Get the final-state particles, ordered by increasing $\|\eta\|$ .
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 Projection *	clone () const
	Clone on the heap.
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.

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`
	)

The default constructor. May specify the minimum and maximum pseudorapidity $\eta$ and the min $ p_T $ (in GeV).

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

Referenced by Rivet::ChargedFinalState::ChargedFinalState(), clone(), FinalState(), Rivet::IdentifiedFinalState::IdentifiedFinalState(), Rivet::LossyFinalState< ConstRandomFilter >::LossyFinalState(), Rivet::VetoedFinalState::VetoedFinalState(), and Rivet::VisibleFinalState::VisibleFinalState().

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 [inline, virtual]

Deprecated:: Is this final state empty?

void Rivet::FinalState::project ( const Event & e ) [protected, virtual]

Apply the projection to the event.

Todo:: In general, we'd like to calculate a restrictive FS based on the most restricted superset FS.

Implements Rivet::Projection.

Reimplemented in Rivet::VetoedFinalState, Rivet::WFinder, Rivet::IdentifiedFinalState, Rivet::ZFinder, Rivet::InvMassFinalState, Rivet::LeadingParticlesFinalState, Rivet::LeptonClusters, Rivet::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::UnstableFinalState, Rivet::VisibleFinalState, Rivet::ClusteredPhotons, Rivet::NeutralFinalState, Rivet::ChargedFinalState, Rivet::DISFinalState, Rivet::HadronicFinalState, Rivet::NonHadronicFinalState, Rivet::MergedFinalState, and Rivet::ChargedLeptons.

References accept(), Rivet::Event::genEvent(), and particles().

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

include/Rivet/Projections/FinalState.hh
src/Projections/FinalState.cc

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation