Rivet::CentralityProjection Class Reference

CentralityProjection is used together with the percentile-based analysis objects Percentile and PercentileXaxsis. More...

#include <CentralityProjection.hh>

Inheritance diagram for Rivet::CentralityProjection:

Public Member Functions
	CentralityProjection ()
	Default constructor.
	DEFAULT_RIVET_PROJ_CLONE (CentralityProjection)
void	add (const SingleValueProjection &p, string pname)
void	project (const Event &e)
	Perform all internal projections.
bool	empty () const
	Cheek if no internal projections have been added.
double	operator[] (int i) const
int	compare (const Projection &p) const
vector< string >	projections () const
	THe list of names of the internal projections.
Public Member Functions inherited from Rivet::SingleValueProjection
	SingleValueProjection ()
	The default constructor.
bool	isSet () const
	Returns true if the value has been set.
double	operator() () const
	Return the single value.
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

Additional Inherited Members
Protected Member Functions inherited from Rivet::SingleValueProjection
void	set (double v)
	Set the value.
void	clear ()
	Unset the value.
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...

Detailed Description

CentralityProjection is used together with the percentile-based analysis objects Percentile and PercentileXaxsis.

The interior actually defines several different centrality estimates: the centrality observable used in the experiment with a reference calibration ("REF"); the same but using a user-defined calibration done with the corresponding minimum bias analysis ("GEN"); a centrality based on the impact parameter reported in HepMC::HeavyIon::impact_parameter, using a calibration histogram generated with the same minimum bias analysis ("IMP"). For HepMC3 it may optionally also include a direct report from the generator about the centrality, if available in HepMC::HeavyIon::centrality ("RAW"), and a user-defined generated centrality estimate communicated via the HepMC::HeavyIon::user_cent_estimate ("USR").

Author

Leif Lönnblad

Member Function Documentation

add()

void Rivet::CentralityProjection::add ( const SingleValueProjection &  p, string  pname  )

inline

Add a new centality estimate.

The SingelValueProjection, p, should return a value between 0 and 100, and the pname should be one of "REF", "GEN", "IMP", "USR", or "RAW", as described above.

References Rivet::ProjectionApplier::declare().

Referenced by Rivet::Analysis::declareCentrality().

compare()

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

inlinevirtual

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.

operator[]()

double Rivet::CentralityProjection::operator[] ( int  i ) const

inline

Return the percentile of the i'th projection.

Note that operator() will return the zero'th projection.

---

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

• include/Rivet/Projections/CentralityProjection.hh