rivet is hosted by Hepforge, IPPP Durham
Rivet  3.1.0

Abstract base class for projections which can return a set of Jets. More...

#include <JetFinder.hh>

Inheritance diagram for Rivet::JetFinder:
Rivet::Projection Rivet::ProjectionApplier Rivet::FastJets Rivet::SmearedJets

Public Types

enum  Muons { NONE, DECAY, ALL }
 Enum for the treatment of muons: whether to include all, some, or none in jet-finding.
 
enum  Invisibles { NONE, DECAY, ALL }
 Enum for the treatment of invisible particles: whether to include all, some, or none in jet-finding.
 
typedef Jet entity_type
 
typedef Jets collection_type
 

Public Member Functions

 JetFinder (const FinalState &fs, Muons usemuons=Muons::ALL, Invisibles useinvis=Invisibles::NONE)
 Constructor.
 
 JetFinder ()=default
 Default constructor.
 
virtual unique_ptr< Projectionclone () const =0
 Clone on the heap.
 
virtual ~JetFinder ()=default
 Destructor.
 
size_t size () const
 Count the jets.
 
size_t size (const Cut &c) const
 Count the jets after a Cut is applied.
 
size_t size (const JetSelector &s) const
 Count the jets after a selection functor is applied.
 
bool empty () const
 Is this jet finder empty?
 
bool empty (const Cut &c) const
 Is this jet finder empty after a Cut is applied?
 
bool empty (const JetSelector &s) const
 Is this jet finder empty after a selection functor is applied?
 
virtual void reset ()=0
 Clear the projection.
 
collection_type entities () const
 Template-usable interface common to FinalState.
 
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.
 
Control the treatment of muons and invisible particles

Since MC-based jet calibration (and/or particle flow) can add back in particles that weren't seen in calorimeters/trackers.

void useMuons (Muons usemuons=Muons::ALL)
 Include (some) muons in jet construction. More...
 
void useInvisibles (Invisibles useinvis=Invisibles::DECAY)
 Include (some) invisible particles in jet construction. More...
 
void useInvisibles (bool useinvis)
 obsolete chooser
 
Access to jet objects
virtual Jets jets (const Cut &c=Cuts::open()) const
 
virtual Jets jets (const JetSelector &selector) const
 
Jets jets (const Cut &c, const JetSorter &sorter) const
 
Jets jets (const JetSorter &sorter, const Cut &c=Cuts::open()) const
 
Jets jets (const JetSelector &selector, const JetSorter &sorter) const
 
Jets jets (const JetSorter &sorter, const JetSelector selector) const
 
Jets jetsByPt (const Cut &c=Cuts::open()) const
 
Jets jetsByPt (const JetSelector &selector) const
 
Jets jetsByPt (double ptmin) const
 
Projection operation and comparison
bool before (const Projection &p) const
 
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
 
ProjectionaddPdgIdPair (PdgId beam1, PdgId beam2)
 
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 ProjectiongetProjection (const std::string &name) const
 
template<typename PROJ >
const PROJ & get (const std::string &name) const
 
Projection applying functions
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 & applyProjection (const Event &evt, const PROJ &proj) const
 Apply the supplied projection on event evt. More...
 
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const std::string &name) const
 
template<typename PROJ >
const PROJ & apply (const Event &evt, const Projection &proj) const
 
template<typename PROJ >
const PROJ & apply (const Event &evt, const PROJ &proj) 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
 

Protected Member Functions

virtual void project (const Event &e)=0
 Perform the projection on the Event.
 
virtual CmpState compare (const Projection &p) const =0
 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.
 
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...
 

Detailed Description

Abstract base class for projections which can return a set of Jets.

Member Function Documentation

◆ addPdgIdPair()

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

Add a colliding beam pair.

Todo:
This deserves a better name!

◆ apply() [1/4]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::apply ( const Event evt,
const Projection proj 
) const
inlineinherited

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

Todo:
Add SFINAE to require that PROJ inherit from Projection

Referenced by Rivet::ALICE::V0Trigger< MODE >::project().

◆ apply() [2/4]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::apply ( const Event evt,
const PROJ &  proj 
) const
inlineinherited

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

Todo:
Add SFINAE to require that PROJ inherit from Projection

◆ apply() [3/4]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::apply ( const Event evt,
const std::string &  name 
) const
inlineinherited

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

Todo:
Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::name().

◆ apply() [4/4]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::apply ( const std::string &  name,
const Event evt 
) const
inlineinherited

Apply the supplied projection on event evt (convenience arg-reordering alias).

Todo:
Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::name().

◆ applyProjection() [1/3]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::applyProjection ( const Event evt,
const Projection proj 
) const
inlineinherited

Apply the supplied projection on event evt.

Todo:
Add SFINAE to require that PROJ inherit from Projection

◆ applyProjection() [2/3]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::applyProjection ( const Event evt,
const PROJ &  proj 
) const
inlineinherited

Apply the supplied projection on event evt.

Todo:
Add SFINAE to require that PROJ inherit from Projection

◆ applyProjection() [3/3]

template<typename PROJ >
const PROJ& Rivet::ProjectionApplier::applyProjection ( const Event evt,
const std::string &  name 
) const
inlineinherited

Apply the named projection on event evt.

Todo:
Add SFINAE to require that PROJ inherit from Projection

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

Referenced by Rivet::Projection::failed().

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

Referenced by Rivet::Projection::fail(), and Rivet::Projection::failed().

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

Referenced by Rivet::CentralityProjection::add(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), Rivet::BeamThrust::BeamThrust(), 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::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), Rivet::GeneratedCentrality::GeneratedCentrality(), Rivet::HadronicFinalState::HadronicFinalState(), Rivet::HeavyHadrons::HeavyHadrons(), Rivet::Hemispheres::Hemispheres(), Rivet::LeadingParticlesFinalState::LeadingParticlesFinalState(), Rivet::LossyFinalState< ConstRandomFilter >::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::CentralityBinner< T, MDist >::setProjection(), 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::Thrust::Thrust(), Rivet::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger< MODE >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), and Rivet::VisibleFinalState::VisibleFinalState().

◆ 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

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

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

◆ jets() [1/6]

virtual Jets Rivet::JetFinder::jets ( const Cut &  c = Cuts::open()) const
inlinevirtual

Get jets in no guaranteed order, with an optional Cut

Note
Returns a copy rather than a reference, due to cuts

References Rivet::filter_select().

Referenced by entities(), jets(), jetsByPt(), and size().

◆ jets() [2/6]

virtual Jets Rivet::JetFinder::jets ( const JetSelector selector) const
inlinevirtual

Get jets in no guaranteed order, with a selection functor

Note
Returns a copy rather than a reference, due to cuts

References Rivet::filter_select().

◆ jets() [3/6]

Jets Rivet::JetFinder::jets ( const Cut &  c,
const JetSorter sorter 
) const
inline

Get the jets with a Cut applied, and ordered by supplied sorting functor

Note
Returns a copy rather than a reference, due to cuts and sorting
Todo:
Will the vector be efficiently std::move'd by value through this function chain?

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

◆ jets() [4/6]

Jets Rivet::JetFinder::jets ( const JetSorter sorter,
const Cut &  c = Cuts::open() 
) const
inline

Get the jets, ordered by supplied sorting functor, with an optional Cut

Note
Returns a copy rather than a reference, due to cuts and sorting
Todo:
Will the vector be efficiently std::move'd by value through this function chain?

References jets().

◆ jets() [5/6]

Jets Rivet::JetFinder::jets ( const JetSelector selector,
const JetSorter sorter 
) const
inline

Get the jets, ordered by supplied sorting function object, with optional cuts on \( p_\perp \) and rapidity.

Note
Returns a copy rather than a reference, due to cuts and sorting
Todo:
Will the vector be efficiently std::move'd by value through this function chain?

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

◆ jets() [6/6]

Jets Rivet::JetFinder::jets ( const JetSorter sorter,
const JetSelector  selector 
) const
inline

Get the jets, ordered by supplied sorting functor and with a selection functor applied

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

References jets().

◆ jetsByPt() [1/3]

Jets Rivet::JetFinder::jetsByPt ( const Cut &  c = Cuts::open()) const
inline

Get the jets, ordered by \( p_T \), with optional cuts.

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

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

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

Referenced by Rivet::SmearedJets::project(), and Rivet::SmearedJets::truthJets().

◆ jetsByPt() [2/3]

Jets Rivet::JetFinder::jetsByPt ( const JetSelector selector) const
inline

Get the jets, ordered by \( p_T \), with cuts via a selection functor.

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

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

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

◆ jetsByPt() [3/3]

Jets Rivet::JetFinder::jetsByPt ( double  ptmin) const
inline

Get the jets, ordered by \( p_T \), with a cut on \( p_\perp \).

Deprecated:
Use the version with a Cut argument
Note
Returns a copy rather than a reference, due to cuts and sorting

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

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

◆ 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::SmearedMET::compare(), Rivet::SmearedParticles::compare(), Rivet::SmearedJets::compare(), Rivet::Correlators::compare(), Rivet::ALICE::PrimaryParticles::compare(), and Rivet::Projection::fail().

◆ useInvisibles()

void Rivet::JetFinder::useInvisibles ( Invisibles  useinvis = Invisibles::DECAY)
inline

Include (some) invisible particles in jet construction.

The default behaviour is that jets are only constructed from visible particles. Some jet studies, including those from ATLAS, use a definition in which neutrinos from hadron decays are included via MC-based calibrations. Setting this flag to true avoids the automatic restriction to a VisibleFinalState.

◆ useMuons()

void Rivet::JetFinder::useMuons ( Muons  usemuons = Muons::ALL)
inline

Include (some) muons in jet construction.

The default behaviour is that jets are only constructed from visible particles. Some jet studies, including those from ATLAS, use a definition in which neutrinos from hadron decays are included via MC-based calibrations. Setting this flag to true avoids the automatic restriction to a VisibleFinalState.


The documentation for this class was generated from the following file:
  • /home/andy/proj/hep/rivet-31x/include/Rivet/Projections/JetFinder.hh