rivet is hosted by Hepforge, IPPP Durham
Rivet 4.0.0
Rivet::HadronicFinalState Class Referenceabstract

Project only hadronic final state particles. More...

#include <HadronicFinalState.hh>

Inheritance diagram for Rivet::HadronicFinalState:
Rivet::FinalState Rivet::ParticleFinder Rivet::Projection Rivet::ProjectionApplier

Public Member Functions

 HadronicFinalState (const FinalState &fsp)
 Constructor: the supplied FinalState projection is assumed to live through the run.
 
 HadronicFinalState (const Cut &c=Cuts::open())
 
 RIVET_DEFAULT_PROJ_CLONE (HadronicFinalState)
 Clone on the heap.
 
virtual bool accept (const Particle &p) 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.
 RIVET_DEFAULT_PROJ_CLONE (FinalState)
 Clone on the heap.
 
Object lifetime management
virtual unique_ptr< Projectionclone () 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 Particlesparticles () 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 ProjectiongetProjection (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

void project (const Event &e)
 Apply the projection on the supplied event.
 
CmpState compare (const Projection &p) const
 Compare projections.
 
LoggetLog () 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< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
 
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
 
ProjectionHandlergetProjHandler () 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_typeentities () const
 Template-usable interface common to JetAlg.
 
typedef Particle entity_type
 
typedef Particles collection_type
 

Detailed Description

Project only hadronic final state particles.

Member Function Documentation

◆ accept()

virtual bool Rivet::FinalState::accept ( const Particle p) const
virtualinherited

Decide if a particle is to be accepted or not.

Todo:
Rename to _accept or acceptFinal?

Reimplemented in Rivet::FinalPartons.

◆ 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::ParticleFinder::clone ( ) const
pure virtualinherited

Clone on the heap.

Implements Rivet::Projection.

Implemented in Rivet::ALICE::PrimaryParticles.

◆ compare()

CmpState Rivet::HadronicFinalState::compare ( const Projection p) const
protectedvirtual

Compare projections.

Reimplemented from Rivet::FinalState.

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

◆ 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

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

◆ project()

void Rivet::HadronicFinalState::project ( const Event e)
protectedvirtual

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::ParticleFinder::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: