rivet is hosted by Hepforge, IPPP Durham
Rivet 4.0.0
Rivet::SingleValueProjection Class Referenceabstract

Base class for projections returning a single floating point value. More...

#include <SingleValueProjection.hh>

Inheritance diagram for Rivet::SingleValueProjection:
Rivet::Projection Rivet::ProjectionApplier Rivet::ALICE::CLMultiplicity< INNER > Rivet::ALICE::V0Multiplicity< MODE > Rivet::ATLAS::SumET_PBPB_Centrality Rivet::ATLAS::SumET_PB_Centrality Rivet::BRAHMSCentrality Rivet::CentralityProjection Rivet::GeneratedPercentileProjection Rivet::ImpactParameterProjection Rivet::MC_SumETFwdPbCentrality Rivet::PercentileProjection Rivet::STAR_BES_Centrality Rivet::UserCentEstimate

Public Member Functions

 SingleValueProjection ()
 The default constructor.
 
bool isValueSet () const
 Returns true if the value has been set.
 
double value () const
 Return the single value.
 
double operator() () const
 Return the single value.
 
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.
 
Standard constructors and destructors.
virtual unique_ptr< Projectionclone () 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 ProjectiongetProjection (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 setValue (double v)
 Set the value.
 
void clear ()
 Unset the value.
 
LoggetLog () 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< ProjectionmkNamedPCmp (const Projection &otherparent, const std::string &pname) const
 
Cmp< ProjectionmkPCmp (const Projection &otherparent, const std::string &pname) const
 
ProjectionHandlergetProjHandler () 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

Base class for projections returning a single floating point value.

Author
Leif Lönnblad

Project an event down to a single floating point value accessible through the operator() function.

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()

◆ compare()

virtual CmpState Rivet::Projection::compare ( const Projection p) const
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::Beam, Rivet::GeneratedPercentileProjection, Rivet::HepMCHeavyIon, Rivet::ImpactParameterProjection, Rivet::InitialQuarks, Rivet::TriggerCDFRun0Run1, Rivet::TriggerCDFRun2, Rivet::TriggerProjection, Rivet::TriggerUA5, Rivet::UserCentEstimate, Rivet::ChargedLeptons, Rivet::MC_SumETFwdPbCentrality, Rivet::MC_pPbMinBiasTrigger, Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0AndTrigger, Rivet::ALICE::PrimaryParticles, Rivet::ATLAS::SumET_PB_Centrality, Rivet::ATLAS::SumET_PBPB_Centrality, Rivet::ATLAS::MinBiasTrigger, Rivet::BeamThrust, Rivet::CentralEtHCM, Rivet::CentralityProjection, Rivet::ChargedFinalState, 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::HadronicFinalState, Rivet::HeavyHadrons, Rivet::Hemispheres, Rivet::IdentifiedFinalState, Rivet::InvisibleFinalState, Rivet::InvMassFinalState, Rivet::JetShape, Rivet::LeadingParticlesFinalState, Rivet::LeptonFinder, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::LossyFinalState< FILTER >, Rivet::MergedFinalState, Rivet::MissingMomentum, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::ParisiTensor, Rivet::ParticleFinder, Rivet::PartonicTops, Rivet::PercentileProjection, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::STAR_BES_Centrality, Rivet::BRAHMSCentrality, Rivet::SmearedJets, Rivet::SmearedMET, Rivet::SmearedParticles, Rivet::Sphericity, Rivet::Spherocity, Rivet::TauFinder, Rivet::Thrust, Rivet::UndressBeamLeptons, Rivet::VetoedFinalState, Rivet::VisibleFinalState, Rivet::CentralityEstimator, Rivet::GeneratedCentrality, Rivet::Correlators, and Rivet::JetFinder.

◆ 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(), 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::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::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), 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()

◆ 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

◆ project()

virtual void Rivet::Projection::project ( const Event e)
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::TriggerProjection, Rivet::MC_SumETFwdPbCentrality, Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0AndTrigger, Rivet::ATLAS::SumET_PB_Centrality, Rivet::ATLAS::SumET_PBPB_Centrality, Rivet::Beam, Rivet::BeamThrust, Rivet::CentralEtHCM, Rivet::CentralityProjection, Rivet::ChargedFinalState, 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::GeneratedPercentileProjection, Rivet::HadronicFinalState, Rivet::HeavyHadrons, Rivet::Hemispheres, Rivet::HepMCHeavyIon, Rivet::IdentifiedFinalState, Rivet::ImpactParameterProjection, Rivet::InitialQuarks, Rivet::InvisibleFinalState, Rivet::InvMassFinalState, Rivet::JetShape, Rivet::LeadingParticlesFinalState, Rivet::LeptonFinder, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::LossyFinalState< FILTER >, Rivet::MergedFinalState, Rivet::MissingMomentum, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::ParisiTensor, Rivet::PercentileProjection, Rivet::PrimaryHadrons, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::STAR_BES_Centrality, Rivet::BRAHMSCentrality, Rivet::SmearedJets, Rivet::SmearedMET, Rivet::SmearedParticles, Rivet::Sphericity, Rivet::Spherocity, Rivet::TauFinder, Rivet::Thrust, Rivet::UndressBeamLeptons, Rivet::UnstableParticles, Rivet::UserCentEstimate, Rivet::VetoedFinalState, Rivet::VisibleFinalState, Rivet::CentralityEstimator, Rivet::GeneratedCentrality, Rivet::Correlators, Rivet::JetFinder, Rivet::ParticleFinder, Rivet::MC_pPbMinBiasTrigger, Rivet::ATLAS::MinBiasTrigger, Rivet::PartonicTops, Rivet::ChargedLeptons, Rivet::TriggerCDFRun0Run1, Rivet::TriggerCDFRun2, and Rivet::TriggerUA5.

Referenced by Rivet::Event::applyProjection().

◆ setProjectionHandler()

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

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