Rivet::PromptFinalState Class Reference

Find final state particles directly connected to the hard process. More...

#include <PromptFinalState.hh>

Inheritance diagram for Rivet::PromptFinalState:

Public Member Functions
void	acceptMuonDecays (bool acc=true)
	Accept leptons from decays of prompt muons as themselves being prompt?
void	acceptTauDecays (bool acc=true)
	Accept leptons from decays of prompt taus as themselves being prompt?
void	project (const Event &e)
	Apply the projection on the supplied event.
CmpState	compare (const Projection &p) const
	Compare projections.
virtual std::string	name () const
	Get the name of the projection.
bool	valid () const
	Get the state of the projetion.
bool	failed () const
	Get the state of the projetion.
void	markAsOwned () const
	Mark this object as owned by a proj-handler.
Constructors
	PromptFinalState (TauDecaysAs taudecays=TauDecaysAs::NONPROMPT, MuDecaysAs mudecays=MuDecaysAs::NONPROMPT)
	Constructor without cuts.
	PromptFinalState (const Cut &c, TauDecaysAs taudecays=TauDecaysAs::NONPROMPT, MuDecaysAs mudecays=MuDecaysAs::NONPROMPT)
	Constructor from a cut.
	PromptFinalState (const FinalState &fsp, TauDecaysAs taudecays=TauDecaysAs::NONPROMPT, MuDecaysAs mudecays=MuDecaysAs::NONPROMPT)
	PromptFinalState (const FinalState &fsp, const Cut &c, TauDecaysAs taudecays=TauDecaysAs::NONPROMPT, MuDecaysAs mudecays=MuDecaysAs::NONPROMPT)
	RIVET_DEFAULT_PROJ_CLONE (PromptFinalState)
	Clone on the heap.
Standard constructors etc.
	RIVET_DEFAULT_PROJ_CLONE (FinalState)
	Clone on the heap.
Object lifetime management
virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap.
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	particles (const Cut &c) const
	Get the particles with selection cuts.
Particles	particles (const ParticleSelector &selector) const
	Get the particles with selection cuts via a functor.
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	rawParticles () const
Particles	particlesByPt (const Cut &c=Cuts::open()) const
Particles	particlesByPt (const ParticleSelector &selector) const
Particles	particlesByPt (double ptmin) const
Projection operation and comparison
bool	before (const Projection &p) const
Projection "getting" functions
std::set< ConstProjectionPtr >	getProjections () const
	Get the contained projections, including recursion.
std::set< ConstProjectionPtr >	getImmediateChildProjections () const
	Get the contained projections, excluding 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
template<typename PROJ>
const PROJ &	getProjectionFromDeclQueue (const std::string name) const
Projection applying functions
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.
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).

Protected Member Functions
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
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.
void	setProjectionHandler (ProjectionHandler &projectionHandler) const
Projection registration functions
template<typename PROJ>
const PROJ &	declare (const PROJ &proj, const std::string &name) const
	Register a contained projection (user-facing version).
template<typename PROJ>
const PROJ &	declare (const std::string &name, const PROJ &proj) const
	Register a contained projection (user-facing, arg-reordered version).

For JetAlg compatibility
Todo Replace with cuts() accessor virtual Cut cuts() const { return _cuts; }
const collection_type &	entities () const
	Template-usable interface common to JetAlg.
typedef Particle	entity_type
typedef Particles	collection_type

Detailed Description

Find final state particles directly connected to the hard process.

The definition of "prompt" used in Rivet is that from high-scale physics, i.e. particles directly connected to the hard process in an interaction, regardless of realistic reconstructibility of displaced vertices, etc. By construction hadrons cannot be considered prompt as they will be colour connected to other parts of the event through non-perturbative effects: this projection can return electrons, muons, photons, and exotic particles which do not have a hadron in their post-hadronization ancestor chain. Flags exist to choose whether intermediate tau or muon decays invalidate a particle's promptness.

Todo

Decide how to treat brem photons off prompt leptons – are they also prompt? "Decay" does not change the lepton PID...

Todo

Use enums for tau, mu, brem

Member Function Documentation

apply()

template<typename PROJ = Projection>

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

inlineinherited

Apply the supplied projection on event evt.

Apply the supplied projection on event evt (user-facing alias).

Referenced by Rivet::SimpleAnalysis::electrons(), Rivet::SimpleAnalysis::jets(), Rivet::SimpleAnalysis::metSignf(), Rivet::SimpleAnalysis::muons(), Rivet::SimpleAnalysis::photons(), Rivet::ALICE::V0AndTrigger::project(), Rivet::ATLAS::MinBiasTrigger::project(), Rivet::ATLAS::SumET_PB_Centrality::project(), Rivet::ATLAS::SumET_PBPB_Centrality::project(), Rivet::BeamThrust::project(), Rivet::BRAHMSCentrality::project(), Rivet::CentralityEstimator::project(), Rivet::CentralityProjection::project(), Rivet::EventMixingBase::project(), Rivet::GeneratedCentrality::project(), Rivet::GeneratedPercentileProjection::project(), Rivet::ImpactParameterProjection::project(), Rivet::LossyFinalState< FILTER >::project(), Rivet::MC_pPbMinBiasTrigger::project(), Rivet::MC_SumETFwdPbCentrality::project(), Rivet::PercentileProjection::project(), Rivet::SmearedJets::project(), Rivet::SmearedMET::project(), Rivet::SmearedParticles::project(), Rivet::Spherocity::project(), Rivet::STAR_BES_Centrality::project(), Rivet::Thrust::project(), Rivet::UserCentEstimate::project(), Rivet::SimpleAnalysis::set(), Rivet::SimpleAnalysis::taus(), Rivet::SimpleAnalysis::tracks(), Rivet::SimpleAnalysis::tracks(), and Rivet::SimpleAnalysis::vmet().

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.

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

clone()

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

pure virtualinherited

Clone on the heap.

Implements Rivet::Projection.

Implemented in Rivet::ALICE::PrimaryParticles.

compare()

CmpState Rivet::PromptFinalState::compare ( const Projection & p ) const

virtual

Compare projections.

Reimplemented from Rivet::FinalState.

References Rivet::Kin::p().

declare() [1/2]

template<typename PROJ>

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

inlineprotectedinherited

Register a contained projection (user-facing version).

Todo

Add SFINAE to require that PROJ inherit from Projection

Referenced by Rivet::CentralEtHCM::CentralEtHCM(), Rivet::CentralityEstimator::CentralityEstimator(), Rivet::ChargedLeptons::ChargedLeptons(), Rivet::ALICE::CLMultiplicity< true >::CLMultiplicity(), Rivet::DISDiffHadron::DISDiffHadron(), Rivet::DISFinalState::DISFinalState(), Rivet::DISKinematics::DISKinematics(), Rivet::DISLepton::DISLepton(), Rivet::EventMixingBase::EventMixingBase(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), 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::LossyFinalState< FILTER >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedMET::SmearedMET(), Rivet::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger<-1 >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::SimpleAnalysis::postInit(), Rivet::CentralityBinner< T, MDist >::setProjection(), and Rivet::VetoedFinalState::vetoFinalState().

declare() [2/2]

template<typename PROJ>

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

inlineprotectedinherited

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

Todo

Add SFINAE to require that PROJ inherit from Projection

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 getProjection().

Referenced by Rivet::FastJets::FastJets(), and Rivet::FastJets::FastJets().

getProjection() [1/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(), and getProjHandler().

getProjection() [2/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(), getProjectionFromDeclQueue(), getProjHandler(), and Rivet::Kin::p().

Referenced by Rivet::CentralityProjection::compare(), Rivet::SimpleAnalysis::electronsProj(), get(), Rivet::SimpleAnalysis::jetsProj(), Rivet::DISFinalState::kinematics(), Rivet::SimpleAnalysis::metProj(), Rivet::SimpleAnalysis::muonsProj(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), Rivet::SimpleAnalysis::photonsProj(), Rivet::SimpleAnalysis::tausProj(), Rivet::SimpleAnalysis::tracksProj(), Rivet::SmearedJets::truthJets(), and Rivet::SmearedParticles::truthParticles().

getProjectionFromDeclQueue()

template<typename PROJ>

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

inlineinherited

Get a named projection from this projection appliers declqueue TODO for TP: Recursion?

References MSG_ERROR.

Referenced by getProjection().

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.

References Projection().

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

References Projection().

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

name()

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

inlinevirtualinherited

Get the name of the projection.

Implements Rivet::ProjectionApplier.

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

particles() [1/6]

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

inlineinherited

Get the particles with selection cuts.

Note

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

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

particles() [2/6]

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

inlineinherited

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

inlineinherited

Get the particles with selection cuts via a functor.

Note

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

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

particles() [4/6]

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

inlineinherited

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

inlineinherited

Get the particles, ordered by supplied sorting function object

Note

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

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

particles() [6/6]

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

inlineinherited

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

inlineinherited

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(), Rivet::Cuts::open(), and particles().

particlesByPt() [2/3]

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

inlineinherited

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

inlineinherited

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

void Rivet::PromptFinalState::project ( const Event & e )

virtual

Apply the projection on the supplied event.

Reimplemented from Rivet::FinalState.

rawParticles()

Particles Rivet::ParticleFinder::rawParticles ( ) const

inlineinherited

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

setProjectionHandler()

void Rivet::ProjectionApplier::setProjectionHandler ( ProjectionHandler & projectionHandler ) const

protectedinherited

Todo

AB: Add Doxygen comment, follow surrounding coding style

---

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

• /builds/hepcedar/rivet/include/Rivet/Projections/PromptFinalState.hh