Rivet API documentation

Rivet 4.1.3
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.
 RIVET_DEFAULT_PROJ_CLONE (MissingMomentum)
 Clone on the heap.
void clear ()
 Clear the projection results.
virtual Projection & operator= (const Projection &)=delete
 Import to avoid warnings about overload-hiding.
virtual 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.
Visible/missing four-momentum functions
const FourMomentum visibleMomentum (double mass=0 *GeV) const
 The vector-summed visible four-momentum in the event.
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.
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"!
All other MPT functions are implemented in METFinder via the two above.
const ThreeMomentum & vectorSumPt () const
 The vector-summed visible transverse momentum in the event, as a 3-vector with z=0.
double scalarSumPt () 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!
Note
All other MPT functions are implemented in METFinder via the two above.
const Vector3 & vectorSumEt () const
 The vector-summed visible transverse energy in the event, as a 3-vector with z=0.
double scalarSumEt () const
 The scalar-summed visible transverse energy in the event.
Transverse momentum functions
Note
This may be what you want, even if the paper calls it "missing Et"!
virtual const Vector3 & vectorPt () const
 Alias for vectorSumPt.
const Vector3 vectorMissingPt () const
 Convenience vector MPT function.
const Vector3 vectorPtMiss () const
const Vector3 vectorMPT () const
double missingPt () const
 The vector-summed missing transverse momentum in the event.
double pTmiss () const
 Alias for missingPt.
double scalarPtMiss () const
 Alias for missingPt.
double mpt () const
 Alias for missingPt.
double scalarPt () const
 Alias for scalarSumPt.
double spt () const
 Alias for scalarSumPt.
Transverse energy functions
Warning
Despite the common names "MET" and "SET", what's often meant is the pT functions above!
virtual const Vector3 & vectorEt () const
 Alias for vectorSumEt.
const Vector3 vectorMissingEt () const
 Convenience vector MET function.
const Vector3 vectorEtMiss () const
const Vector3 vectorMET () const
double missingEt () const
 The vector-summed missing transverse energy in the event.
double eTmiss () const
 Alias for missingPt.
double scalarEtMiss () const
 Alias for missingPt.
double met () const
 Alias for missingEt.
double scalarEt () const
 Alias for scalarSumEt.
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

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

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

◆ 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::SimpleAnalysis::electrons(), Rivet::SimpleAnalysis::jets(), Rivet::SimpleAnalysis::metSignf(), Rivet::SimpleAnalysis::muons(), Rivet::SimpleAnalysis::photons(), Rivet::ALICE::V0AndTrigger::project(), Rivet::ATLAS::MinBiasTrigger::project(), Rivet::ATLAS::SumET_PB_Centrality::project(), Rivet::ATLAS::SumET_PBPB_Centrality::project(), Rivet::BeamThrust::project(), Rivet::BRAHMSCentrality::project(), Rivet::CentralityEstimator::project(), Rivet::CentralityProjection::project(), Rivet::EventMixingBase::project(), Rivet::GeneratedCentrality::project(), Rivet::GeneratedPercentileProjection::project(), Rivet::ImpactParameterProjection::project(), Rivet::LossyFinalState< FILTER >::project(), Rivet::MC_pPbMinBiasTrigger::project(), Rivet::MC_SumETFwdPbCentrality::project(), Rivet::PercentileProjection::project(), Rivet::SmearedJets::project(), Rivet::SmearedMET::project(), Rivet::SmearedParticles::project(), Rivet::Spherocity::project(), Rivet::STAR_BES_Centrality::project(), Rivet::Thrust::project(), Rivet::UserCentEstimate::project(), Rivet::SimpleAnalysis::set(), Rivet::SimpleAnalysis::taus(), Rivet::SimpleAnalysis::tracks(), Rivet::SimpleAnalysis::tracks(), and Rivet::SimpleAnalysis::vmet().

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

References Projection(), and Rivet::Kin::p().

◆ clone()

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

Clone on the heap.

Implemented in Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::CLMultiplicity< false >, Rivet::ALICE::CLMultiplicity< true >, Rivet::ALICE::PrimaryParticles, Rivet::ALICE::V0AndTrigger, Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::V0Multiplicity< 0 >, Rivet::ALICE::V0Multiplicity<+1 >, Rivet::ALICE::V0Multiplicity<-1 >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0Trigger< 0 >, Rivet::ALICE::V0Trigger<+1 >, Rivet::ALICE::V0Trigger<-1 >, Rivet::AxesDefinition, Rivet::JetFinder, and Rivet::ParticleFinder.

◆ compare()

CmpState Rivet::MissingMomentum::compare ( const Projection & p) const
protectedvirtual

Compare projections.

Implements Rivet::Projection.

References Rivet::Kin::p().

◆ 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< true >::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(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedMET::SmearedMET(), Rivet::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<-1 >::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

References getProjection().

Referenced by Rivet::FastJets::FastJets(), and Rivet::FastJets::FastJets().

◆ getProjection() [1/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 getProjHandler().

◆ getProjection() [2/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(), getProjectionFromDeclQueue(), getProjHandler(), and Rivet::Kin::p().

Referenced by Rivet::CentralityProjection::compare(), Rivet::SimpleAnalysis::electronsProj(), get(), Rivet::SimpleAnalysis::jetsProj(), Rivet::DISFinalState::kinematics(), Rivet::SimpleAnalysis::metProj(), Rivet::SimpleAnalysis::muonsProj(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), Rivet::pcmp(), Rivet::SimpleAnalysis::photonsProj(), Rivet::SimpleAnalysis::tausProj(), Rivet::SimpleAnalysis::tracksProj(), Rivet::SmearedJets::truthJets(), and Rivet::SmearedParticles::truthParticles().

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

Referenced by getProjection().

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

References Projection().

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

References Projection().

Referenced by Rivet::ALICE::PrimaryParticles::compare(), Rivet::Correlators::compare(), Rivet::SmearedJets::compare(), and Rivet::SmearedParticles::compare().

◆ name()

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

Get the name of the projection.

Implements Rivet::ProjectionApplier.

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

◆ operator=()

virtual Projection & Rivet::Projection::operator= ( const Projection & )
virtualdelete

Import to avoid warnings about overload-hiding.

Reimplemented from Rivet::METFinder.

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

◆ scalarSumEt()

double Rivet::MissingMomentum::scalarSumEt ( ) const
inlinevirtual

The scalar-summed visible transverse energy in the event.

Implements Rivet::METFinder.

◆ scalarSumPt()

double Rivet::MissingMomentum::scalarSumPt ( ) const
inlinevirtual

The scalar-summed visible transverse momentum in the event.

Implements Rivet::METFinder.

◆ setProjectionHandler()

void Rivet::ProjectionApplier::setProjectionHandler ( ProjectionHandler & projectionHandler) const
protectedinherited
Todo
AB: Add Doxygen comment, follow surrounding coding style

◆ vectorSumEt()

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

◆ vectorSumPt()

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

◆ 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

References Rivet::mass().

Referenced by missingMomentum(), and visibleMom().

The documentation for this class was generated from the following file:
Generated on for Rivet by doxygen 1.15.0