class Rivet::CumulantAnalysis::ECorrelator

Rivet::CumulantAnalysis::ECorrelator #

A helper class to calculate all event averages of correlators. More…

#include <Correlators.hh>

Public Functions ##

Public Attributes ##

Detailed Description ##

class Rivet::CumulantAnalysis::ECorrelator;

A helper class to calculate all event averages of correlators.

Useful to construct cumulants. It can be binned in any variable.

Public Functions Documentation ##

function ECorrelator ##

inline ECorrelator(
    vector< int > h,
    vector< double > binIn
)

Constructor. Takes as argument the desired harmonic and number of correlated particles as a generic framework style vector, eg, {2, -2} for «2»_2, no binning.

Todo: Implement functionality for this if needed.

Constructor

Takes as argument the desired harmonic and number of correlated particles as a generic framework style vector, e.g. {2, -2} for «2»_2 and binning.

function ECorrelator ##

inline ECorrelator(
    vector< int > h1In,
    vector< int > h2In,
    vector< double > binIn
)

Constructor for gapped correlator.

Takes as argument the desired harmonics for the two final states, and binning.

function fill ##

inline void fill(
    const double & obs,
    const Correlators & c,
    double weight =1.0
)

Fill the appropriate bin given an input (per event) observable, e.g. centrality.

function fill ##

inline void fill(
    const double & obs,
    const Correlators & c1,
    const Correlators & c2,
    double weight =1.0
)

Fill the appropriate bin given an input (per event) observable, e.g. centrality, with a rapidity gap between two Correlators.

function fill ##

inline void fill(
    const Correlators & c,
    const double & weight =1.0
)

Fill the bins with the appropriate correlator.

Takes the binning directly from the Correlators object, and fills also the reference flow.

function fill ##

inline void fill(
    const Correlators & c1,
    const Correlators & c2,
    const double & weight =1.0
)

Fill bins with the appropriate correlator, and a rapidity gap between two Correlators.

Takes the binning directly from the Correlators object, and also the reference flow.

function getBins ##

inline vector< CorBin > getBins() const

Get a copy of the bin contents.

function getBinPtrs ##

inline vector< CorBinBase * > getBinPtrs()

Return the bins as pointers to the base class.

function getBinX ##

inline vector< double > getBinX() const

Get a copy of the bin x-values.

function getH1 ##

inline vector< int > getH1() const

Get a copy of the h1 harmonic vector.

function getH2 ##

inline vector< int > getH2() const

Get a copy of the h2 harmonic vector.

function setReference ##

inline void setReference(
    CorBin refIn
)

Replace reference flow bin with another, e.g. calculated in another phase space or with other pid.

function getReference ##

inline CorBin getReference() const

Extract the reference flow from a differential event averaged correlator.

function setProfs ##

inline void setProfs(
    vector< string > prIn
)

Set the prIn list of profile histograms associated with the internal bins.

function fillFromProfile ##

inline bool fillFromProfile(
    YODA::AnalysisObjectPtr yao,
    string name
)

Fill bins with content from preloaded histograms.

Public Attributes Documentation ##

variable profs ##

vector< string > profs;

Updated on 2022-08-07 at 20:17:16 +0100