Get the transverse spherocity scalars for hadron-colliders. More...

#include <Spherocity.hh>

Inheritance diagram for Rivet::Spherocity:

Public Member Functions
	Spherocity (const FinalState &fsp)
	Constructor.

	DEFAULT_RIVET_PROJ_CLONE (Spherocity)
	Clone on the heap.

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

Spherocity scalar accessors
double	spherocity () const
	The spherocity scalar, \( S \), (minimum spherocity).

Spherocity axis accessors
const Vector3 &	spherocityAxis () const
	The spherocity axis.

const Vector3 &	spherocityMajorAxis () const
	The spherocity major axis (axis of max spherocity perpendicular to spherocity axis).

const Vector3 &	spherocityMinorAxis () const
	The spherocity minor axis (axis perpendicular to spherocity and spherocity major).

AxesDefinition axis accessors.
const Vector3 &	axis1 () const

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

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

Direct methods
Ways to do the calculation directly, without engaging the caching system
void	calc (const FinalState &fs)
	Manually calculate the spherocity, without engaging the caching system.

void	calc (const vector< Particle > &fsparticles)
	Manually calculate the spherocity, without engaging the caching system.

void	calc (const vector< FourMomentum > &fsmomenta)
	Manually calculate the spherocity, without engaging the caching system.

void	calc (const vector< Vector3 > &threeMomenta)
	Manually calculate the spherocity, without engaging the caching system.

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

Get the transverse spherocity scalars for hadron-colliders.

Author: Holger Schulz

The scalar (minimum) transverse spherocity is defined as

\[ S = \frac{\pi^2}{4} \mathrm{min}_{\vec{n}_\perp} \left( \frac{\sum_i \left|\vec{p}_{\perp,i} \times \vec{n}_\perp \right|}{\sum_i |\vec{p}_{\perp,i}|} \right)^2 \]

, with the direction of the unit vector \( \vec{n_\perp} \) which minimises \( T \) being identified as the spherocity axis. The unit vector which maximises the spherocity scalar in the plane perpendicular to \( \vec{n} \) is the "spherocity major" direction, and the vector perpendicular to both the spherocity and spherocity major directions is the spherocity minor. Both the major and minor directions have associated spherocity scalars.

Care must be taken in the case of Drell-Yan processes - there we should use the newly proposed observable \( a_T \).

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

const Vector3 & Rivet::Spherocity::axis1 ( ) const

inlinevirtual

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

Implements Rivet::AxesDefinition.

References spherocityAxis().

◆ axis2()

const Vector3 & Rivet::Spherocity::axis2 ( ) const

inlinevirtual

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

Implements Rivet::AxesDefinition.

References spherocityMajorAxis().

◆ axis3()

const Vector3 & Rivet::Spherocity::axis3 ( ) const

inlinevirtual

The least significant ("minor") axis.

Implements Rivet::AxesDefinition.

References spherocityMinorAxis().

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

Clone on the heap.

Implements Rivet::Projection.

◆ compare()

CmpState Rivet::Spherocity::compare ( const Projection & p ) const

inlineprotectedvirtual

Compare projections.

Implements Rivet::Projection.

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

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

inlineprotectedvirtual

Perform the projection on the Event.

Implements Rivet::Projection.

References calc().

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

/Users/chrisg/software/rivet/include/Rivet/Projections/Spherocity.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()