Produce a final state which only contains specified particle IDs. More...

#include <IdentifiedFinalState.hh>

Inheritance diagram for Rivet::IdentifiedFinalState:

Public Member Functions
const set< PdgId > &	acceptedIds () const
	Get the list of particle IDs to accept.

IdentifiedFinalState &	acceptId (PdgId pid)
	Add an accepted particle ID.

IdentifiedFinalState &	acceptIds (const vector< PdgId > &pids)
	Add a set of accepted particle IDs.

IdentifiedFinalState &	acceptIdPair (PdgId pid)
	Add an accepted particle ID and its antiparticle.

IdentifiedFinalState &	acceptIdPairs (const vector< PdgId > &pids)
	Add a set of accepted particle IDs and their antiparticles.

IdentifiedFinalState &	acceptNeutrinos ()
	Accept all neutrinos (convenience method).

IdentifiedFinalState &	acceptChLeptons ()
	Accept all charged leptons (convenience method).

void	reset ()
	Reset the list of particle IDs to accept.

virtual const Particles &	remainingParticles () const

void	project (const Event &e)
	Apply the projection on the supplied event.

int	compare (const Projection &p) const
	Compare projections.

Constructors
	IdentifiedFinalState (const FinalState &fsp, const vector< PdgId > &pids=vector< PdgId >())
	Constructor with a FinalState and optional list of PDG ID codes.

	IdentifiedFinalState (const vector< PdgId > &pids, const FinalState &fsp)

	IdentifiedFinalState (const FinalState &fsp, PdgId pid)
	Constructor with a FinalState and a single PDG ID code.

	IdentifiedFinalState (PdgId pid, const FinalState &fsp)

	IdentifiedFinalState (const Cut &c=Cuts::open(), const vector< PdgId > &pids=vector< PdgId >())
	Construction using optional Cuts object and optional list of PDG ID codes.

	IdentifiedFinalState (const vector< PdgId > &pids, const Cut &c=Cuts::open())
	Construction using list of PDG ID codes and an optional Cuts object.

	IdentifiedFinalState (const Cut &c, PdgId pid)
	Construction using Cuts object and a single PDG ID code.

	IdentifiedFinalState (PdgId pid, const Cut &c=Cuts::open())
	Construction using a single PDG ID code and an optional Cuts object.

	DEFAULT_RIVET_PROJ_CLONE (IdentifiedFinalState)
	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< 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

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

typedef Particles	collection_type

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...

Detailed Description

Produce a final state which only contains specified particle IDs.

Constructor & Destructor Documentation

◆ IdentifiedFinalState() [1/2]

Rivet::IdentifiedFinalState::IdentifiedFinalState	(	const vector< PdgId > &	pids,
		const FinalState &	fsp
	)

Constructor with a list of PDG ID codes and a FinalState

Deprecated:: Use the version with FinalState as 1st arg

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

◆ IdentifiedFinalState() [2/2]

Rivet::IdentifiedFinalState::IdentifiedFinalState	(	PdgId	pid,
		const FinalState &	fsp
	)

Constructor with a single PDG ID code and a FinalState.

Deprecated:: Use the version with FinalState as 1st arg

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

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IdentifiedFinalState() [1/2]

◆ IdentifiedFinalState() [2/2]