Rivet API documentation

Rivet 4.1.3

PercentileBase is the base class of all Percentile classes. More...

#include <Percentile.hh>

Inheritance diagram for Rivet::PercentileBase:
Rivet::PercentileTBase< T > Rivet::Percentile< T > Rivet::PercentileXaxis< T >

Public Member Functions

 PercentileBase (Analysis *ana, string projName)
 Constructor.
 PercentileBase ()
 Default constructor.
void selectBins (const Event &)
 Initialize the PercentileBase for a new event.
void copyFrom (const PercentileBase &other)
 Copy information from other PercentileBase.
bool compatible (const PercentileBase &other) const
 check if other PercentileBase is compatible with this.
const vector< pair< float, float > > & centralities () const
 return the list of centrality bins.

Static Public Member Functions

static bool inRange (double x, pair< float, float > range)
 Helper function to check if x is within range.

Detailed Description

PercentileBase is the base class of all Percentile classes.

This base class contains all non-templated variables and infrastructure needed.

Constructor & Destructor Documentation

◆ PercentileBase()

Rivet::PercentileBase::PercentileBase ( Analysis * ana,
string projName )
inline

Constructor.

Constructor requiring a pointer, ana, to the Analysis to which this object belongs and the name of the CentralityProjection, projname, to be used.

Referenced by Rivet::PercentileTBase< T >::PercentileTBase(), Rivet::PercentileTBase< T >::add(), compatible(), and copyFrom().

Member Function Documentation

◆ centralities()

const vector< pair< float, float > > & Rivet::PercentileBase::centralities ( ) const
inline

return the list of centrality bins.

The size of this vector is the same as number of internal analysis objects in the sub class PercentileTBase.

◆ selectBins()

void Rivet::PercentileBase::selectBins ( const Event & )

Initialize the PercentileBase for a new event.

This will perform the assigned CentralityProjection and select out the (indices) of the internal AnalysisObjects that are to be active in this event.

Referenced by Rivet::PercentileTBase< T >::init().


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