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.
	DEFAULT_RIVET_PROJ_CLONE (CentralityEstimator)
	Clone on the heap.
double	estimate () const
	The value of the centrality estimate.
Standard constructors and destructors.
virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap. More...
virtual std::string	name () const
	Get the name of the projection. More...
bool	valid () const
	Get the state of the projetion.
bool	failed () const
	Get the state of the projetion.
Projection operation and comparison
bool	before (const Projection &p) const
Projection "getting" functions
std::set< ConstProjectionPtr >	getProjections () const
	Get the contained projections, including 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

Protected Member Functions
void	project (const Event &e)
	Perform the projection on the Event. More...
CmpState	compare (const Projection &p) const
	Compare projections. More...
Projection registration functions
template<typename PROJ >
const PROJ &	declareProjection (const PROJ &proj, const std::string &name)
	Register a contained projection. More...
template<typename PROJ >
const PROJ &	declare (const PROJ &proj, const std::string &name)
	Register a contained projection (user-facing version) More...
template<typename PROJ >
const PROJ &	declare (const std::string &name, const PROJ &proj)
	Register a contained projection (user-facing, arg-reordered version) More...

Beam configuration
Todo: Does it really make sense to restrict Projections to particular beam configs? Do we use this in practice?
virtual const std::set< PdgIdPair >	beamPairs () const
Projection &	addPdgIdPair (PdgId beam1, PdgId beam2)
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

Projection applying functions
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	applyProjection (const Event &evt, const Projection &proj) const
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	applyProjection (const Event &evt, const PROJ &proj) const
template<typename PROJ = Projection>
std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & >	applyProjection (const Event &evt, const std::string &name) const
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 (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 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).
void	markAsOwned () const
	Mark this object as owned by a proj-handler.
ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.

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

addPdgIdPair()

Projection & Rivet::Projection::addPdgIdPair ( PdgId  beam1, PdgId  beam2  )

inlineinherited

Add a colliding beam pair.

Todo:

This deserves a better name!

applyProjection() [1/3]

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event &  evt, const PROJ &  proj  ) const

inlineinherited

Apply the supplied projection on event evt.

Deprecated:

Prefer the simpler apply<> form

applyProjection() [2/3]

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event &  evt, const Projection &  proj  ) const

inlineinherited

Apply the supplied projection on event evt.

Deprecated:

Prefer the simpler apply<> form

applyProjection() [3/3]

template<typename PROJ = Projection>

std::enable_if_t< std::is_base_of< Projection, PROJ >::value, const PROJ & > Rivet::ProjectionApplier::applyProjection ( const Event &  evt, const std::string &  name  ) const

inlineinherited

Apply the named projection on event evt.

Deprecated:

Prefer the simpler apply<> form

References Rivet::ProjectionApplier::name().

beamPairs()

virtual const std::set< PdgIdPair > Rivet::Projection::beamPairs ( ) const

virtualinherited

Return the allowed beam pairs on which this projection can operate, not including recursion. Derived classes should ensure that all contained projections are registered in the _projections set for the beam constraint chaining to work.

Todo:

Remove the beam constraints system from projections.

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

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

pure virtualinherited

Clone on the heap.

Implemented in Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0AndTrigger, Rivet::ALICE::PrimaryParticles, 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::mkNamedPCmp(), and Rivet::Kin::p().

declare() [1/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declare ( const PROJ &  proj, const std::string &  name  )

inlineprotectedinherited

Register a contained projection (user-facing version)

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name().

Referenced by Rivet::CentralEtHCM::CentralEtHCM(), CentralityEstimator(), Rivet::ChargedLeptons::ChargedLeptons(), Rivet::ALICE::CLMultiplicity< INNER >::CLMultiplicity(), Rivet::DISDiffHadron::DISDiffHadron(), Rivet::DISFinalState::DISFinalState(), Rivet::DISKinematics::DISKinematics(), Rivet::DISLepton::DISLepton(), Rivet::GammaGammaFinalState::GammaGammaFinalState(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), 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::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::SmearedJets::SmearedJets(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedParticles::SmearedParticles(), 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::CentralityProjection::add(), Rivet::VetoedFinalState::addVetoOnThisFinalState(), and Rivet::CentralityBinner< T, MDist >::setProjection().

declare() [2/2]

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declare ( const std::string &  name, const PROJ &  proj  )

inlineprotectedinherited

Register a contained projection (user-facing, arg-reordered version)

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::declareProjection(), and Rivet::ProjectionApplier::name().

declareProjection()

template<typename PROJ >

const PROJ & Rivet::ProjectionApplier::declareProjection ( const PROJ &  proj, const std::string &  name  )

inlineprotectedinherited

Register a contained projection.

The type of the argument is used to instantiate a new projection internally: this new object is applied to events rather than the argument object. Hence you are advised to only use locally-scoped Projection objects in your Projection and Analysis constructors, and to avoid polymorphism (e.g. handling ConcreteProjection via a pointer or reference to type Projection) since this will screw up the internal type management.

Todo:

Add SFINAE to require that PROJ inherit from Projection

References Rivet::ProjectionApplier::name().

Referenced by Rivet::ProjectionApplier::declare().

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 Rivet::ProjectionApplier::name().

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(), Rivet::ProjectionApplier::getProjHandler(), Rivet::ProjectionApplier::name(), and Rivet::Kin::p().

Referenced by Rivet::CentralityProjection::compare(), 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(), Rivet::ProjectionApplier::getProjHandler(), and Rivet::ProjectionApplier::name().

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.

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

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

Get the name of the projection.

Implements Rivet::ProjectionApplier.

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

project()

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

inlineprotectedvirtual

Perform the projection on the Event.

Implements Rivet::Projection.

Reimplemented in Rivet::GeneratedCentrality.

References Rivet::max().

---

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

• /Users/chrisg/software/rivet/include/Rivet/Tools/CentralityBinner.hh