rivet is hosted by Hepforge, IPPP Durham
Rivet  2.7.0
Rivet::CumulantAnalysis::ECorrelator Class Reference

The ECorrelator is a helper class to calculate all event averages of correlators, in order to construct cumulants. It can be binned in any variable. More...

#include <Correlators.hh>

Public Member Functions

 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. More...
 
 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.
 
void fill (const double &obs, const Correlators &c, const double weight=1.0)
 Fill the appropriate bin given an input (per event) observable, eg. centrality.
 
void fill (const double &obs, const Correlators &c1, const Correlators &c2, const double weight=1.0)
 Fill the appropriate bin given an input (per event) observable, eg. centrality. Using a rapidity gap between two Correlators.
 
void fill (const Correlators &c, const double &weight=1.0)
 Fill the bins with the appropriate correlator, taking the binning directly from the Correlators object, and filling also the reference flow.
 
void fill (const Correlators &c1, const Correlators &c2, const double &weight=1.0)
 Fill bins with the appropriate correlator, taking the binning directly from the Correlators object, and also the reference flow. Using a rapidity gap between two Correlators.
 
const vector< CorBin > getBins () const
 Get a copy of the bin contents.
 
const vector< CorBinBase * > getBinPtrs ()
 
const vector< double > getBinX () const
 Get a copy of the bin x-values.
 
const vector< int > getH1 () const
 Get a copy of the h1 harmonic vector.
 
const vector< int > getH2 () const
 Get a copy of the h2 harmonic vector.
 
void setReference (CorBin refIn)
 Replace reference flow bin with another reference flow bin, eg. calculated in another phase space or with other pid.
 
const CorBin getReference () const
 Extract the reference flow from a differential event averaged correlator.
 
void setProfs (list< Profile1DPtr > prIn)
 set the prIn list of profile histograms associated with the internal bins. Is called automatically when booking, no need to call it yourself.
 
void fillFromProfs ()
 Fill bins with content from preloaded histograms.
 
list< Profile1DPtr >::iterator profBegin ()
 begin() iterator for the list of associated profile histograms.
 
list< Profile1DPtr >::iterator profEnd ()
 end() iterator for the list of associated profile histograms.
 

Detailed Description

The ECorrelator is a helper class to calculate all event averages of correlators, in order to construct cumulants. It can be binned in any variable.

Constructor & Destructor Documentation

◆ ECorrelator()

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

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, eg, {2, -2} for <<2>>_2 and binning.


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