Wrapper projection for smearing Jets with detector resolutions and efficiencies. More...

#include <SmearedParticles.hh>

Inheritance diagram for Rivet::SmearedParticles:

Public Member Functions
int	compare (const Projection &p) const
	Compare to another SmearedParticles.

void	project (const Event &e)
	Perform the particle finding & smearing calculation.

void	reset ()
	Reset the projection. Smearing functions will be unchanged.

Constructors etc.
	SmearedParticles (const ParticleFinder &pf, double eff, const Cut &c=Cuts::open())
	Constructor with const efficiency.

	SmearedParticles (const ParticleFinder &pf, const ParticleEffFn &effFn, const Cut &c=Cuts::open())
	Constructor with an efficiency function.

	SmearedParticles (const ParticleFinder &pf, double eff, const ParticleSmearFn &smearFn, const Cut &c=Cuts::open())
	Constructor with const efficiency followed by a smearing function.

	SmearedParticles (const ParticleFinder &pf, const ParticleSmearFn &smearFn, double eff, const Cut &c=Cuts::open())
	Constructor with a smearing function followed by const efficiency.

	SmearedParticles (const ParticleFinder &pf, const ParticleEffFn &effFn, const ParticleSmearFn &smearFn, const Cut &c=Cuts::open())
	Constructor with an efficiency function followed by a smearing function.

	SmearedParticles (const ParticleFinder &pf, const ParticleSmearFn &smearFn, const ParticleEffFn &effFn, const Cut &c=Cuts::open())
	Constructor with a smearing function followed by an efficiency function.

	SmearedParticles (const ParticleFinder &pf, const vector< ParticleEffSmearFn > &effSmearFns, const Cut &c=Cuts::open())
	Constructor with an ordered list of efficiency and/or smearing functions.

	SmearedParticles (const ParticleFinder &pf, const initializer_list< ParticleEffSmearFn > &effSmearFns, const Cut &c=Cuts::open())
	Constructor with an ordered list of efficiency and/or smearing functions.

template<typename... ARGS>
	SmearedParticles (const ParticleFinder &pf, const Cut &c, ARGS... effSmearFns)
	Constructor with a variadic ordered list of efficiency and smearing function args. More...

	DEFAULT_RIVET_PROJ_CLONE (SmearedParticles)
	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

Additional Inherited Members
Public Types inherited from Rivet::ParticleFinder
typedef Particle	entity_type

typedef Particles	collection_type

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

Wrapper projection for smearing Jets with detector resolutions and efficiencies.

Constructor & Destructor Documentation

◆ SmearedParticles()

template<typename... ARGS>

Rivet::SmearedParticles::SmearedParticles	(	const ParticleFinder &	pf,
		const Cut &	c,
		ARGS...	effSmearFns
	)

inline

Constructor with a variadic ordered list of efficiency and smearing function args.

Note: The Cut must be provided before the eff/smearing functions

Todo:: Wouldn't it be nice if the Cut could also go after the parameter pack?

References DEFAULT_RIVET_PROJ_CLONE().

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

include/Rivet/Projections/SmearedParticles.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SmearedParticles()