rivet is hosted by Hepforge, IPPP Durham
Rivet 3.1.7
Public Member Functions | Protected Member Functions | List of all members
Rivet::MissingMomentum Class Referenceabstract

Calculate missing \( E \), \( E_\perp \) etc. as complements to the total visible momentum. More...

#include <MissingMomentum.hh>

Inheritance diagram for Rivet::MissingMomentum:
Rivet::METFinder Rivet::Projection Rivet::ProjectionApplier

Public Member Functions

 MissingMomentum (const FinalState &fs)
 Canonical constructor taking a FinalState as argument.
 
 MissingMomentum (const Cut &c=Cuts::open())
 Default constructor with optional cut.
 
 DEFAULT_RIVET_PROJ_CLONE (MissingMomentum)
 Clone on the heap.
 
void clear ()
 Clear the projection results.
 
virtual void reset ()
 Reset the projection. Smearing functions will be unchanged. More...
 
Visible/missing four-momentum functions
const FourMomentum visibleMomentum (double mass=0 *GeV) const
 The vector-summed visible four-momentum in the event. More...
 
const FourMomentum visibleMom (double mass=0 *GeV) const
 Alias for visibleMomentum.
 
const FourMomentum missingMomentum (double mass=0 *GeV) const
 The missing four-momentum in the event, required to balance the final state. More...
 
const FourMomentum missingMom (double mass=0 *GeV) const
 Alias for missingMomentum.
 
Transverse momentum functions
Note
This may be what you want, even if the paper calls it "missing Et"!
const ThreeMomentum & vectorPt () const
 The vector-summed visible transverse momentum in the event, as a 3-vector with z=0. More...
 
const ThreeMomentum vectorPtMiss () const
 The vector missing transverse momentum in the event, as a 3-vector with z=0.
 
double scalarPtMiss () const
 The scalar value of missing transverse momentum in the event.
 
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
 The vector-summed visible transverse energy in the event, as a 3-vector with z=0. More...
 
const Vector3 vectorEtMiss () const
 The vector missing transverse energy in the event, as a 3-vector with z=0.
 
double scalarEtMiss () const
 The scalar value of missing transverse energy in the event.
 
double scalarEt () const
 The scalar-summed visible transverse energy in the event.
 
double set () const
 
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.
 
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.
 
Standard constructors and destructors.
virtual unique_ptr< Projection > clone () const =0
 Clone on the heap. More...
 
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 Projection & getProjection (const std::string &name) const
 
template<typename PROJ >
const PROJ & get (const std::string &name) const
 

Protected Member Functions

void project (const Event &e)
 Apply the projection to the event. More...
 
CmpState compare (const Projection &p) const
 Compare projections. More...
 
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...
 

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
 
Projection & addPdgIdPair (PdgId beam1, PdgId beam2)
 
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
 

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.
 
ProjectionHandler & getProjHandler () const
 Get a reference to the ProjectionHandler for this thread.
 

Detailed Description

Calculate missing \( E \), \( E_\perp \) etc. as complements to the total visible momentum.

Project out the total visible energy vector, allowing missing \( E \), \( E_\perp \) etc. to be calculated. Final-state particle visibility restrictions are automatic, and the resulting visible/missing momentum vectors are over the whole event rather than over hard objects (jets + leptons) or specific to prompt invisibles.

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.

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

Compare projections.

Implements Rivet::Projection.

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

◆ missingMomentum()

const FourMomentum Rivet::MissingMomentum::missingMomentum ( double  mass = 0*GeV) const
inline

The missing four-momentum in the event, required to balance the final state.

Note
The optional mass argument is used to set a mass on the 4-vector. By default it is zero (since missing momentum is really a 3-momentum quantity: adding the E components of visible momenta just gives a huge mass)
Todo:
Change to return a 3-vector with no argument, a 4-vector if a mass arg given

References Rivet::Kin::mass(), Rivet::FourMomentum::reverse(), and visibleMomentum().

Referenced by missingMom().

◆ 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::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::Spherocity::compare(), Rivet::Thrust::compare(), Rivet::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::ATLAS::MinBiasTrigger::compare(), Rivet::CentralityEstimator::compare(), Rivet::GeneratedCentrality::compare(), Rivet::STAR_BES_Centrality::compare(), and Rivet::BRAHMSCentrality::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::SmearedMET::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::VetoedFinalState::addVetoOnThisFinalState(), Rivet::Projection::getLog(), and Rivet::Projection::setName().

◆ project()

void Rivet::MissingMomentum::project ( const Event &  e)
protectedvirtual

Apply the projection to the event.

Implements Rivet::Projection.

◆ reset()

virtual void Rivet::METFinder::reset ( )
inlinevirtualinherited

Reset the projection. Smearing functions will be unchanged.

Reimplemented in Rivet::SmearedMET.

◆ set()

double Rivet::MissingMomentum::set ( ) const
inline

Alias for scalarEt

Deprecated:
Use the full name, "set" is too ambiguous

References scalarEt().

◆ vectorEt()

const Vector3 & Rivet::MissingMomentum::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 vectorEtMiss().

◆ vectorPt()

const ThreeMomentum & Rivet::MissingMomentum::vectorPt ( ) const
inlinevirtual

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

Note
Reverse this vector with operator- to get the missing pT vector.

Implements Rivet::METFinder.

Referenced by vectorPtMiss().

◆ visibleMomentum()

const FourMomentum Rivet::MissingMomentum::visibleMomentum ( double  mass = 0 *GeV) const

The vector-summed visible four-momentum in the event.

Note
Reverse this vector with .reverse() to get the missing momentum vector.
The optional mass argument is used to set a mass on the 4-vector. By default it is zero (since missing momentum is really a 3-momentum quantity: adding the E components of visible momenta just gives a huge mass)
Todo:
Change to return a 3-vector with no argument, a 4-vector if a mass arg given

Referenced by missingMomentum(), and visibleMom().

The documentation for this class was generated from the following file:
Generated on Wed Sep 28 2022 15:34:46 for Rivet by doxygen 1.9.4