rivet is hosted by Hepforge, IPPP Durham
Rivet  3.1.0
Rivet::DressedLeptons Class Referenceabstract

Cluster photons from a given FS to all charged particles (typically leptons) More...

#include <DressedLeptons.hh>

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

Public Member Functions

 DressedLeptons (const FinalState &barefs, double dRmax, const Cut &cut=Cuts::open(), bool useDecayPhotons=false, bool useJetClustering=false)
 Constructor with a single input FinalState (used for both photons and bare leptons) More...
 
 DressedLeptons (double dRmax, const Cut &cut=Cuts::open(), bool useDecayPhotons=false, bool useJetClustering=false)
 Constructor with default input FinalState. More...
 
 DressedLeptons (const FinalState &photons, const FinalState &bareleptons, double dRmax, const Cut &cut=Cuts::open(), bool useDecayPhotons=false, bool useJetClustering=false)
 Constructor with distinct photon and lepton finders. More...
 
 DEFAULT_RIVET_PROJ_CLONE (DressedLeptons)
 Clone this projection.
 
vector< DressedLeptondressedLeptons () const
 Retrieve the dressed leptons. More...
 
vector< DressedLeptondressedLeptons (const ParticleSorter &sorter) const
 Retrieve the dressed leptons ordered by supplied sorting functor. More...
 
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.
 DEFAULT_RIVET_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 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. 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 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
 
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

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.
 
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; }
const collection_type & entities () const
 Template-usable interface common to JetAlg.
 
typedef Particle entity_type
 
typedef Particles collection_type
 

Detailed Description

Cluster photons from a given FS to all charged particles (typically leptons)

This stores the original (bare) charged particles and photons as particles() while the newly created clustered lepton objects are accessible as dressedLeptons(). The clustering is done by a delta(R) cone around each bare lepton or by jet clustering. In both modes, double counting is avoided: for the dR clustering, a photon is only added to the closest bare lepton if it happens to be within the capture radius of more than one; for the jet clustering, only the bare lepton with the highest pT is retained if more than one is clustered into a jet.

Constructor & Destructor Documentation

◆ DressedLeptons() [1/3]

Rivet::DressedLeptons::DressedLeptons ( const FinalState barefs,
double  dRmax,
const Cut &  cut = Cuts::open(),
bool  useDecayPhotons = false,
bool  useJetClustering = false 
)

Constructor with a single input FinalState (used for both photons and bare leptons)

Provide a single final state projection used to select the photons and bare leptons, a photon-clustering delta(R) cone size around each bare lepton, and an optional cut on the dressed leptons (i.e. the momenta after clustering). The final arguments control whether non-prompt photons are to be included, and whether the matching of photons to leptons is to be done via dR matching to the bare lepton or by a jet clustering algorithm. Set the clustering radius to 0 or negative to disable clustering.

◆ DressedLeptons() [2/3]

Rivet::DressedLeptons::DressedLeptons ( double  dRmax,
const Cut &  cut = Cuts::open(),
bool  useDecayPhotons = false,
bool  useJetClustering = false 
)
inline

Constructor with default input FinalState.

DressedLepton construction from a default-constructed FinalState. Provide a photon-clustering delta(R) cone size around each bare lepton, and an optional cut on the dressed leptons (i.e. the momenta after clustering). The final arguments control whether non-prompt photons are to be included, and whether the matching of photons to leptons is to be done via dR matching to the bare lepton or by a jet clustering algorithm. Set the clustering radius to 0 or negative to disable clustering.

References Rivet::Cuts::open(), and Rivet::DressedLepton::photons().

◆ DressedLeptons() [3/3]

Rivet::DressedLeptons::DressedLeptons ( const FinalState photons,
const FinalState bareleptons,
double  dRmax,
const Cut &  cut = Cuts::open(),
bool  useDecayPhotons = false,
bool  useJetClustering = false 
)

Constructor with distinct photon and lepton finders.

Provide final state projections used to select the photons and bare leptons, a clustering delta(R) cone size around each bare lepton, and an optional cut on the dressed leptons (i.e. the momenta after clustering.) The final arguments control whether non-prompt photons are to be included, and whether the matching of photons to leptons is to be done via dR matching to the bare lepton or by a jet clustering algorithm. Set the clustering radius to 0 or negative to disable clustering.

Note
Wish we had put the first two args the other way around...
Todo:
Convert second arg to a general ParticleFinder rather than an FS, to allow clustering on to unstables, e.g. taus via TauFinder.

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.

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

◆ dressedLeptons() [1/2]

vector<DressedLepton> Rivet::DressedLeptons::dressedLeptons ( ) const
inline

Retrieve the dressed leptons.

Note
Like particles() but with helper functions

References Rivet::cmpMomByPt(), Rivet::DressedLepton::DressedLepton(), and Rivet::ParticleBase::p().

◆ dressedLeptons() [2/2]

vector<DressedLepton> Rivet::DressedLeptons::dressedLeptons ( const ParticleSorter &  sorter) const
inline

Retrieve the dressed leptons ordered by supplied sorting functor.

Note
Like particles() but with helper functions

References Rivet::DressedLepton::DressedLepton(), and Rivet::ParticleBase::p().

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

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

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

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

◆ particles() [3/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() [4/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() [5/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() [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().

Referenced by Rivet::SmearedParticles::project(), and Rivet::SmearedParticles::truthParticles().

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

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


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