Rivet::DecayedParticles Class Reference

Find the decay products of particles in the projection for subsquent analyses. More...

#include <DecayedParticles.hh>

Inheritance diagram for Rivet::DecayedParticles:

Public Member Functions
DecayedParticles &	addStable (PdgId pid)
	Add a particle to be considered stable when finding the decay products.
const Particles &	decaying () const
const vector< unsigned int > &	nStable () const
const vector< map< PdgId, Particles > > &	decayProducts () const
bool	modeMatches (size_t imode, unsigned int nstable, map< PdgId, unsigned int > prod) const
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.
Standard constructors etc.
	DecayedParticles ()
	Constructor.
	DecayedParticles (const ParticleFinder &particles)
	RIVET_DEFAULT_PROJ_CLONE (DecayedParticles)
	Clone on the heap.
virtual	~DecayedParticles ()
	Virtual destructor.
virtual Projection &	operator= (const Projection &)=delete
	Import to avoid warnings about overload-hiding.
Standard constructors and destructors.
virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap.
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
virtual void	project (const Event &e)
	Apply the projection to the event.
virtual CmpState	compare (const Projection &p) const
	Compare projections.
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)

Detailed Description

Find the decay products of particles in the projection for subsquent analyses.

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::ALICE::V0Trigger< MODE >::project().

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

pure virtualinherited

Clone on the heap.

Implemented in Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0AndTrigger, Rivet::ALICE::PrimaryParticles, Rivet::AxesDefinition, Rivet::JetFinder, and Rivet::ParticleFinder.

compare()

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

protectedvirtual

Compare projections.

Implements Rivet::Projection.

decaying()

const Particles & Rivet::DecayedParticles::decaying ( ) const

inline

Access to the decaying particles

decayProducts()

const vector< map< PdgId, Particles > > & Rivet::DecayedParticles::decayProducts ( ) const

inline

Access to the decay products

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< INNER >::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::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::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), 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

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(), and Rivet::ProjectionApplier::getProjHandler().

Referenced by Rivet::CentralityProjection::compare(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), 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(), and Rivet::ProjectionApplier::getProjHandler().

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.

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::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::ATLAS::MinBiasTrigger::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::STAR_BES_Centrality::compare(), Rivet::BRAHMSCentrality::compare(), Rivet::Spherocity::compare(), Rivet::Thrust::compare(), Rivet::CentralityEstimator::compare(), and Rivet::GeneratedCentrality::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().

modeMatches()

bool Rivet::DecayedParticles::modeMatches ( size_t  imode, unsigned int  nstable, map< PdgId, unsigned int >  prod  ) const

inline

Check the particles in the ith mode

name()

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

inlinevirtualinherited

Get the name of the projection.

Implements Rivet::ProjectionApplier.

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

nStable()

const vector< unsigned int > & Rivet::DecayedParticles::nStable ( ) const

inline

Access to the number of stable particles

operator=()

virtual Projection & Rivet::Projection::operator= ( const Projection &  )

virtualdelete

Import to avoid warnings about overload-hiding.

Reimplemented from Rivet::Projection.

project()

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

protectedvirtual

Apply the projection to the event.

Implements Rivet::Projection.

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:

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