Rivet::Correlators Class Reference

Projection for calculating correlators for flow measurements. More...

#include <Correlators.hh>

Inheritance diagram for Rivet::Correlators:

Public Member Functions
	Correlators (const ParticleFinder &fsp, int nMaxIn=2, int pMaxIn=0, vector< double > pTbinEdgesIn={})
	Correlators (const ParticleFinder &fsp, int nMaxIn, int pMaxIn, const YODA::Estimate1D hIn)
const pair< double, double >	intCorrelator (vector< int > n) const
	Integrated correlator of n harmonic, with the number of powers being the size of n. E.G. n should be: <<2>>_2 => n = {2, -2} <<4>>_2 => n = {2, 2, -2, -2} <<2>>_4 => n = {4, -4} <<4>>_4 => n = {4, 4, -4, 4}, and so on.
const vector< pair< double, double > >	pTBinnedCorrelators (vector< int > n, bool overflow=false) const
	pT differential correlator of n harmonic, for number of powers n.size()
const pair< double, double >	intCorrelatorGap (const Correlators &other, vector< int > n1, vector< int > n2) const
	Integrated correlator of n1 harmonic, for number of powers n1.size()
const vector< pair< double, double > >	pTBinnedCorrelatorsGap (const Correlators &other, vector< int > n1, vector< int > n2, bool overflow=false) const
	pT differential correlators of n1 harmonic, for number n1.size()
	RIVET_DEFAULT_PROJ_CLONE (Correlators)
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).

Static Public Member Functions
static vector< int >	hVec (int n, int m)
	Construct a harmonic vectors from n harmonics and m number of particles.
static pair< int, int >	getMaxValues (vector< vector< int > > &hList)
	Return the maximal values for n, p to be used in the constructor of Correlators(xxx, nMax, pMax, xxxx)

Protected Member Functions
void	project (const Event &e)
	Loop over array and calculates Q and P vectors if needed.
CmpState	compare (const Projection &p) const
	Compare to other projection, testing harmonics, pT bins and underlying final state similarity.
void	fillCorrelators (const Particle &p, const double &weight)
	Calculate correlators from one particle.
const complex< double >	getQ (int n, int p) const
	Return a Q-vector.
const complex< double >	getP (int n, int p, double pT=0.) const
	Return a P-vector.
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

Projection for calculating correlators for flow measurements.

A projection which calculates Q-vectors and P-vectors, and projects them out as correlators. Implementation follows the description of the ''Generic Framework'':
Phys. Rev. C 83 (2011) 044913, arXiv: 1010.0233
Phys. Rev. C 89 (2014) 064904, arXiv: 1312.3572

Constructor & Destructor Documentation

Correlators()

Rivet::Correlators::Correlators	(	const ParticleFinder &	fsp,
		int	nMaxIn = 2,
		int	pMaxIn = 0,
		vector< double >	pTbinEdgesIn = {}
	)

Constructor

Parameters

fsp	The FinalState projection that the correlators should be constructed from
nMaxIn	The maximal sum of harmonics, e.g. for c_2{2} = {2,-2} = 2 + 2 = 4 c_2{4} = {2,2,-2,-2} = 2 + 2 + 2 + 2 = 8 c_4{2} = {4,-4} = 4 + 4 = 8 c_4{4} = {4,4,-4,-4} = 4 + 4 + 4 + 4 = 16.
pMaxIn	The maximal number of particles you want to correlate
pTbinEdgesIn	The (lower) edges of pT bins, the last one the upper edge of the final bin.

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

inlineprotectedvirtual

Compare to other projection, testing harmonics, pT bins and underlying final state similarity.

Implements Rivet::Projection.

References Rivet::Projection::mkPCmp().

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

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::EventMixingBase::EventMixingBase(), Rivet::GammaGammaKinematics::GammaGammaKinematics(), Rivet::GammaGammaLeptons::GammaGammaLeptons(), 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::LossyFinalState< FILTER >::LossyFinalState(), Rivet::MC_pPbMinBiasTrigger::MC_pPbMinBiasTrigger(), Rivet::MC_SumETFwdPbCentrality::MC_SumETFwdPbCentrality(), Rivet::ATLAS::MinBiasTrigger::MinBiasTrigger(), Rivet::MissingMomentum::MissingMomentum(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NeutralFinalState::NeutralFinalState(), Rivet::NonHadronicFinalState::NonHadronicFinalState(), Rivet::ParisiTensor::ParisiTensor(), Rivet::PercentileProjection::PercentileProjection(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::PrimaryHadrons::PrimaryHadrons(), Rivet::SmearedMET::SmearedMET(), Rivet::SmearedMET::SmearedMET(), 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::VisibleFinalState::VisibleFinalState(), Rivet::CentralityProjection::add(), Rivet::CentralityBinner< T, MDist >::setProjection(), and Rivet::VetoedFinalState::vetoFinalState().

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.

hVec()

static vector< int > Rivet::Correlators::hVec ( int  n, int  m  )

inlinestatic

Construct a harmonic vectors from n harmonics and m number of particles.

Todo:

In C++14 this can be done much nicer with TMP.

Referenced by Rivet::CumulantAnalysis::bookECorrelator(), Rivet::CumulantAnalysis::bookECorrelator(), and Rivet::CumulantAnalysis::bookECorrelatorGap().

intCorrelatorGap()

const pair< double, double > Rivet::Correlators::intCorrelatorGap	(	const Correlators &	other,
		vector< int >	n1,
		vector< int >	n2
	)		const

Integrated correlator of n1 harmonic, for number of powers n1.size()

This method imposes an eta gap, correlating with another phase space, where another Correlators projection other should be defined. The harmonics of the other phase space is given as n2.

To get e.g. integrated <<4>>_2, n1 should be: n1 = {2, 2} and n2 = {-2, -2}

Referenced by Rivet::CumulantAnalysis::ECorrelator::fill(), and Rivet::CumulantAnalysis::ECorrelator::fill().

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 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::Correlators::project ( const Event &  e )

protectedvirtual

Loop over array and calculates Q and P vectors if needed.

Implements Rivet::Projection.

pTBinnedCorrelators()

const vector< pair< double, double > > Rivet::Correlators::pTBinnedCorrelators	(	vector< int >	n,
		bool	overflow = false
	)		const

pT differential correlator of n harmonic, for number of powers n.size()

The method can include overflow/underflow bins in the beginning/end of the returned vector, by toggling overflow = true.

Referenced by Rivet::CumulantAnalysis::ECorrelator::fill().

pTBinnedCorrelatorsGap()

const vector< pair< double, double > > Rivet::Correlators::pTBinnedCorrelatorsGap	(	const Correlators &	other,
		vector< int >	n1,
		vector< int >	n2,
		bool	overflow = false
	)		const

pT differential correlators of n1 harmonic, for number n1.size()

This method imposes an eta gap, correlating with another phase space, where another Correlators projection other should be defined. The harmonics of the other phase space is given as n2.

To get e.g. differential <<4'>_2, n1 should be: n1 = {2, 2} and n2: n2 = {-2, -2}. To get e.g. differential <<2'>>_4, n1 should be: n1 = {4} and n2: n2 = {-4}. The method can include overflow/underflow bins in the beginning/end of the returned vector, by toggling overflow = true.

Referenced by Rivet::CumulantAnalysis::ECorrelator::fill().

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/Tools/Correlators.hh