Base class providing common functionality for MC jet validation analyses. More...

#include <MC_JetAnalysis.hh>

Inheritance diagram for Rivet::MC_JetAnalysis:

Public Member Functions
	MC_JetAnalysis (const string &name, size_t njet, const string &jetpro_name, double jetptcut=20 *GeV)
	Default constructor.

Analysis methods
virtual void	init ()

virtual void	analyze (const Event &event)

virtual void	finalize ()

Public Member Functions inherited from Rivet::Analysis
Analysis &	setCrossSection (double xs)
	Set the cross section from the generator.

AnalysisHandler &	handler () const
	Access the controlling AnalysisHandler object.

const CentralityProjection &	declareCentrality (const SingleValueProjection &proj, string calAnaName, string calHistName, const string projName, bool increasing=false)
	Book a CentralityProjection. More...

template<class T >
Percentile< T >	bookPercentile (string projName, vector< pair< float, float > > centralityBins, vector< tuple< int, int, int > > ref)
	Book a Pecentile wrapper around AnalysisObjects. More...

template<class T >
PercentileXaxis< T >	bookPercentileXaxis (string projName, tuple< int, int, int > ref)
	Book Pecentile wrappers around AnalysisObjects. More...

const vector< AnalysisObjectPtr > &	analysisObjects () const
	List of registered analysis data objects.

	Analysis (const std::string &name)
	Constructor.

virtual	~Analysis ()
	The destructor.

const AnalysisInfo &	info () const
	Get the actual AnalysisInfo object in which all this metadata is stored.

virtual std::string	name () const
	Get the name of the analysis. More...

virtual std::string	getRefDataName () const

virtual void	setRefDataName (const std::string &ref_data="")

virtual std::string	inspireId () const
	Get the Inspire ID code for this analysis.

virtual std::string	spiresId () const
	Get the SPIRES ID code for this analysis (~deprecated).

virtual std::vector< std::string >	authors () const
	Names & emails of paper/analysis authors. More...

virtual std::string	summary () const
	Get a short description of the analysis. More...

virtual std::string	description () const
	Get a full description of the analysis. More...

virtual std::string	runInfo () const
	Information about the events needed as input for this analysis. More...

virtual std::string	experiment () const
	Experiment which performed and published this analysis.

virtual std::string	collider () const
	Collider on which the experiment ran.

virtual std::string	year () const
	When the original experimental analysis was published.

virtual std::string	luminosityfb () const
	The luminosity in inverse femtobarn.

virtual std::vector< std::string >	references () const
	Journal, and preprint references.

virtual std::string	bibKey () const
	BibTeX citation key for this article.

virtual std::string	bibTeX () const
	BibTeX citation entry for this article.

virtual std::string	status () const
	Whether this analysis is trusted (in any way!)

virtual std::vector< std::string >	todos () const
	Any work to be done on this analysis.

virtual const std::vector< PdgIdPair > &	requiredBeams () const
	Return the allowed pairs of incoming beams required by this analysis.

virtual Analysis &	setRequiredBeams (const std::vector< PdgIdPair > &requiredBeams)
	Declare the allowed pairs of incoming beams required by this analysis.

virtual const std::vector< std::pair< double, double > > &	requiredEnergies () const
	Sets of valid beam energy pairs, in GeV.

virtual const std::vector< std::string > &	keywords () const
	Get vector of analysis keywords.

virtual Analysis &	setRequiredEnergies (const std::vector< std::pair< double, double > > &requiredEnergies)
	Declare the list of valid beam energy pairs, in GeV.

bool	needsCrossSection () const

Analysis &	setNeedsCrossSection (bool needed=true)

AnalysisInfo &	info ()
	Get the actual AnalysisInfo object in which all this metadata is stored (non-const).

const ParticlePair &	beams () const
	Incoming beams for this run.

const PdgIdPair	beamIds () const
	Incoming beam IDs for this run.

double	sqrtS () const
	Centre of mass energy for this run.

bool	merging () const
	Check if we are running rivet-merge.

bool	isCompatible (const ParticlePair &beams) const
	Check if analysis is compatible with the provided beam particle IDs and energies.

bool	isCompatible (PdgId beam1, PdgId beam2, double e1, double e2) const
	Check if analysis is compatible with the provided beam particle IDs and energies.

bool	isCompatible (const PdgIdPair &beams, const std::pair< double, double > &energies) const
	Check if analysis is compatible with the provided beam particle IDs and energies.

std::string	getOption (std::string optname)
	Get an option for this analysis instance as a string.

template<typename T >
T	getOption (std::string optname, T def)

void	scale (CounterPtr cnt, double factor)
	Multiplicatively scale the given counter, cnt, by factor factor.

void	scale (const std::vector< CounterPtr > &cnts, double factor)

template<std::size_t array_size>
void	scale (const CounterPtr(&cnts)[array_size], double factor)

void	normalize (Histo1DPtr histo, double norm=1.0, bool includeoverflows=true)
	Normalize the given histogram, histo, to area = norm.

void	normalize (const std::vector< Histo1DPtr > &histos, double norm=1.0, bool includeoverflows=true)

template<std::size_t array_size>
void	normalize (const Histo1DPtr(&histos)[array_size], double norm=1.0, bool includeoverflows=true)

void	scale (Histo1DPtr histo, double factor)
	Multiplicatively scale the given histogram, histo, by factor factor.

void	scale (const std::vector< Histo1DPtr > &histos, double factor)

template<std::size_t array_size>
void	scale (const Histo1DPtr(&histos)[array_size], double factor)

void	normalize (Histo2DPtr histo, double norm=1.0, bool includeoverflows=true)
	Normalize the given histogram, histo, to area = norm.

void	normalize (const std::vector< Histo2DPtr > &histos, double norm=1.0, bool includeoverflows=true)

template<std::size_t array_size>
void	normalize (const Histo2DPtr(&histos)[array_size], double norm=1.0, bool includeoverflows=true)

void	scale (Histo2DPtr histo, double factor)
	Multiplicatively scale the given histogram, histo, by factor factor.

void	scale (const std::vector< Histo2DPtr > &histos, double factor)

template<std::size_t array_size>
void	scale (const Histo2DPtr(&histos)[array_size], double factor)

void	divide (CounterPtr c1, CounterPtr c2, Scatter1DPtr s) const

void	divide (const YODA::Counter &c1, const YODA::Counter &c2, Scatter1DPtr s) const

void	divide (Histo1DPtr h1, Histo1DPtr h2, Scatter2DPtr s) const

void	divide (const YODA::Histo1D &h1, const YODA::Histo1D &h2, Scatter2DPtr s) const

void	divide (Profile1DPtr p1, Profile1DPtr p2, Scatter2DPtr s) const

void	divide (const YODA::Profile1D &p1, const YODA::Profile1D &p2, Scatter2DPtr s) const

void	divide (Histo2DPtr h1, Histo2DPtr h2, Scatter3DPtr s) const

void	divide (const YODA::Histo2D &h1, const YODA::Histo2D &h2, Scatter3DPtr s) const

void	divide (Profile2DPtr p1, Profile2DPtr p2, Scatter3DPtr s) const

void	divide (const YODA::Profile2D &p1, const YODA::Profile2D &p2, Scatter3DPtr s) const

void	efficiency (Histo1DPtr h1, Histo1DPtr h2, Scatter2DPtr s) const

void	efficiency (const YODA::Histo1D &h1, const YODA::Histo1D &h2, Scatter2DPtr s) const

void	asymm (Histo1DPtr h1, Histo1DPtr h2, Scatter2DPtr s) const

void	asymm (const YODA::Histo1D &h1, const YODA::Histo1D &h2, Scatter2DPtr s) const

void	integrate (Histo1DPtr h, Scatter2DPtr s) const

void	integrate (const Histo1D &h, Scatter2DPtr s) const

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::Analysis
Log &	getLog () const
	Get a Log object based on the name() property of the calling analysis object.

double	crossSection () const
	Get the process cross-section in pb. Throws if this hasn't been set.

double	crossSectionPerEvent () const

size_t	numEvents () const
	Get the number of events seen (via the analysis handler). More...

double	sumW () const
	Get the sum of event weights seen (via the analysis handler). More...

double	sumOfWeights () const
	Alias.

double	sumW2 () const
	Get the sum of squared event weights seen (via the analysis handler). More...

const std::string	histoDir () const
	Get the canonical histogram "directory" path for this analysis. More...

const std::string	histoPath (const std::string &hname) const
	Get the canonical histogram path for the named histogram in this analysis.

const std::string	histoPath (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get the canonical histogram path for the numbered histogram in this analysis.

const std::string	mkAxisCode (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get the internal histogram name for given d, x and y (cf. HepData)

const std::string	makeAxisCode (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const

template<typename T = YODA::Scatter2D>
const T &	refData (const string &hname) const

template<typename T = YODA::Scatter2D>
const T &	refData (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const

CounterPtr	bookCounter (const std::string &name, const std::string &title="")
	Book a counter.

CounterPtr	bookCounter (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="")

Histo1DPtr	bookHisto1D (const std::string &name, size_t nbins, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with nbins uniformly distributed across the range lower - upper .

Histo1DPtr	bookHisto1D (const std::string &name, const std::vector< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with non-uniform bins defined by the vector of bin edges binedges .

Histo1DPtr	bookHisto1D (const std::string &name, const std::initializer_list< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with non-uniform bins defined by the vector of bin edges binedges .

Histo1DPtr	bookHisto1D (const std::string &name, const Scatter2D &refscatter, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram with binning from a reference scatter.

Histo1DPtr	bookHisto1D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D histogram, using the binnings in the reference data histogram.

Histo1DPtr	bookHisto1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")

Histo2DPtr	bookHisto2D (const std::string &name, size_t nxbins, double xlower, double xupper, size_t nybins, double ylower, double yupper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Histo2DPtr	bookHisto2D (const std::string &name, const std::vector< double > &xbinedges, const std::vector< double > &ybinedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Histo2DPtr	bookHisto2D (const std::string &name, const std::initializer_list< double > &xbinedges, const std::initializer_list< double > &ybinedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Histo2DPtr	bookHisto2D (const std::string &name, const Scatter3D &refscatter, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")
	Book a 2D histogram with binning from a reference scatter.

Histo2DPtr	bookHisto2D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")
	Book a 2D histogram, using the binnings in the reference data histogram.

Histo2DPtr	bookHisto2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Profile1DPtr	bookProfile1D (const std::string &name, size_t nbins, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with nbins uniformly distributed across the range lower - upper .

Profile1DPtr	bookProfile1D (const std::string &name, const std::vector< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with non-uniform bins defined by the vector of bin edges binedges .

Profile1DPtr	bookProfile1D (const std::string &name, const std::initializer_list< double > &binedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with non-uniform bins defined by the vector of bin edges binedges .

Profile1DPtr	bookProfile1D (const std::string &name, const Scatter2D &refscatter, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram with binning from a reference scatter.

Profile1DPtr	bookProfile1D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 1D profile histogram, using the binnings in the reference data histogram.

Profile1DPtr	bookProfile1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")

Profile2DPtr	bookProfile2D (const std::string &name, size_t nxbins, double xlower, double xupper, size_t nybins, double ylower, double yupper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Profile2DPtr	bookProfile2D (const std::string &name, const std::vector< double > &xbinedges, const std::vector< double > &ybinedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Profile2DPtr	bookProfile2D (const std::string &name, const std::initializer_list< double > &xbinedges, const std::initializer_list< double > &ybinedges, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Profile2DPtr	bookProfile2D (const std::string &name, const Scatter3D &refscatter, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")
	Book a 2D profile histogram with binning from a reference scatter.

Profile2DPtr	bookProfile2D (const std::string &name, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")
	Book a 2D profile histogram, using the binnings in the reference data histogram.

Profile2DPtr	bookProfile2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

Scatter2DPtr	bookScatter2D (const std::string &name, bool copy_pts=false, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set with the given name. More...

Scatter2DPtr	bookScatter2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId, bool copy_pts=false, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set, using the binnings in the reference data histogram. More...

Scatter2DPtr	bookScatter2D (const std::string &name, size_t npts, double lower, double upper, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set with equally spaced x-points in a range. More...

Scatter2DPtr	bookScatter2D (const std::string &hname, const std::vector< double > &binedges, const std::string &title, const std::string &xtitle, const std::string &ytitle)
	Book a 2-dimensional data point set based on provided contiguous "bin edges". More...

Scatter2DPtr	bookScatter2D (const Scatter2DPtr scPtr, const std::string &path, const std::string &title="", const std::string &xtitle="", const std::string &ytitle="")
	Book a 2-dimensional data point set with x-points from an existing scatter and a new path.

void	addAnalysisObject (AnalysisObjectPtr ao)
	Register a data object in the histogram system. More...

template<typename AO = YODA::AnalysisObject>
std::shared_ptr< AO >	addOrGetCompatAO (std::shared_ptr< AO > aonew)

template<typename AO = YODA::AnalysisObject>
const std::shared_ptr< AO >	getAnalysisObject (const std::string &name) const
	Get a data object from the histogram system.

template<typename AO = YODA::AnalysisObject>
std::shared_ptr< AO >	getAnalysisObject (const std::string &name)
	Get a data object from the histogram system (non-const)

void	removeAnalysisObject (const std::string &path)
	Unregister a data object from the histogram system (by name)

void	removeAnalysisObject (AnalysisObjectPtr ao)
	Unregister a data object from the histogram system (by pointer)

vector< AnalysisObjectPtr >	getAllData (bool includeorphans) const
	Get all data object from the AnalysisHandler.

template<typename AO = YODA::AnalysisObject>
std::shared_ptr< AO >	getAnalysisObject (const std::string &ananame, const std::string &name)

const Histo1DPtr	getHisto1D (const std::string &name) const
	Get a named Histo1D object from the histogram system.

Histo1DPtr	getHisto1D (const std::string &name)
	Get a named Histo1D object from the histogram system (non-const)

const Histo1DPtr	getHisto1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Histo1D object from the histogram system by axis ID codes (non-const)

Histo1DPtr	getHisto1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Histo1D object from the histogram system by axis ID codes (non-const)

const Histo2DPtr	getHisto2D (const std::string &name) const
	Get a named Histo2D object from the histogram system.

Histo2DPtr	getHisto2D (const std::string &name)
	Get a named Histo2D object from the histogram system (non-const)

const Histo2DPtr	getHisto2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Histo2D object from the histogram system by axis ID codes (non-const)

Histo2DPtr	getHisto2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Histo2D object from the histogram system by axis ID codes (non-const)

const Profile1DPtr	getProfile1D (const std::string &name) const
	Get a named Profile1D object from the histogram system.

Profile1DPtr	getProfile1D (const std::string &name)
	Get a named Profile1D object from the histogram system (non-const)

const Profile1DPtr	getProfile1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Profile1D object from the histogram system by axis ID codes (non-const)

Profile1DPtr	getProfile1D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Profile1D object from the histogram system by axis ID codes (non-const)

const Profile2DPtr	getProfile2D (const std::string &name) const
	Get a named Profile2D object from the histogram system.

Profile2DPtr	getProfile2D (const std::string &name)
	Get a named Profile2D object from the histogram system (non-const)

const Profile2DPtr	getProfile2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Profile2D object from the histogram system by axis ID codes (non-const)

Profile2DPtr	getProfile2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Profile2D object from the histogram system by axis ID codes (non-const)

const Scatter2DPtr	getScatter2D (const std::string &name) const
	Get a named Scatter2D object from the histogram system.

Scatter2DPtr	getScatter2D (const std::string &name)
	Get a named Scatter2D object from the histogram system (non-const)

const Scatter2DPtr	getScatter2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId) const
	Get a Scatter2D object from the histogram system by axis ID codes (non-const)

Scatter2DPtr	getScatter2D (unsigned int datasetId, unsigned int xAxisId, unsigned int yAxisId)
	Get a Scatter2D object from the histogram system by axis ID codes (non-const)

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

Base class providing common functionality for MC jet validation analyses.

Todo:: Could reduce duplication by inheriting this from MC_ParticleAnalysis, with minor tweaking

Member Function Documentation

◆ analyze()

void Rivet::MC_JetAnalysis::analyze ( const Event & event )

virtual

Analyze one event. A concrete class should here apply the necessary projections on the event and fill the relevant histograms. An overridden function must make sure it first calls the base class function.

Implements Rivet::Analysis.

References Rivet::deltaPhi(), Rivet::deltaR(), Rivet::min(), Rivet::momentum(), Rivet::ParticleBase::pT(), and Rivet::Event::weight().

◆ finalize()

void Rivet::MC_JetAnalysis::finalize ( )

virtual

Finalize this analysis object. A concrete class should here make all necessary operations on the histograms. Writing the histograms to a file is, however, done by the Rivet class. An overridden function must make sure it first calls the base class function.

Reimplemented from Rivet::Analysis.

References Rivet::Analysis::bookScatter2D(), Rivet::Analysis::crossSection(), Rivet::Analysis::divide(), Rivet::Analysis::scale(), Rivet::Analysis::sumOfWeights(), and Rivet::to_str().

◆ init()

void Rivet::MC_JetAnalysis::init ( )

virtual

Initialize this analysis object. A concrete class should here book all necessary histograms. An overridden function must make sure it first calls the base class function.

Reimplemented from Rivet::Analysis.

References Rivet::Analysis::bookHisto1D(), Rivet::Analysis::bookScatter2D(), Rivet::logspace(), Rivet::min(), Rivet::Analysis::sqrtS(), and Rivet::to_str().

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

include/Rivet/Analyses/MC_JetAnalysis.hh
src/AnalysisTools/MC_JetAnalysis.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ analyze()

◆ finalize()

◆ init()