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 Scatter2DPtr 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. Eg. 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, with the number of powers being the size of n. The method can include overflow/underflow bins in the beginning/end of the returned vector, by toggling overflow = true.

const pair< double, double >	intCorrelatorGap (const Correlators &other, vector< int > n1, vector< int > n2) const
	Integrated correlator of n1 harmonic, with the number of powers being the size of n1. 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 eg. integrated <<4>>_2, n1 should be: n1 = {2, 2} and n2 = {-2, -2}.

const vector< pair< double, double > >	pTBinnedCorrelatorsGap (const Correlators &other, vector< int > n1, vector< int > n2, bool oveflow=false) const
	pT differential correlators of n1 harmonic, with the number of powers being the size of n1. 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 eg. differential <<4'>_2, n1 should be: n1 = {2, 2} and n2: n2 = {-2, -2}. To get eg. 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.

	DEFAULT_RIVET_PROJ_CLONE (Correlators)

Public Member Functions inherited from Rivet::Projection
virtual std::string	name () const
	Get the name of the projection.

	Projection ()
	The default constructor.

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

virtual	~Projection ()
	The destructor.

bool	before (const Projection &p) const

virtual const std::set< PdgIdPair >	beamPairs () const

Projection &	addPdgIdPair (PdgId beam1, PdgId beam2)

Public Member Functions inherited from Rivet::ProjectionApplier
	ProjectionApplier ()
	Constructor.

void	markAsOwned () const
	Mark this object as owned by a proj-handler.

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

template<typename PROJ >
const PROJ &	get (const std::string &name) const

const Projection &	getProjection (const std::string &name) const

template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const Projection &proj) const
	Apply the supplied projection on event evt. More...

template<typename PROJ >
const PROJ &	apply (const Event &evt, const Projection &proj) const

template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const PROJ &proj) const
	Apply the supplied projection on event evt. More...

template<typename PROJ >
const PROJ &	apply (const Event &evt, const PROJ &proj) const

template<typename PROJ >
const PROJ &	applyProjection (const Event &evt, const std::string &name) const

template<typename PROJ >
const PROJ &	apply (const Event &evt, const std::string &name) const

template<typename PROJ >
const PROJ &	apply (const std::string &name, const Event &evt) const

Static Public Member Functions
static vector< int >	hVec (int n, int m)
	Construct a harmonic vectors from n harmonics and m number of particles. TODO: In C++14 this can be done much nicer with TMP.

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)

int	compare (const Projection &p) const

void	fillCorrelators (const Particle &p, const double &weight)

const complex< double >	getQ (int n, int p) const

const complex< double >	getP (int n, int p, double pT=0.) const

Protected Member Functions inherited from Rivet::Projection
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.

Cmp< Projection >	mkNamedPCmp (const Projection &otherparent, const std::string &pname) const

Cmp< Projection >	mkPCmp (const Projection &otherparent, const std::string &pname) const

virtual Projection &	operator= (const Projection &)
	Block Projection copying.

Protected Member Functions inherited from Rivet::ProjectionApplier
Log &	getLog () const

ProjectionHandler &	getProjHandler () const
	Get a reference to the ProjectionHandler for this thread.

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

template<typename PROJ >
const PROJ &	addProjection (const PROJ &proj, const std::string &name)
	Register a contained projection (user-facing version) More...

Member Function Documentation

◆ compare()

int Rivet::Correlators::compare ( const Projection & p ) const

inlineprotectedvirtual

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.

Implements Rivet::Projection.

References Rivet::DBL_NAN, and Rivet::Projection::mkPCmp().

◆ project()

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

protectedvirtual

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.

Implements Rivet::Projection.

References Rivet::particles(), Rivet::ParticleBase::phi(), Rivet::ParticleBase::pT(), and Rivet::sum().

Referenced by getMaxValues().

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

include/Rivet/Tools/Correlators.hh
src/Tools/Correlators.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Function Documentation

◆ compare()

◆ project()