Base class for projections which define a spatial basis. More...

#include <AxesDefinition.hh>

Inheritance diagram for Rivet::AxesDefinition:

Public Member Functions
virtual	~AxesDefinition ()
	Virtual destructor.

virtual unique_ptr< Projection >	clone () const =0
	Clone on the heap. More...


virtual const Vector3 &	axis1 () const =0

virtual const Vector3 &	axis2 () const =0
	The 2nd most significant ("major") axis. More...

virtual const Vector3 &	axis3 () const =0
	The least significant ("minor") axis. More...

Standard constructors and destructors.
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
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.

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
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 which define a spatial basis.

A pure virtual interface for projections which define a set of 3 basis vectors. This allows e.g. Thrust and Sphericity to be used interchangeably as defining bases for e.g. hemisphere mass and broadening calculations.

Author: Andy Buckley

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

◆ axis1()

virtual const Vector3 & Rivet::AxesDefinition::axis1 ( ) const

pure virtual

Axis accessors, in decreasing order of significance. The main axis.

Implemented in Rivet::Sphericity, Rivet::Spherocity, and Rivet::Thrust.

◆ axis2()

virtual const Vector3 & Rivet::AxesDefinition::axis2 ( ) const

pure virtual

The 2nd most significant ("major") axis.

Implemented in Rivet::Sphericity, Rivet::Spherocity, and Rivet::Thrust.

◆ axis3()

virtual const Vector3 & Rivet::AxesDefinition::axis3 ( ) const

pure virtual

The least significant ("minor") axis.

Implemented in Rivet::Sphericity, Rivet::Spherocity, and Rivet::Thrust.

◆ 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::AxesDefinition::clone ( ) const

pure virtual

Clone on the heap.

Implements Rivet::Projection.

◆ 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::TriggerCDFRun0Run1, Rivet::TriggerCDFRun2, Rivet::TriggerProjection, Rivet::TriggerUA5, 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::BeamThrust, Rivet::CentralEtHCM, Rivet::CentralityProjection, Rivet::ChargedFinalState, Rivet::DISDiffHadron, Rivet::DISFinalState, Rivet::DISKinematics, Rivet::DISLepton, Rivet::DISRapidityGap, Rivet::DressedLeptons, Rivet::EventMixingBase, Rivet::FastJets, 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::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::MergedFinalState, Rivet::MissingMomentum, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::ParisiTensor, Rivet::ParticleFinder, Rivet::PartonicTops, Rivet::PercentileProjection, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::SmearedJets, Rivet::SmearedMET, Rivet::SmearedParticles, Rivet::Sphericity, Rivet::Spherocity, Rivet::TauFinder, Rivet::Thrust, Rivet::UserCentEstimate, Rivet::VetoedFinalState, Rivet::VisibleFinalState, Rivet::WFinder, Rivet::ZFinder, Rivet::ATLAS::SumET_PB_Centrality, Rivet::ATLAS::SumET_PBPB_Centrality, Rivet::ATLAS::MinBiasTrigger, Rivet::CentralityEstimator, Rivet::GeneratedCentrality, Rivet::Correlators, Rivet::STAR_BES_Centrality, Rivet::BRAHMSCentrality, and Rivet::JetFinder.

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

◆ 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(), Rivet::CentralityEstimator::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()

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::MC_SumETFwdPbCentrality, Rivet::ALICE::V0Multiplicity< MODE >, Rivet::ALICE::CLMultiplicity< INNER >, Rivet::ALICE::V0Trigger< MODE >, Rivet::ALICE::V0AndTrigger, Rivet::Beam, Rivet::BeamThrust, Rivet::CentralEtHCM, Rivet::CentralityProjection, Rivet::ChargedFinalState, Rivet::DISDiffHadron, Rivet::DISFinalState, Rivet::DISKinematics, Rivet::DISLepton, Rivet::DISRapidityGap, Rivet::DressedLeptons, 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::LossyFinalState< FILTER >, Rivet::LossyFinalState< ConstRandomFilter >, Rivet::MergedFinalState, Rivet::MissingMomentum, Rivet::NeutralFinalState, Rivet::NonHadronicFinalState, Rivet::NonPromptFinalState, Rivet::ParisiTensor, Rivet::PercentileProjection, Rivet::PrimaryHadrons, Rivet::PrimaryParticles, Rivet::PromptFinalState, Rivet::SmearedJets, Rivet::SmearedMET, Rivet::SmearedParticles, Rivet::Sphericity, Rivet::Spherocity, Rivet::TauFinder, Rivet::Thrust, Rivet::TriggerProjection, Rivet::UndressBeamLeptons, Rivet::UnstableParticles, Rivet::UserCentEstimate, Rivet::VetoedFinalState, Rivet::VisibleFinalState, Rivet::WFinder, Rivet::ZFinder, Rivet::ATLAS::SumET_PB_Centrality, Rivet::ATLAS::SumET_PBPB_Centrality, Rivet::CentralityEstimator, Rivet::GeneratedCentrality, Rivet::Correlators, Rivet::STAR_BES_Centrality, Rivet::BRAHMSCentrality, Rivet::JetFinder, Rivet::ParticleFinder, Rivet::MC_pPbMinBiasTrigger, Rivet::PartonicTops, Rivet::ATLAS::MinBiasTrigger, Rivet::ChargedLeptons, Rivet::TriggerCDFRun0Run1, Rivet::TriggerCDFRun2, and Rivet::TriggerUA5.

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

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

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

Public Member Functions

Protected Member Functions

Beam configuration

Projection applying functions

Detailed Description

Member Function Documentation

◆ addPdgIdPair()

◆ applyProjection() [1/3]

◆ applyProjection() [2/3]

◆ applyProjection() [3/3]

◆ axis1()

◆ axis2()

◆ axis3()

◆ beamPairs()

◆ before()

◆ clone()

◆ compare()

◆ declare() [1/2]

◆ declare() [2/2]

◆ declareProjection()

◆ get()

◆ getProjection() [1/2]

◆ getProjection() [2/2]

◆ mkNamedPCmp()

◆ mkPCmp()

◆ name()

◆ project()