rivet is hosted by Hepforge, IPPP Durham
Rivet  2.7.0
Rivet::DressedLeptons Class Reference

Cluster photons from a given FS to charged 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...
 
- Public Member Functions inherited from Rivet::FinalState
virtual bool accept (const Particle &p) const
 Decide if a particle is to be accepted or not. More...
 
 FinalState (const Cut &c=Cuts::open())
 Construction using Cuts object.
 
 FinalState (const FinalState &fsp, const Cut &c)
 Construction using another FinalState and a Cuts object.
 
 FinalState (double mineta, double maxeta, double minpt=0.0 *GeV)
 
 DEFAULT_RIVET_PROJ_CLONE (FinalState)
 Clone on the heap.
 
- Public Member Functions inherited from Rivet::ParticleFinder
 ParticleFinder (const Cut &c=Cuts::OPEN)
 Construction using Cuts object.
 
virtual ~ParticleFinder ()
 Virtual destructor for inheritance.
 
virtual unique_ptr< Projectionclone () const =0
 Clone on the heap.
 
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 rawParticles () const
 
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 particlesByPt (const Cut &c=Cuts::open()) const
 
Particles particlesByPt (const ParticleSelector &selector) const
 
Particles particlesByPt (double ptmin) const
 
const collection_type & entities () const
 Template-usable interface common to JetAlg.
 
- Public Member Functions inherited from Rivet::Projection
virtual std::string name () const
 Get the name of the projection.
 
 Projection ()
 The default constructor.
 
virtual ~Projection ()
 The destructor.
 
bool before (const Projection &p) const
 
virtual const std::set< PdgIdPair > beamPairs () const
 
ProjectionaddPdgIdPair (PdgId beam1, PdgId beam2)
 
- Public Member Functions inherited from Rivet::ProjectionApplier
 ProjectionApplier ()
 Constructor.
 
void markAsOwned () const
 Mark this object as owned by a proj-handler.
 
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
 
template<typename PROJ >
const PROJ & get (const std::string &name) const
 
const ProjectiongetProjection (const std::string &name) const
 
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 & apply (const Event &evt, const Projection &proj) const
 
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 & apply (const Event &evt, const PROJ &proj) const
 
template<typename PROJ >
const PROJ & applyProjection (const Event &evt, const std::string &name) 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. More...
 
int compare (const Projection &p) const
 Compare projections.
 
- Protected Member Functions inherited from Rivet::Projection
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.
 
Cmp< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
 
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
 
virtual Projectionoperator= (const Projection &)
 Block Projection copying.
 
- Protected Member Functions inherited from Rivet::ProjectionApplier
LoggetLog () const
 
ProjectionHandlergetProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
 
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...
 
template<typename PROJ >
const PROJ & addProjection (const PROJ &proj, const std::string &name)
 Register a contained projection (user-facing version) More...
 

Additional Inherited Members

- Public Types inherited from Rivet::ParticleFinder
typedef Particle entity_type
 
typedef Particles collection_type
 

Detailed Description

Cluster photons from a given FS to charged 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.

References Rivet::IdentifiedFinalState::acceptIdPairs(), Rivet::ProjectionApplier::addProjection(), and Rivet::Projection::setName().

Member Function Documentation

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

Referenced by Rivet::WFinder::project().

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

◆ project()

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

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