Rivet::CentralityEstimator Class Reference

Base class for projections profile observable value vs the collision centrality. More...

#include <CentralityBinner.hh>

Inheritance diagram for Rivet::CentralityEstimator:

Public Member Functions
	CentralityEstimator ()
	Constructor.
	RIVET_DEFAULT_PROJ_CLONE (CentralityEstimator)
	Clone on the heap.
double	estimate () const
	The value of the centrality estimate.
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< 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)
	Perform the projection on 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

Base class for projections profile observable value vs the collision centrality.

Author

Leif Lönnblad

The centrality of a collision is not really an observable, but the concept is anyway often used in the heavy ion community as if it were just that.

This base class can be used to provide a an estimator for the centrality by projecting down to a single number which then can be used by a CentralityBinner object to select a histogram to be filled with another observable depending on centrality percentile.

The estimate() should be a non-negative number with large values indicating a higher overlap than small ones. A negative value indicates that the centrality estimate could not be calculated.

In the best of all worlds the centrality estimator should be a proper hadron-level observable corrected for detector effects, however, this base class only returns the inverse of the impact_parameter member of the GenHeavyIon object in an GenEvent if present and zero otherwise.

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

inlineprotectedvirtual

Compare projections.

Implements Rivet::Projection.

Reimplemented in Rivet::GeneratedCentrality.

References Rivet::Projection::Projection(), Rivet::Projection::mkNamedPCmp(), and 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().

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

project()

void Rivet::CentralityEstimator::project ( const Event & e )

inlineprotectedvirtual

Perform the projection on the Event.

Implements Rivet::Projection.

Reimplemented in Rivet::GeneratedCentrality.

References Rivet::ProjectionApplier::apply(), and Rivet::Projection::Event.

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:

• /builds/hepcedar/rivet/include/Rivet/Tools/CentralityBinner.hh