Rivet::ParticleFinder Class Reference

Base class for projections which return subsets of an event's particles. More...

#include <ParticleFinder.hh>

Inheritance diagram for Rivet::ParticleFinder:

Public Member Functions
Object lifetime management
	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. More...
Particle accessors
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
Standard constructors and destructors.
virtual std::string	name () const
	Get the name of the projection. More...
bool	valid () const
	Get the state of the projetion.
bool	failed () const
	Get the state of the projetion.
Projection operation and comparison
bool	before (const Projection &p) const
Projection "getting" functions
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
const Projection &	getProjection (const std::string &name) const
template<typename PROJ >
const PROJ &	get (const std::string &name) const

Protected Member Functions
Projection registration functions
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...

For JetAlg compatibility
Todo: Replace with cuts() accessor virtual Cut cuts() const { return _cuts; }
typedef Particle	entity_type
typedef Particles	collection_type
const collection_type &	entities () const
	Template-usable interface common to JetAlg.
virtual void	project (const Event &e)=0
	Apply the projection to the event. More...
virtual CmpState	compare (const Projection &p) const
	Compare projections. More...

Beam configuration
Todo: Does it really make sense to restrict Projections to particular beam configs? Do we use this in practice?
virtual const std::set< PdgIdPair >	beamPairs () const
Projection &	addPdgIdPair (PdgId beam1, PdgId beam2)
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.
void	fail ()
	Set the projection in an unvalid state.
Cmp< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const

Projection applying functions
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	applyProjection (const Event &evt, const Projection &proj) const
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	applyProjection (const Event &evt, const PROJ &proj) const
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	applyProjection (const Event &evt, const std::string &name) const
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	apply (const Event &evt, const Projection &proj) const
	Apply the supplied projection on event evt (user-facing alias).
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	apply (const Event &evt, const PROJ &proj) const
	Apply the supplied projection on event evt (user-facing alias).
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	apply (const Event &evt, const std::string &name) const
	Apply the supplied projection on event evt (user-facing alias).
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	apply (const std::string &name, const Event &evt) const
	Apply the supplied projection on event evt (convenience arg-reordering alias).
void	markAsOwned () const
	Mark this object as owned by a proj-handler.
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.

Detailed Description

Base class for projections which return subsets of an event's particles.

Member Function Documentation

addPdgIdPair()

Projection & Rivet::Projection::addPdgIdPair ( PdgId  beam1, PdgId  beam2  )

inlineinherited

Add a colliding beam pair.

Todo:

This deserves a better name!

applyProjection() [1/3]

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event &  evt, const PROJ &  proj  ) const

inlineinherited

Apply the supplied projection on event evt.

Deprecated:

Prefer the simpler apply<> form

applyProjection() [2/3]

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event &  evt, const Projection &  proj  ) const

inlineinherited

Apply the supplied projection on event evt.

Deprecated:

Prefer the simpler apply<> form

applyProjection() [3/3]

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event &  evt, const std::string &  name  ) const

inlineinherited

Apply the named projection on event evt.

Deprecated:

Prefer the simpler apply<> form

References Rivet::ProjectionApplier::name().

beamPairs()

virtual const std::set< PdgIdPair > Rivet::Projection::beamPairs ( ) const

virtualinherited

Return the allowed beam pairs on which this projection can operate, not including recursion. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.

Todo:

Remove the beam constraints system from projections.

before()

bool Rivet::Projection::before ( const Projection &  p ) const

inherited

Determine whether this object should be ordered before the object p given as argument. If p is of a different class than this, the before() function of the corresponding type_info objects is used. Otherwise, if the objects are of the same class, the virtual compare(const Projection &) will be returned.

clone()

virtual unique_ptr< Projection > Rivet::ParticleFinder::clone ( ) const

pure virtual

Clone on the heap.

Implements Rivet::Projection.

Implemented in Rivet::ALICE::PrimaryParticles.

compare()

virtual CmpState Rivet::ParticleFinder::compare ( const Projection &  p ) const

virtual

Compare projections.

Implements Rivet::Projection.

Reimplemented in Rivet::ChargedLeptons, Rivet::ALICE::PrimaryParticles, Rivet::ChargedFinalState, Rivet::DISFinalState, Rivet::DISLepton, Rivet::DressedLeptons, Rivet::FinalState, Rivet::GammaGammaFinalState, Rivet::HadronicFinalState, Rivet::HeavyHadrons, Rivet::IdentifiedFinalState, Rivet::InvisibleFinalState, Rivet::InvMassFinalState, Rivet::LeadingParticlesFinalState, Rivet::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::MergedFinalState, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::PartonicTops, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::SmearedParticles, Rivet::TauFinder, Rivet::VetoedFinalState, Rivet::VisibleFinalState, Rivet::WFinder, and Rivet::ZFinder.

declare() [1/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declare ( const PROJ &  proj, const std::string &  name  )

inlineprotectedinherited

Register a contained projection (user-facing version)

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name().

Referenced by Rivet::CentralEtHCM::CentralEtHCM(), Rivet::CentralityEstimator::CentralityEstimator(), Rivet::ChargedLeptons::ChargedLeptons(), Rivet::ALICE::CLMultiplicity< INNER >::CLMultiplicity(), Rivet::DISDiffHadron::DISDiffHadron(), Rivet::DISFinalState::DISFinalState(), Rivet::DISKinematics::DISKinematics(), Rivet::DISLepton::DISLepton(), Rivet::GammaGammaFinalState::GammaGammaFinalState(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), Rivet::GeneratedCentrality::GeneratedCentrality(), Rivet::HadronicFinalState::HadronicFinalState(), Rivet::HeavyHadrons::HeavyHadrons(), Rivet::Hemispheres::Hemispheres(), Rivet::InvisibleFinalState::InvisibleFinalState(), Rivet::LeadingParticlesFinalState::LeadingParticlesFinalState(), Rivet::LossyFinalState< FILTER >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::SmearedJets::SmearedJets(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedParticles::SmearedParticles(), Rivet::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), Rivet::TauFinder::TauFinder(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger< MODE >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), and Rivet::CentralityBinner< T, MDist >::setProjection().

declare() [2/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declare ( const std::string &  name, const PROJ &  proj  )

inlineprotectedinherited

Register a contained projection (user-facing, arg-reordered version)

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name().

declareProjection()

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declareProjection ( const PROJ &  proj, const std::string &  name  )

inlineprotectedinherited

Register a contained projection.

The type of the argument is used to instantiate a new projection internally: this new object is applied to events rather than the argument object. Hence you are advised to only use locally-scoped Projection objects in your Projection and Analysis constructors, and to avoid polymorphism (e.g. handling ConcreteProjection via a pointer or reference to type Projection) since this will screw up the internal type management.

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::name().

Referenced by Rivet::ProjectionApplier::declare().

get()

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::get ( const std::string &  name ) const

inlineinherited

Get the named projection, specifying return type via a template argument (user-facing alias).

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::name().

getProjection() [1/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::getProjection ( const std::string &  name ) const

inlineinherited

Get the named projection, specifying return type via a template argument.

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionHandler::getProjection(), Rivet::ProjectionApplier::getProjHandler(), Rivet::ProjectionApplier::name(), and Rivet::Kin::p().

Referenced by Rivet::CentralityProjection::compare(), and Rivet::pcmp().

getProjection() [2/2]

const Projection & Rivet::ProjectionApplier::getProjection ( const std::string &  name ) const

inlineinherited

Get the named projection (non-templated, so returns as a reference to a Projection base class).

References Rivet::ProjectionHandler::getProjection(), Rivet::ProjectionApplier::getProjHandler(), and Rivet::ProjectionApplier::name().

mkNamedPCmp()

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

protectedinherited

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Referenced by Rivet::MC_SumETFwdPbCentrality::compare(), Rivet::MC_pPbMinBiasTrigger::compare(), Rivet::BeamThrust::compare(), Rivet::CentralEtHCM::compare(), Rivet::DISFinalState::compare(), Rivet::EventMixingBase::compare(), Rivet::FParameter::compare(), Rivet::GammaGammaFinalState::compare(), Rivet::HeavyHadrons::compare(), Rivet::Hemispheres::compare(), Rivet::LossyFinalState< FILTER >::compare(), Rivet::PercentileProjection::compare(), Rivet::Spherocity::compare(), Rivet::Thrust::compare(), Rivet::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::ATLAS::MinBiasTrigger::compare(), Rivet::CentralityEstimator::compare(), Rivet::GeneratedCentrality::compare(), Rivet::STAR_BES_Centrality::compare(), and Rivet::BRAHMSCentrality::compare().

mkPCmp()

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

protectedinherited

Shortcut to make a named Cmp<Projection> comparison with the *this object automatically passed as one of the parent projections.

Note

Alias for mkNamedPCmp

Referenced by Rivet::ALICE::PrimaryParticles::compare(), Rivet::SmearedJets::compare(), Rivet::SmearedMET::compare(), Rivet::SmearedParticles::compare(), and Rivet::Correlators::compare().

name()

virtual std::string Rivet::Projection::name ( ) const

inlinevirtualinherited

Get the name of the projection.

Implements Rivet::ProjectionApplier.

Referenced by Rivet::VetoedFinalState::addVetoOnThisFinalState(), Rivet::Projection::getLog(), and Rivet::Projection::setName().

particles() [1/6]

Particles Rivet::ParticleFinder::particles ( const Cut &  c ) const

inline

Get the particles with selection cuts.

Note

Returns a copy rather than a reference, due to the cuts.

References Rivet::filter_select(), and particles().

particles() [2/6]

Particles Rivet::ParticleFinder::particles ( const Cut &  c, const ParticleSorter &  sorter  ) const

inline

Get the particles, ordered by supplied sorting function object

Note

Returns a copy rather than a reference, due to cuts and sorting.

References particles(), and Rivet::sortBy().

particles() [3/6]

Particles Rivet::ParticleFinder::particles ( const ParticleSelector &  selector ) const

inline

Get the particles with selection cuts via a functor.

Note

Returns a copy rather than a reference, due to the cuts.

References Rivet::filter_select(), and particles().

particles() [4/6]

Particles Rivet::ParticleFinder::particles ( const ParticleSelector &  selector, const ParticleSorter &  sorter  ) const

inline

Get the particles, ordered by a sorting functor and filtered by a selection functor

Note

Returns a copy rather than a reference, due to cuts and sorting.

References particles(), and Rivet::sortBy().

particles() [5/6]

Particles Rivet::ParticleFinder::particles ( const ParticleSorter &  sorter, const Cut &  c = Cuts::open()  ) const

inline

Get the particles, ordered by supplied sorting function object

Note

Returns a copy rather than a reference, due to cuts and sorting.

References particles(), and Rivet::sortBy().

particles() [6/6]

Particles Rivet::ParticleFinder::particles ( const ParticleSorter &  sorter, const ParticleSelector &  selector  ) const

inline

Get the particles, ordered by a sorting functor and filtered by a selection functor

Note

Returns a copy rather than a reference, due to cuts and sorting.

References particles(), and Rivet::sortBy().

particlesByPt() [1/3]

Particles Rivet::ParticleFinder::particlesByPt ( const Cut &  c = Cuts::open() ) const

inline

Get the particles, ordered by decreasing \( p_T \) and with optional cuts

This is a very common use-case, so is available as syntatic sugar for particles(c, cmpMomByPt).

References Rivet::cmpMomByPt(), and particles().

particlesByPt() [2/3]

Particles Rivet::ParticleFinder::particlesByPt ( const ParticleSelector &  selector ) const

inline

Get the particles, ordered by decreasing \( p_T \) and with optional cuts

This is a very common use-case, so is available as syntatic sugar for particles(f, cmpMomByPt).

References Rivet::cmpMomByPt(), and particles().

particlesByPt() [3/3]

Particles Rivet::ParticleFinder::particlesByPt ( double  ptmin ) const

inline

Get the particles, ordered by decreasing \( p_T \) and with a cut on minimum \( p_T \)

This is a very common use-case, so is available as syntatic sugar for particles(Cuts::pT >= ptmin, cmpMomByPt).

References Rivet::cmpMomByPt(), and particles().

project()

virtual void Rivet::ParticleFinder::project ( const Event &  e )

pure virtual

Apply the projection to the event.

Implements Rivet::Projection.

Implemented in Rivet::ChargedFinalState, Rivet::DISFinalState, Rivet::DISLepton, Rivet::DressedLeptons, Rivet::FinalPartons, Rivet::FinalState, Rivet::GammaGammaFinalState, Rivet::HadronicFinalState, Rivet::HeavyHadrons, Rivet::IdentifiedFinalState, Rivet::InvisibleFinalState, Rivet::InvMassFinalState, Rivet::LeadingParticlesFinalState, Rivet::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::MergedFinalState, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::PrimaryHadrons, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::SmearedParticles, Rivet::TauFinder, Rivet::UnstableParticles, Rivet::VetoedFinalState, Rivet::VisibleFinalState, Rivet::WFinder, Rivet::ZFinder, Rivet::PartonicTops, and Rivet::ChargedLeptons.

rawParticles()

Particles Rivet::ParticleFinder::rawParticles ( ) const

inline

Get the raw particles in no particular order, with no cuts

Note

Raw particles are the final-state constituents, as opposed to potentially composite particles returned as the finder's particles()

References Rivet::Kin::p(), and particles().

---

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

• /Users/chrisg/software/rivet/include/Rivet/Projections/ParticleFinder.hh