Project out all physical-but-decayed particles in an event. More...

#include <UnstableFinalState.hh>

Inheritance diagram for Rivet::UnstableParticles:

Public Member Functions
Standard constructors and destructors.
	UnstableParticles (const Cut &c=Cuts::open())
	Cut-based / default constructor.

	DEFAULT_RIVET_PROJ_CLONE (UnstableParticles)
	Clone on the heap.

Public Member Functions inherited from Rivet::FinalState
virtual int	compare (const Projection &p) const
	Compare projections.

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< Projection >	clone () 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

Projection &	addPdgIdPair (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 Projection &	getProjection (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
virtual void	project (const Event &e)
	Apply the projection to the event. More...

Protected Member Functions inherited from Rivet::Projection
Log &	getLog () 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< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const

Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const

virtual Projection &	operator= (const Projection &)
	Block Projection copying.

Protected Member Functions inherited from Rivet::ProjectionApplier
Log &	getLog () const

ProjectionHandler &	getProjHandler () 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...

Additional Inherited Members
Public Types inherited from Rivet::ParticleFinder
typedef Particle	entity_type

typedef Particles	collection_type

Detailed Description

Project out all physical-but-decayed particles in an event.

The particles returned by are unique unstable particles, such as hadrons which are decayed by the generator. If, for example, you set Ks and Lambda particles stable in the generator, they will not be returned. Also, you should be aware that all unstable particles in a decay chain are returned: if you are looking for something like the number of B hadrons in an event and there is a decay chain from e.g. B** -> B, you will count both B mesons unless you are careful to check for ancestor/descendent relations between the particles. Duplicate particles in the event record, i.e. those which differ only in bookkeeping details or photon emissions, are stripped from the returned particles collection.

Todo:

Rename header, with fallback

Convert to a general ParticleFinder since this is explicitly not a final state... but needs care

Make TauFinder inherit/use