rivet is hosted by Hepforge, IPPP Durham
Rivet 3.1.6
Rivet::WFinder Class Referenceabstract

Convenience finder of leptonically decaying W. More...

#include <WFinder.hh>

Inheritance diagram for Rivet::WFinder:
Rivet::ParticleFinder Rivet::Projection Rivet::ProjectionApplier

Public Types

enum class  ChargedLeptons { PROMPT , ALL }
 
enum class  ClusterPhotons { NONE , NODECAY , ALL }
 
enum class  AddPhotons { NO , YES }
 
enum class  MassWindow { M , MT }
 

Public Member Functions

Object lifetime management
virtual unique_ptr< Projectionclone () const =0
 Clone on the heap. More...
 
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. 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
 
Standard constructors and destructors.
virtual std::string name () const
 Get the name of the projection. More...
 
bool valid () const
 Get the state of the projetion.
 
bool failed () const
 Get the state of the projetion.
 
Projection operation and comparison
bool before (const Projection &p) const
 
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
 

Protected Member Functions

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

Constructors

 WFinder (const FinalState &inputfs, const Cut &leptoncuts, PdgId pid, double minmass, double maxmass, double missingET, double dRmax=0.1, ChargedLeptons chLeptons=ChargedLeptons::PROMPT, ClusterPhotons clusterPhotons=ClusterPhotons::NODECAY, AddPhotons trackPhotons=AddPhotons::NO, MassWindow masstype=MassWindow::M, double masstarget=80.4 *GeV)
 Constructor taking cuts object. More...
 
 DEFAULT_RIVET_PROJ_CLONE (WFinder)
 Clone on the heap.
 
const Particlesbosons () const
 Access to the found bosons, equivalent to constituents() More...
 
const Particleboson () const
 
const ParticlesconstituentLeptons () const
 Access to the Ws' constituent clustered leptons. More...
 
const ParticleconstituentLepton () const
 
const ParticlesconstituentNeutrinos () const
 
const ParticleconstituentNeutrino () const
 
const VetoedFinalStateremainingFinalState () const
 
const MissingMomentummissingMom () const
 Access to the missing momentum projection used to find the "neutrino".
 
double mT () const
 Calculate the transverse mass of the W, from the charged lepton and neutrino. More...
 
void clear ()
 Clear the projection.
 
void project (const Event &e)
 Apply the projection on the supplied event. More...
 
CmpState compare (const Projection &p) const
 Compare projections. More...
 

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)
 
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
 

Projection applying functions

template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > applyProjection (const Event &evt, const Projection &proj) const
 
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > applyProjection (const Event &evt, const PROJ &proj) const
 
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > applyProjection (const Event &evt, const std::string &name) const
 
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 (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 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).
 
void markAsOwned () const
 Mark this object as owned by a proj-handler.
 
ProjectionHandlergetProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
 

Detailed Description

Convenience finder of leptonically decaying W.

Chain together different projections as convenience for finding one W from one lepton and the missing E 4-vector in the final state, including photon clustering.

Constructor & Destructor Documentation

◆ WFinder()

Rivet::WFinder::WFinder ( const FinalState inputfs,
const Cut &  leptoncuts,
PdgId  pid,
double  minmass,
double  maxmass,
double  missingET,
double  dRmax = 0.1,
ChargedLeptons  chLeptons = ChargedLeptons::PROMPT,
ClusterPhotons  clusterPhotons = ClusterPhotons::NODECAY,
AddPhotons  trackPhotons = AddPhotons::NO,
MassWindow  masstype = MassWindow::M,
double  masstarget = 80.4 *GeV 
)

Constructor taking cuts object.

Parameters
inputfsInput final state
leptoncutsCharged lepton cuts
pidType of the charged lepton
minmass,maxmass(Transverse) mass window
missingETMinimal amount of missing ET (neutrinos) required
dRmaxMaximum dR of photons around charged lepton to take into account for W reconstruction (only relevant if one of the following are true)
chLeptonsOnly use prompt charged leptons, or any charged leptons?
clusterPhotonsWhether such photons are supposed to be clustered to the lepton object and thus W mom
trackPhotonsWhether such photons should be added to _theParticles
masstypeWhether mass window should be applied using m or mT
masstargetThe expected (transverse) mass value, if resolving ambiguities
Todo:
Revisit AddPhotons::NO as default?

Member Function Documentation

◆ addPdgIdPair()

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

Add a colliding beam pair.

Todo:
This deserves a better name!

◆ applyProjection() [1/3]

template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event evt,
const PROJ &  proj 
) const
inlineinherited

Apply the supplied projection on event evt.

Deprecated:
Prefer the simpler apply<> form

◆ applyProjection() [2/3]

template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event evt,
const Projection proj 
) const
inlineinherited

Apply the supplied projection on event evt.

Deprecated:
Prefer the simpler apply<> form

◆ applyProjection() [3/3]

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

Apply the named projection on event evt.

Deprecated:
Prefer the simpler apply<> form

References Rivet::ProjectionApplier::name().

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

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

◆ boson()

const Particle & Rivet::WFinder::boson ( ) const
inline

Access to the found boson (assuming it exists)

Todo:
C++17 std::optional...

References Rivet::ParticleFinder::particles().

◆ bosons()

const Particles & Rivet::WFinder::bosons ( ) const
inline

Access to the found bosons, equivalent to constituents()

Note
Currently either 0 or 1 boson can be found.

References Rivet::ParticleFinder::particles().

Referenced by mT().

◆ 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::WFinder::compare ( const Projection p) const
protectedvirtual

Compare projections.

Reimplemented from Rivet::ParticleFinder.

◆ constituentLepton()

const Particle & Rivet::WFinder::constituentLepton ( ) const
inline

brief Access to the W's constituent clustered lepton (assuming it exists)

Todo:
C++17 std::optional...

Referenced by mT().

◆ constituentLeptons()

const Particles & Rivet::WFinder::constituentLeptons ( ) const
inline

Access to the Ws' constituent clustered leptons.

Note
Either size 0 if no boson was found or 1 if one boson was found

◆ constituentNeutrino()

const Particle & Rivet::WFinder::constituentNeutrino ( ) const
inline

Access to the W's constituent neutrino (assuming it exists)

Note
The neutrino can't be perfecly reconstructed – this is a pseudo-nu from the MET.

Referenced by mT().

◆ constituentNeutrinos()

const Particles & Rivet::WFinder::constituentNeutrinos ( ) const
inline

Access to the Ws' constituent neutrinos

Note
Either size 0 if no boson was found or 1 if one boson was found
The neutrino can't be perfecly reconstructed – this is a pseudo-nu from the MET.

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

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::GammaGammaFinalState::GammaGammaFinalState(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), 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::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::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::TriggerCDFRun0Run1::TriggerCDFRun0Run1(), Rivet::TriggerCDFRun2::TriggerCDFRun2(), Rivet::UndressBeamLeptons::UndressBeamLeptons(), Rivet::ALICE::V0AndTrigger::V0AndTrigger(), Rivet::ALICE::V0Trigger< MODE >::V0Trigger(), Rivet::VetoedFinalState::VetoedFinalState(), Rivet::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), and Rivet::CentralityBinner< T, MDist >::setProjection().

◆ 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

References Rivet::ProjectionApplier::name().

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

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

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

◆ mT()

double Rivet::WFinder::mT ( ) const
inline

Calculate the transverse mass of the W, from the charged lepton and neutrino.

Defined as sqrt(2 pT_l pT_nu (1.0 - cos(dphi_lnu))). Return -1 if no boson found.

References bosons(), constituentLepton(), constituentNeutrino(), Rivet::ParticleFinder::empty(), Rivet::Kin::mom(), and Rivet::mT().

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

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

◆ 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::WFinder::project ( const Event e)
protectedvirtual

Apply the projection on the supplied event.

Implements Rivet::ParticleFinder.

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

◆ remainingFinalState()

const VetoedFinalState & Rivet::WFinder::remainingFinalState ( ) const

Access to the particles other than the W leptons and clustered photons

Useful for e.g. input to a jet finder


The documentation for this class was generated from the following file:
  • /Users/chrisg/software/rivet/include/Rivet/Projections/WFinder.hh