EventMixingCentrality has centrality as the mixing observable. More...

#include <EventMixingFinalState.hh>

Inheritance diagram for Rivet::EventMixingCentrality:

Public Member Functions
	EventMixingCentrality (const CentralityProjection &mixObsProj, const ParticleFinder &mix, size_t nMixIn, double oMin, double oMax, double deltao, const size_t defaultIdx)

	RIVET_DEFAULT_PROJ_CLONE (EventMixingCentrality)

bool	hasMixingEvents () const

vector< MixEvent >	getMixingEvents () const
	Return a vector of mixing events.

virtual const Particles	particles () const
	Return a vector of particles from the mixing events.

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
virtual void	calculateMixingObs (const Projection *mProj)
	Calculate the mixing observable.

void	project (const Event &e)
	Perform the projection on the Event.

CmpState	compare (const Projection &p) const
	Compare with other 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)

Protected Attributes
double	mObs
	The mixing observable of the current event.

size_t	nMix
	The number of event to mix with.

MixMap	mixEvents
	The event map.

bool	unitWeights
	Using unit weights or not.

Detailed Description

EventMixingCentrality has centrality as the mixing observable.

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.

◆ calculateMixingObs()

virtual void Rivet::EventMixingCentrality::calculateMixingObs ( const Projection * mProj )

inlineprotectedvirtual

Calculate the mixing observable.

Implements Rivet::EventMixingBase.

References Rivet::EventMixingBase::mObs.

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

inlineprotectedvirtualinherited

Compare with other projections.

Implements Rivet::Projection.

References Rivet::Projection::mkNamedPCmp().

◆ 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

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

◆ hasMixingEvents()

bool Rivet::EventMixingBase::hasMixingEvents ( ) const

inlineinherited

Test if we have enough mixing events available for projected, current mixing observable.

References Rivet::EventMixingBase::mixEvents, Rivet::EventMixingBase::mObs, and Rivet::EventMixingBase::nMix.

Referenced by Rivet::EventMixingBase::getMixingEvents(), and Rivet::EventMixingBase::particles().

◆ 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::ATLAS::SumET_PB_Centrality::compare(), Rivet::ATLAS::SumET_PBPB_Centrality::compare(), Rivet::ATLAS::MinBiasTrigger::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::STAR_BES_Centrality::compare(), Rivet::BRAHMSCentrality::compare(), Rivet::Spherocity::compare(), Rivet::Thrust::compare(), Rivet::CentralityEstimator::compare(), and Rivet::GeneratedCentrality::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::Projection::getLog(), Rivet::Projection::setName(), and Rivet::VetoedFinalState::vetoFinalState().

◆ particles()

virtual const Particles Rivet::EventMixingBase::particles ( ) const

inlinevirtualinherited

Return a vector of particles from the mixing events.

Can be overloaded in derived classes, though normally not necessary.

References Rivet::EventMixingBase::hasMixingEvents(), Rivet::EventMixingBase::mixEvents, Rivet::EventMixingBase::mObs, Rivet::rng(), Rivet::EventMixingBase::unitWeights, and Rivet::weighted_shuffle().

◆ project()

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

inlineprotectedvirtualinherited

Perform the projection on the Event.

Implements Rivet::Projection.

References Rivet::EventMixingBase::calculateMixingObs(), Rivet::EventMixingBase::mixEvents, Rivet::EventMixingBase::mObs, MSG_DEBUG, Rivet::EventMixingBase::nMix, Rivet::EventMixingBase::unitWeights, and Rivet::Event::weights().

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

/Users/chrisg/software/rivet/include/Rivet/Projections/EventMixingFinalState.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ apply()

◆ before()

◆ calculateMixingObs()

◆ clone()

◆ compare()

◆ declare() [1/2]

◆ declare() [2/2]

◆ get()

◆ getProjection() [1/2]

◆ getProjection() [2/2]

◆ getProjectionFromDeclQueue()

◆ hasMixingEvents()

◆ mkNamedPCmp()

◆ mkPCmp()

◆ name()

◆ particles()

◆ project()

◆ setProjectionHandler()