Calculate transverse jet profiles. More...

#include <JetShape.hh>

Inheritance diagram for Rivet::JetShape:

Public Member Functions
void	clear ()
	Reset projection between events.

void	calc (const Jets &jets)
	Do the calculation directly on a supplied collection of Jet objects.

size_t	numBins () const
	Number of equidistant radius bins.

size_t	numJets () const
	Number of jets which passed cuts.

double	rMin () const
	\( r_\text{min} \) value.

double	rMax () const
	\( r_\text{max} \) value.

double	ptMin () const
	\( p_\perp^\text{min} \) value.

double	ptMax () const
	\( p_\perp^\text{max} \) value.

double	rBinMin (size_t rbin) const
	Central \( r \) value for bin rbin.

double	rBinMax (size_t rbin) const
	Central \( r \) value for bin rbin.

double	rBinMid (size_t rbin) const
	Central \( r \) value for bin rbin.

double	diffJetShape (size_t ijet, size_t rbin) const
	Return value of differential jet shape profile histo bin.

double	intJetShape (size_t ijet, size_t rbin) const
	Return value of integrated jet shape profile histo bin.

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.

Constructors etc.
	JetShape (const JetFinder &jetalg, double rmin, double rmax, size_t nbins, double ptmin=0, double ptmax=DBL_MAX, double absrapmin=-DBL_MAX, double absrapmax=-DBL_MAX, RapScheme rapscheme=RAPIDITY)
	Constructor from histo range and number of bins.

	JetShape (const JetFinder &jetalg, vector< double > binedges, double ptmin=0, double ptmax=DBL_MAX, double absrapmin=-DBL_MAX, double absrapmax=-DBL_MAX, RapScheme rapscheme=RAPIDITY)
	Constructor from vector of bin edges.

	RIVET_DEFAULT_PROJ_CLONE (JetShape)
	Clone on the heap.

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)
	Apply the projection to 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

Calculate transverse jet profiles.

Calculate the differential and integral jet shapes in \(P_{\perp}\) for a given set of jets. This particular jet shape projection calculates jet shapes relative to jet centroids, using only the particles associated to each jet, for the hardest \( n \) jets.

The rapidity scheme ( \( \eta \) or \( y \)) has to be specified when invoking the constructor.

The differential jet shape around a given jet axis at distance interval \( r \pm \delta{r}/2 \) is defined as

\[ \rho(r) = \frac{1}{\delta r} \frac{1}{N_\mathrm{jets}} \sum_\mathrm{jets} \frac{P_\perp(r - \delta r/2, r+\delta r/2)}{p_\perp(0, R)} \]

with \( 0 \le r \le R \) and \( P_\perp(r_1, r_2) = \sum_{\in [r_1, r_2)} p_\perp \).

The integral jet shape around a given jet axes until distance \( r \) is defined as

\[ \Psi(r) = \frac{1}{N_\mathrm{jets}} \sum_\mathrm{jets} \frac{P_\perp(0, r)}{p_\perp(0, R)} \]

with \( 0 \le r \le R \) and \( P_\perp(r_1, r_2) = \sum_{\in [r_1, r_2)} p_\perp \).

The constructor expects also the binning in radius \( r \) to be supplied.

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.

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

protectedvirtual

Compare projections.

Implements Rivet::Projection.

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

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

◆ project()

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

protectedvirtual

Apply the projection to the event.

Todo:: Provide int and diff jet shapes with some sort of area normalisation?

Implements Rivet::Projection.

◆ 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/JetShape.hh

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ apply()

◆ before()

◆ clone()

◆ compare()

◆ declare() [1/2]

◆ declare() [2/2]

◆ get()

◆ getProjection() [1/2]

◆ getProjection() [2/2]

◆ getProjectionFromDeclQueue()

◆ mkNamedPCmp()

◆ mkPCmp()

◆ name()

◆ project()

◆ setProjectionHandler()