Rivet API documentation

Rivet 4.1.3
Rivet::ATLAS::SumET_PB_Centrality Class Referenceabstract

Centrality projection for pPb collisions (one sided). More...

#include <AtlasCommon.hh>

Inheritance diagram for Rivet::ATLAS::SumET_PB_Centrality:
Rivet::SingleValueProjection Rivet::Projection Rivet::ProjectionApplier

Public Member Functions

 SumET_PB_Centrality ()
 Constructor.
 RIVET_DEFAULT_PROJ_CLONE (SumET_PB_Centrality)
 Clone on the heap.
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
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 project (const Event &e)
 Perform the projection on the Event.
CmpState compare (const Projection &p) const
 Compare projections.
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

Centrality projection for pPb collisions (one sided).

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

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

◆ compare()

CmpState Rivet::ATLAS::SumET_PB_Centrality::compare ( const Projection & p) const
inlineprotectedvirtual

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

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

◆ 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

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

◆ project()

void Rivet::ATLAS::SumET_PB_Centrality::project ( const Event & e)
inlineprotectedvirtual

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