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

#include <SmearedJets.hh>

Inheritance diagram for Rivet::SmearedJets:

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

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

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

Constructors etc.
	SmearedJets (const JetAlg &ja, const JetSmearFn &smearFn, const JetEffFn &bTagEffFn=JET_BTAG_PERFECT, const JetEffFn &cTagEffFn=JET_CTAG_PERFECT)
	Constructor with a reco efficiency and optional tagging efficiencies.

	SmearedJets (const JetAlg &ja, const JetEffFn &bTagEffFn=JET_BTAG_PERFECT, const JetEffFn &cTagEffFn=JET_CTAG_PERFECT, const initializer_list< JetEffSmearFn > &effSmearFns={})
	Constructor with tagging efficiencies, plus an ordered init-list of efficiency and smearing functions.

	SmearedJets (const JetAlg &ja, const JetEffFn &bTagEffFn=JET_BTAG_PERFECT, const JetEffFn &cTagEffFn=JET_CTAG_PERFECT, const vector< JetEffSmearFn > &effSmearFns={})
	Constructor with tagging efficiencies, plus an ordered vector of efficiency and smearing functions.

	SmearedJets (const JetAlg &ja, const initializer_list< JetEffSmearFn > &effSmearFns, const JetEffFn &bTagEffFn=JET_BTAG_PERFECT, const JetEffFn &cTagEffFn=JET_CTAG_PERFECT)
	Constructor with an ordered init-list of efficiency and smearing functions, plus optional tagging efficiencies.

	SmearedJets (const JetAlg &ja, const vector< JetEffSmearFn > &effSmearFns, const JetEffFn &bTagEffFn=JET_BTAG_PERFECT, const JetEffFn &cTagEffFn=JET_CTAG_PERFECT)
	Constructor with an ordered vector of efficiency and smearing functions, plus optional tagging efficiencies.

	SmearedJets (const JetAlg &ja, const JetSmearFn &smearFn, const JetEffFn &bTagEffFn, const JetEffFn &cTagEffFn, const JetEffFn &jetEffFn)
	Constructor with trailing efficiency arg. More...

	DEFAULT_RIVET_PROJ_CLONE (SmearedJets)
	Clone on the heap. More...

Public Member Functions inherited from Rivet::JetAlg
	JetAlg (const FinalState &fs, MuonsStrategy usemuons=JetAlg::ALL_MUONS, InvisiblesStrategy useinvis=JetAlg::NO_INVISIBLES)
	Constructor.

	JetAlg ()
	Default constructor.

virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap.

virtual	~JetAlg ()
	Destructor.

size_t	size () const
	Count the jets.

size_t	size (const Cut &c) const
	Count the jets after a Cut is applied.

size_t	size (const JetSelector &s) const
	Count the jets after a selection functor is applied.

bool	empty () const
	Is this jet finder empty?

bool	empty (const Cut &c) const
	Is this jet finder empty after a Cut is applied?

bool	empty (const JetSelector &s) const
	Is this jet finder empty after a selection functor is applied?

collection_type	entities () const
	Template-usable interface common to FinalState.

void	useMuons (MuonsStrategy usemuons=ALL_MUONS)
	Include (some) muons in jet construction. More...

void	useInvisibles (InvisiblesStrategy useinvis=DECAY_INVISIBLES)
	Include (some) invisible particles in jet construction. More...

void	useInvisibles (bool useinvis)
	Include (some) invisible particles in jet construction. More...

virtual Jets	jets (const Cut &c=Cuts::open()) const

virtual Jets	jets (const JetSelector &selector) const

Jets	jets (const Cut &c, const JetSorter &sorter) const

Jets	jets (const JetSorter &sorter, const Cut &c=Cuts::open()) const

Jets	jets (const JetSelector &selector, const JetSorter &sorter) const

Jets	jets (const JetSorter &sorter, const JetSelector selector) const

Jets	jetsByPt (const Cut &c=Cuts::open()) const

Jets	jetsByPt (const JetSelector &selector) const

Jets	jetsByPt (double ptmin) const

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::JetAlg
enum	MuonsStrategy { NO_MUONS, DECAY_MUONS, ALL_MUONS }
	Enum for the treatment of muons: whether to include all, some, or none in jet-finding.

enum	InvisiblesStrategy { NO_INVISIBLES, DECAY_INVISIBLES, ALL_INVISIBLES }
	Enum for the treatment of invisible particles: whether to include all, some, or none in jet-finding.

typedef Jet	entity_type

typedef Jets	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

◆ SmearedJets()

Rivet::SmearedJets::SmearedJets	(	const JetAlg &	ja,
		const JetSmearFn &	smearFn,
		const JetEffFn &	bTagEffFn,
		const JetEffFn &	cTagEffFn,
		const JetEffFn &	jetEffFn
	)

inline

Constructor with trailing efficiency arg.

Deprecated:: Use the version with pair-smearing list as 2nd argument

References DEFAULT_RIVET_PROJ_CLONE().

Member Function Documentation

◆ DEFAULT_RIVET_PROJ_CLONE()

Rivet::SmearedJets::DEFAULT_RIVET_PROJ_CLONE ( SmearedJets )

Clone on the heap.

Todo:

How to include tagging effs?

Variadic eff/smear fn list?

Add a trailing Cut arg cf. SmearedParticles? – wrap into an eff function

Referenced by SmearedJets().

◆ project()

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

inlinevirtual

Perform the jet finding & smearing calculation.

<

Todo:: Or could use the/an actual clustered b-quark momentum?

<

Todo:: As above... ?

Implements Rivet::JetAlg.

References Rivet::ParticleBase::eta(), Rivet::JetAlg::jetsByPt(), Rivet::ParticleBase::mom(), Rivet::Jet::particles(), Rivet::ParticleBase::pT(), Rivet::rand01(), and Rivet::Jet::tags().

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

include/Rivet/Projections/SmearedJets.hh