Convenience finder of leptonically decaying W. More...

#include <WFinder.hh>

Inheritance diagram for Rivet::WFinder:

Public Types
enum	ChargedLeptons { PROMPTCHLEPTONS =0, ALLCHLEPTONS }

enum	ClusterPhotons { NOCLUSTER =0, CLUSTERNODECAY =1, CLUSTERALL }

enum	PhotonTracking { NOTRACK =0, TRACK =1 }

enum	MassWindow { MASS =0, TRANSMASS =1 }

Public Types inherited from Rivet::ParticleFinder
typedef Particle	entity_type

typedef Particles	collection_type

Public Member Functions
const Particles &	bosons () const
	Access to the found bosons, equivalent to constituents() More...

const Particle &	boson () const

const Particles &	constituentLeptons () const
	Access to the Ws' constituent clustered leptons. More...

const Particle &	constituentLepton () const

const Particles &	constituentNeutrinos () const

const Particle &	constituentNeutrino () const

const VetoedFinalState &	remainingFinalState () const

const MissingMomentum &	missingMom () 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.

Constructors
	WFinder (const FinalState &inputfs, const Cut &leptoncuts, PdgId pid, double minmass, double maxmass, double missingET, double dRmax=0.1, ChargedLeptons chLeptons=PROMPTCHLEPTONS, ClusterPhotons clusterPhotons=CLUSTERNODECAY, PhotonTracking trackPhotons=NOTRACK, MassWindow masstype=MASS, double masstarget=80.4 *GeV)

	WFinder (const FinalState &inputfs, const Cut &leptoncuts, PdgId pid, double minmass, double maxmass, double missingET, double dRmax, ClusterPhotons clusterPhotons, PhotonTracking trackPhotons=NOTRACK, MassWindow masstype=MASS, double masstarget=80.4 *GeV)

	DEFAULT_RIVET_PROJ_CLONE (WFinder)
	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< Projection >	clone () 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

Projection &	addPdgIdPair (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 Projection &	getProjection (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
Log &	getLog () 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< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const

Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const

virtual Projection &	operator= (const Projection &)
	Block Projection copying.

Protected Member Functions inherited from Rivet::ProjectionApplier
Log &	getLog () const

ProjectionHandler &	getProjHandler () 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...

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() [1/2]

Rivet::WFinder::WFinder	(	const FinalState &	inputfs,
		const Cut &	leptoncuts,
		PdgId	pid,
		double	minmass,
		double	maxmass,
		double	missingET,
		double	dRmax = `0.1`,
		ChargedLeptons	chLeptons = `PROMPTCHLEPTONS`,
		ClusterPhotons	clusterPhotons = `CLUSTERNODECAY`,
		PhotonTracking	trackPhotons = `NOTRACK`,
		MassWindow	masstype = `MASS`,
		double	masstarget = `80.4*GeV`
	)

Constructor taking cuts object

Parameters

inputfs	Input final state
leptoncuts	Charged lepton cuts
pid	Type of the charged lepton
minmass,maxmass	(Transverse) mass window
missingET	Minimal amount of missing ET (neutrinos) required
dRmax	Maximum dR of photons around charged lepton to take into account for W reconstruction (only relevant if one of the following are true)
chLeptons	Only use prompt charged leptons, or any charged leptons?
clusterPhotons	Whether such photons are supposed to be clustered to the lepton object and thus W mom
trackPhotons	Whether such photons should be added to _theParticles
masstype	Whether mass window should be applied using m or mT

Todo:: Revisit NOTRACK as default?

Todo:: Fix FS copy constructors!!

References Rivet::IdentifiedFinalState::acceptIdPair(), Rivet::ProjectionApplier::addProjection(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), Rivet::ProjectionApplier::declare(), and Rivet::Projection::setName().

◆ WFinder() [2/2]

Rivet::WFinder::WFinder	(	const FinalState &	inputfs,
		const Cut &	leptoncuts,
		PdgId	pid,
		double	minmass,
		double	maxmass,
		double	missingET,
		double	dRmax,
		ClusterPhotons	clusterPhotons,
		PhotonTracking	trackPhotons = `NOTRACK`,
		MassWindow	masstype = `MASS`,
		double	masstarget = `80.4*GeV`
	)

inline

Backward-compatible constructor with implicit chLeptons mode = PROMPTCHLEPTONS

Deprecated:: Remove this and always use the constructor with chLeptons argument.

References DEFAULT_RIVET_PROJ_CLONE().

Member Function Documentation

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

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

References missingMom(), and remainingFinalState().

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.

◆ 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(), compare(), constituentLepton(), constituentNeutrino(), Rivet::ParticleFinder::empty(), Rivet::mT(), and project().

◆ project()

void Rivet::WFinder::project ( const Event & e )

protectedvirtual

Apply the projection on the supplied event.

Todo:: Do we need to add all used invisibles to _theParticles ?

Implements Rivet::ParticleFinder.

References Rivet::Particle::addConstituent(), Rivet::InvMassFinalState::calc(), Rivet::Particle::charge3(), clear(), Rivet::Particle::constituents(), Rivet::DressedLeptons::dressedLeptons(), Rivet::Particle::isChargedLepton(), Rivet::Particle::isNeutrino(), Rivet::MissingMomentum::missingMomentum(), Rivet::Vector< N >::mod(), Rivet::Particle::momentum(), Rivet::InvMassFinalState::particlePairs(), Rivet::ParticleFinder::particles(), Rivet::InvMassFinalState::useTransverseMass(), and Rivet::MissingMomentum::vectorEt().

Referenced by mT().

◆ 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

Referenced by constituentNeutrino().

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

include/Rivet/Projections/WFinder.hh
src/Projections/WFinder.cc

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ WFinder() [1/2]

◆ WFinder() [2/2]

Member Function Documentation

◆ boson()

◆ bosons()

◆ constituentLepton()

◆ constituentLeptons()

◆ constituentNeutrino()

◆ constituentNeutrinos()

◆ mT()

◆ project()

◆ remainingFinalState()