Rivet::SmearedMET Class Reference

Wrapper projection for smearing missing (transverse) energy/momentum with detector resolutions. More...

#include <SmearedMET.hh>

Inheritance diagram for Rivet::SmearedMET:

Public Member Functions
CmpState	compare (const Projection &p) const
	Compare to another SmearedMET.
void	project (const Event &e)
	Perform the MET finding & smearing calculation.
void	reset ()
	Reset the projection. Smearing functions will be unchanged.
virtual std::string	name () const
	Get the name of the projection.
bool	valid () const
	Get the state of the projetion.
bool	failed () const
	Get the state of the projetion.
void	markAsOwned () const
	Mark this object as owned by a proj-handler.
Constructors etc.
template<typename SMEARPARAMSFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>
	SmearedMET (const MissingMomentum &mm, const SMEARPARAMSFN &metSmearParamsFn)
	Constructor from a MissingMomentum projection and a smearing-params function.
template<typename SMEARPARAMSFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>
	SmearedMET (const SMEARPARAMSFN &metSmearParamsFn, const Cut &cut=Cuts::OPEN)
	Constructor from a Cut (on the particles used to determine missing momentum) and a smearing-params function.
template<typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 >, int > = 0>
	SmearedMET (const MissingMomentum &mm, const SMEARFN &metSmearFn)
	Constructor from a MissingMomentum projection and a smearing function.
template<typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 >, int > = 0>
	SmearedMET (const SMEARFN &metSmearFn, const Cut &cut=Cuts::OPEN)
	Constructor from a Cut (on the particles used to determine missing momentum) and a smearing function.
template<typename SMEARPARAMSFN , typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 > &&is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>
	SmearedMET (const MissingMomentum &mm, const SMEARPARAMSFN &metSmearParamsFn, const SMEARFN &metSmearFn)
	Constructor from a MissingMomentum projection and a pair of smearing-params and smearing functions.
template<typename SMEARPARAMSFN , typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 > &&is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>
	SmearedMET (const SMEARPARAMSFN &metSmearParamsFn, const SMEARFN &metSmearFn, const Cut &cut=Cuts::OPEN)
	Constructor from a Cut (on the particles used to determine missing momentum) and a pair of smearing (params) functions.
	RIVET_DEFAULT_PROJ_CLONE (SmearedMET)
	Clone on the heap.
Transverse-momentum functions
Note This may be what you want, even if the paper calls it "missing Et"!
const Vector3 &	vectorPt () const
	The vector-summed visible transverse momentum in the event, as a 3-vector with z=0.
double	scalarPt () const
	The scalar-summed visible transverse momentum in the event.
Transverse-energy functions
Warning Despite the common names "MET" and "SET", what's often meant is the pT functions above!
const Vector3 &	vectorEt () const
double	scalarEt () const
	The scalar-summed visible transverse energy in the event, as a 3-vector with z=0.
double	missingEtResolution () const
	Obtain an approximation to the MET resolution for this event.
double	missingEtSignf () const
	Obtain an approximation to the MET significant (value/resolution) for this event.
Transverse momentum functions
Note This may be what you want, even if the paper calls it "missing Et"!
const Vector3	vectorMissingPt () const
	Convenience vector MPT function.
const Vector3	vectorMPT () const
double	missingPt () const
	The vector-summed missing transverse momentum in the event.
double	scalarSumPt () const
	Alias for scalarPt.
Transverse energy functions
Warning Despite the common names "MET" and "SET", what's often meant is the pT functions above!
const Vector3	vectorMissingEt () const
	Convenience vector MET function.
const Vector3	vectorMET () const
double	missingEt () const
	The vector-summed missing transverse energy in the event.
double	met () const
	Alias for missingEt.
double	scalarSumEt () const
	Alias for scalarEt.
double	set () const
	Alias for scalarSumEt.
Standard constructors and destructors.
virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap.
Projection operation and comparison
bool	before (const Projection &p) const
Projection "getting" functions
std::set< ConstProjectionPtr >	getProjections () const
	Get the contained projections, including recursion.
std::set< ConstProjectionPtr >	getImmediateChildProjections () const
	Get the contained projections, excluding 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 Projection &	getProjection (const std::string &name) const
template<typename PROJ >
const PROJ &	get (const std::string &name) const
template<typename PROJ >
const PROJ &	getProjectionFromDeclQueue (const std::string name) const
Projection applying functions
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.
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).

Protected Member Functions
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.
void	fail ()
	Set the projection in an unvalid state.
Cmp< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const
Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.
void	setProjectionHandler (ProjectionHandler &projectionHandler) const
Projection registration functions
template<typename PROJ >
const PROJ &	declare (const PROJ &proj, const std::string &name) const
	Register a contained projection (user-facing version)
template<typename PROJ >
const PROJ &	declare (const std::string &name, const PROJ &proj) const
	Register a contained projection (user-facing, arg-reordered version)

Detailed Description

Wrapper projection for smearing missing (transverse) energy/momentum with detector resolutions.

Constructor & Destructor Documentation

SmearedMET() [1/6]

template<typename SMEARPARAMSFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>

Rivet::SmearedMET::SmearedMET ( const MissingMomentum &  mm, const SMEARPARAMSFN &  metSmearParamsFn  )

inline

Constructor from a MissingMomentum projection and a smearing-params function.

Smearing-params function maps a 3-vector MET and scalar SET to a new METSmearParams struct for sampling

References Rivet::ProjectionApplier::declare(), and Rivet::Projection::setName().

SmearedMET() [2/6]

template<typename SMEARPARAMSFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>

Rivet::SmearedMET::SmearedMET ( const SMEARPARAMSFN &  metSmearParamsFn, const Cut &  cut = Cuts::OPEN  )

inline

Constructor from a Cut (on the particles used to determine missing momentum) and a smearing-params function.

Smearing-params function maps a 3-vector MET and scalar SET to a new METSmearParams struct for sampling

SmearedMET() [3/6]

template<typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 >, int > = 0>

Rivet::SmearedMET::SmearedMET ( const MissingMomentum &  mm, const SMEARFN &  metSmearFn  )

inline

Constructor from a MissingMomentum projection and a smearing function.

Smearing function maps a 3-vector MET and scalar SET to a new MET 3-vector: f(V3, double) -> V3

References Rivet::ProjectionApplier::declare(), and Rivet::Projection::setName().

SmearedMET() [4/6]

template<typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 >, int > = 0>

Rivet::SmearedMET::SmearedMET ( const SMEARFN &  metSmearFn, const Cut &  cut = Cuts::OPEN  )

inline

Constructor from a Cut (on the particles used to determine missing momentum) and a smearing function.

Smearing function maps a 3-vector MET and scalar SET to a new MET 3-vector: f(V3, double) -> V3

SmearedMET() [5/6]

template<typename SMEARPARAMSFN , typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 > &&is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>

Rivet::SmearedMET::SmearedMET ( const MissingMomentum &  mm, const SMEARPARAMSFN &  metSmearParamsFn, const SMEARFN &  metSmearFn  )

inline

Constructor from a MissingMomentum projection and a pair of smearing-params and smearing functions.

Smearing-params function maps a 3-vector MET and scalar SET to a new METSmearParams struct for sampling

Smearing function maps a 3-vector MET and scalar SET to a new MET 3-vector: f(V3, double) -> V3

References Rivet::ProjectionApplier::declare(), and Rivet::Projection::setName().

SmearedMET() [6/6]

template<typename SMEARPARAMSFN , typename SMEARFN , typename std::enable_if_t< is_same_v< invoke_result_t< SMEARFN, Vector3, double >, Vector3 > &&is_same_v< invoke_result_t< SMEARPARAMSFN, Vector3, double >, METSmearParams >, int > = 0>

Rivet::SmearedMET::SmearedMET ( const SMEARPARAMSFN &  metSmearParamsFn, const SMEARFN &  metSmearFn, const Cut &  cut = Cuts::OPEN  )

inline

Constructor from a Cut (on the particles used to determine missing momentum) and a pair of smearing (params) functions.

Smearing-params function maps a 3-vector MET and scalar SET to a new METSmearParams struct for sampling

Smearing function maps a 3-vector MET and scalar SET to a new MET 3-vector: f(V3, double) -> V3

Member Function Documentation

apply()

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::apply ( const Event &  evt, const Projection &  proj  ) const

inlineinherited

Apply the supplied projection on event evt.

Apply the supplied projection on event evt (user-facing alias).

Referenced by Rivet::ALICE::V0Trigger< MODE >::project().

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.

clone()

virtual unique_ptr< Projection > Rivet::Projection::clone ( ) const

pure virtualinherited

Clone on the heap.

Implemented in Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0AndTrigger, Rivet::ALICE::PrimaryParticles, Rivet::AxesDefinition, Rivet::JetFinder, and Rivet::ParticleFinder.

compare()

CmpState Rivet::SmearedMET::compare ( const Projection &  p ) const

inlinevirtual

Compare to another SmearedMET.

Implements Rivet::Projection.

declare() [1/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declare ( const PROJ &  proj, const std::string &  name  ) const

inlineprotectedinherited

Register a contained projection (user-facing version)

Todo:

Add SFINAE to require that PROJ inherit from Projection

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::EventMixingBase::EventMixingBase(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), 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::LossyFinalState< FILTER >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::PrimaryHadrons::PrimaryHadrons(), SmearedMET(), SmearedMET(), SmearedMET(), Rivet::Spherocity::Spherocity(), Rivet::ATLAS::SumET_PB_Centrality::SumET_PB_Centrality(), Rivet::ATLAS::SumET_PBPB_Centrality::SumET_PBPB_Centrality(), 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::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::SimpleAnalysis::postInit(), Rivet::CentralityBinner< T, MDist >::setProjection(), and Rivet::VetoedFinalState::vetoFinalState().

declare() [2/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declare ( const std::string &  name, const PROJ &  proj  ) const

inlineprotectedinherited

Register a contained projection (user-facing, arg-reordered version)

Todo:

Add SFINAE to require that PROJ inherit from Projection

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

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

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

getProjectionFromDeclQueue()

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::getProjectionFromDeclQueue ( const std::string  name ) const

inlineinherited

Get a named projection from this projection appliers declqueue TODO for TP: Recursion?

References MSG_ERROR.

mkNamedPCmp()

Cmp< Projection > Rivet::Projection::mkNamedPCmp ( 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.

Referenced by Rivet::MC_SumETFwdPbCentrality::compare(), Rivet::MC_pPbMinBiasTrigger::compare(), Rivet::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::ATLAS::MinBiasTrigger::compare(), Rivet::BeamThrust::compare(), Rivet::CentralEtHCM::compare(), Rivet::DISFinalState::compare(), Rivet::EventMixingBase::compare(), Rivet::FParameter::compare(), Rivet::GammaGammaFinalState::compare(), Rivet::HeavyHadrons::compare(), Rivet::Hemispheres::compare(), Rivet::LossyFinalState< FILTER >::compare(), Rivet::PercentileProjection::compare(), Rivet::STAR_BES_Centrality::compare(), Rivet::BRAHMSCentrality::compare(), Rivet::Spherocity::compare(), Rivet::Thrust::compare(), Rivet::CentralityEstimator::compare(), and Rivet::GeneratedCentrality::compare().

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::SmearedParticles::compare(), and Rivet::Correlators::compare().

name()

virtual std::string Rivet::Projection::name ( ) const

inlinevirtualinherited

Get the name of the projection.

Implements Rivet::ProjectionApplier.

Referenced by Rivet::Projection::getLog(), Rivet::Projection::setName(), and Rivet::VetoedFinalState::vetoFinalState().

project()

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

inlinevirtual

Perform the MET finding & smearing calculation.

Implements Rivet::Projection.

References Rivet::MET_SMEAR_NORM().

reset()

void Rivet::SmearedMET::reset ( )

inlinevirtual

Reset the projection. Smearing functions will be unchanged.

Reimplemented from Rivet::METFinder.

scalarEt()

double Rivet::SmearedMET::scalarEt ( ) const

inlinevirtual

The scalar-summed visible transverse energy in the event, as a 3-vector with z=0.

Implements Rivet::METFinder.

Referenced by missingEtResolution(), and scalarPt().

scalarPt()

double Rivet::SmearedMET::scalarPt ( ) const

inlinevirtual

The scalar-summed visible transverse momentum in the event.

Implements Rivet::METFinder.

References scalarEt().

setProjectionHandler()

void Rivet::ProjectionApplier::setProjectionHandler ( ProjectionHandler &  projectionHandler ) const

protectedinherited

Todo:

AB: Add Doxygen comment, follow surrounding coding style

vectorEt()

const Vector3 & Rivet::SmearedMET::vectorEt ( ) const

inlinevirtual

The vector-summed visible transverse energy in the event, as a 3-vector with z=0

Note

Reverse this vector with operator- to get the missing ET vector.

Implements Rivet::METFinder.

Referenced by missingEtResolution(), and vectorPt().

vectorPt()

const Vector3 & Rivet::SmearedMET::vectorPt ( ) const

inlinevirtual

The vector-summed visible transverse momentum in the event, as a 3-vector with z=0.

Implements Rivet::METFinder.

References vectorEt().

---

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

• /Users/chrisg/software/rivet/include/Rivet/Projections/SmearedMET.hh