Rivet API documentation
![]() |
Rivet 4.1.3
|
Interface for projections that find missing transverse energy/momentum. More...
#include <METFinder.hh>
Public Member Functions | |
| virtual void | reset () |
| Reset the projection. Smearing functions will be unchanged. | |
| virtual Projection & | operator= (const Projection &)=delete |
| Import to avoid warnings about overload-hiding. | |
| 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. | |
Transverse momentum functions | |
| |
| virtual const Vector3 & | vectorSumPt () const =0 |
| 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. | |
| virtual double | scalarSumPt () const =0 |
| The scalar-summed visible transverse momentum in the event. | |
| double | scalarPt () const |
| Alias for scalarSumPt. | |
| double | spt () const |
| Alias for scalarSumPt. | |
Transverse energy functions | |
| |
| virtual const Vector3 & | vectorSumEt () const =0 |
| 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. | |
| virtual double | scalarSumEt () const =0 |
| The scalar-summed visible transverse energy in the event. | |
| 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 | |
| virtual void | project (const Event &e)=0 |
| virtual CmpState | compare (const Projection &p) const =0 |
| 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
Interface for projections that find missing transverse energy/momentum.
Member Function Documentation
◆ apply()
|
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()
|
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()
|
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()
|
pure virtualinherited |
This function is used to define a unique ordering between different Projection objects of the same class. If this is considered to be equivalent to the Projector object, p, in the argument the function should return 0. If this object should be ordered before p a negative value should be returned, otherwise a positive value should be returned. This function must never be called explicitly, but should only be called from the operator<(const Projection &). When implementing the function in concrete sub-classes, it is then guaranteed that the Projection object p in the argument is of the same class as the sub-class and can be safely dynamically casted to that class.
When implementing this function in a sub-class, the immediate base class version of the function should be called first. If the base class function returns a non-zero value, that value should be returned immediately. Only if zero is returned should this function check the member variables of the sub-class to determine whether this should be ordered before or after p, or if it is equivalent with p.
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::ATLAS::MinBiasTrigger, Rivet::ATLAS::SumET_PB_Centrality, Rivet::ATLAS::SumET_PBPB_Centrality, Rivet::Beam, Rivet::BeamThrust, Rivet::BRAHMSCentrality, Rivet::CentralEtHCM, Rivet::CentralityEstimator, Rivet::CentralityProjection, Rivet::ChargedFinalState, Rivet::ChargedLeptons, Rivet::Correlators, Rivet::DecayedParticles, Rivet::DileptonFinder, Rivet::DISDiffHadron, Rivet::DISFinalState, Rivet::DISKinematics, Rivet::DISLepton, Rivet::DISRapidityGap, Rivet::EventMixingBase, Rivet::FastJets, Rivet::FinalState, Rivet::FParameter, Rivet::GammaGammaFinalState, Rivet::GammaGammaKinematics, Rivet::GammaGammaLeptons, Rivet::GeneratedCentrality, Rivet::GeneratedPercentileProjection, Rivet::HadronicFinalState, Rivet::HeavyHadrons, Rivet::Hemispheres, Rivet::HepMCHeavyIon, Rivet::IdentifiedFinalState, Rivet::ImpactParameterProjection, Rivet::InitialQuarks, Rivet::InvisibleFinalState, Rivet::InvMassFinalState, Rivet::JetFinder, Rivet::JetShape, Rivet::LeadingParticlesFinalState, Rivet::LeptonFinder, Rivet::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::MC_pPbMinBiasTrigger, Rivet::MC_SumETFwdPbCentrality, Rivet::MergedFinalState, Rivet::MissingMomentum, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::ParisiTensor, Rivet::ParticleFinder, Rivet::PartonicTops, Rivet::PercentileProjection, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::SmearedJets, Rivet::SmearedMET, Rivet::SmearedParticles, Rivet::Sphericity, Rivet::Spherocity, Rivet::STAR_BES_Centrality, Rivet::TauFinder, Rivet::Thrust, Rivet::TriggerCDFRun0Run1, Rivet::TriggerCDFRun2, Rivet::TriggerProjection, Rivet::TriggerUA5, Rivet::UndressBeamLeptons, Rivet::UserCentEstimate, Rivet::VetoedFinalState, and Rivet::VisibleFinalState.
References Projection(), and Rivet::Kin::p().
◆ declare() [1/2]
|
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]
|
inlineprotectedinherited |
Register a contained projection (user-facing, arg-reordered version).
- Todo
- Add SFINAE to require that PROJ inherit from Projection
◆ get()
|
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]
|
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]
|
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()
|
inlineinherited |
Get a named projection from this projection appliers declqueue TODO for TP: Recursion?
References MSG_ERROR.
Referenced by getProjection().
◆ mkNamedPCmp()
|
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()
|
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()
|
inlinevirtualinherited |
Get the name of the projection.
Implements Rivet::ProjectionApplier.
Referenced by getLog(), setName(), and Rivet::VetoedFinalState::vetoFinalState().
◆ operator=()
|
virtualdelete |
Import to avoid warnings about overload-hiding.
Reimplemented from Rivet::Projection.
Reimplemented in Rivet::MissingMomentum.
◆ project()
|
pure virtualinherited |
Take the information available in the Event and make the calculations necessary to obtain the projection. Note that this function must never be called except inside the Event::applyProjection(Projection *) function.
Implemented in Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::CLMultiplicity< false >, Rivet::ALICE::CLMultiplicity< true >, 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::ATLAS::MinBiasTrigger, Rivet::ATLAS::SumET_PB_Centrality, Rivet::ATLAS::SumET_PBPB_Centrality, Rivet::Beam, Rivet::BeamThrust, Rivet::BRAHMSCentrality, Rivet::CentralEtHCM, Rivet::CentralityEstimator, Rivet::CentralityProjection, Rivet::ChargedFinalState, Rivet::ChargedLeptons, Rivet::Correlators, Rivet::DecayedParticles, Rivet::DileptonFinder, Rivet::DISDiffHadron, Rivet::DISFinalState, Rivet::DISKinematics, Rivet::DISLepton, Rivet::DISRapidityGap, Rivet::EventMixingBase, Rivet::FastJets, Rivet::FinalPartons, Rivet::FinalState, Rivet::FParameter, Rivet::GammaGammaFinalState, Rivet::GammaGammaKinematics, Rivet::GammaGammaLeptons, Rivet::GeneratedCentrality, Rivet::GeneratedPercentileProjection, Rivet::HadronicFinalState, Rivet::HeavyHadrons, Rivet::Hemispheres, Rivet::HepMCHeavyIon, Rivet::IdentifiedFinalState, Rivet::ImpactParameterProjection, Rivet::InitialQuarks, Rivet::InvisibleFinalState, Rivet::InvMassFinalState, Rivet::JetFinder, Rivet::JetShape, Rivet::LeadingParticlesFinalState, Rivet::LeptonFinder, Rivet::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::MC_pPbMinBiasTrigger, Rivet::MC_SumETFwdPbCentrality, Rivet::MergedFinalState, Rivet::MissingMomentum, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::ParisiTensor, Rivet::ParticleFinder, Rivet::PartonicTops, Rivet::PercentileProjection, Rivet::PrimaryHadrons, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::SmearedJets, Rivet::SmearedMET, Rivet::SmearedParticles, Rivet::Sphericity, Rivet::Spherocity, Rivet::STAR_BES_Centrality, Rivet::TauFinder, Rivet::Thrust, Rivet::TriggerCDFRun0Run1, Rivet::TriggerCDFRun2, Rivet::TriggerProjection, Rivet::TriggerUA5, Rivet::UndressBeamLeptons, Rivet::UnstableParticles, Rivet::UserCentEstimate, Rivet::VetoedFinalState, and Rivet::VisibleFinalState.
References Event.
Referenced by Rivet::Event::applyProjection().
◆ reset()
|
inlinevirtual |
Reset the projection. Smearing functions will be unchanged.
Reimplemented in Rivet::SmearedMET.
◆ scalarSumEt()
|
pure virtual |
The scalar-summed visible transverse energy in the event.
Implemented in Rivet::MissingMomentum, and Rivet::SmearedMET.
Referenced by scalarEt(), and set().
◆ scalarSumPt()
|
pure virtual |
The scalar-summed visible transverse momentum in the event.
Implemented in Rivet::MissingMomentum, and Rivet::SmearedMET.
Referenced by scalarPt(), and spt().
◆ setProjectionHandler()
|
protectedinherited |
- Todo
- AB: Add Doxygen comment, follow surrounding coding style
◆ vectorSumEt()
|
pure virtual |
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.
Implemented in Rivet::MissingMomentum, and Rivet::SmearedMET.
Referenced by vectorEt(), and vectorMissingEt().
◆ vectorSumPt()
|
pure virtual |
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.
- Todo
- Currently equivalent to vectorEt
Implemented in Rivet::MissingMomentum, and Rivet::SmearedMET.
Referenced by vectorMissingPt(), and vectorPt().
The documentation for this class was generated from the following file:
- /builds/hepcedar/rivet/include/Rivet/Projections/METFinder.hh
Generated on for Rivet by
