Acts::Experimental::Efficiency< Dim > Class Template Reference

Multi-dimensional efficiency histogram using boost::histogram. More...

#include <Acts/Utilities/Histogram.hpp>

Inheritance diagram for Acts::Experimental::Efficiency< Dim >:

Public Member Functions
	Efficiency (std::string name, std::string title, const std::array< AxisVariant, Dim > &axes)
	Construct multi-dimensional efficiency histogram.
const BoostHist &	acceptedHistogram () const
	Access to accepted histogram (for converters and tests).
void	fill (const std::array< double, Dim > &values, bool accepted)
	Fill efficiency histogram.
const std::string &	name () const
	Get histogram name.
const std::string &	title () const
	Get histogram title.
const BoostHist &	totalHistogram () const
	Access to total histogram (for converters and tests).

Static Public Member Functions
static constexpr std::size_t	rank ()
	Get number of dimensions (compile-time constant).

Detailed Description

template<std::size_t Dim>
class Acts::Experimental::Efficiency< Dim >

Multi-dimensional efficiency histogram using boost::histogram.

This class tracks pass/total counts for efficiency calculation. It internally uses two multi-dimensional histograms: one for accepted events, one for total events.

Template Parameters

Dim	Number of dimensions

Constructor & Destructor Documentation

Efficiency()

template<std::size_t Dim>

Acts::Experimental::Efficiency< Dim >::Efficiency	(	std::string	name,
		std::string	title,
		const std::array< AxisVariant, Dim > &	axes )

Construct multi-dimensional efficiency histogram.

Parameters

name	Histogram name
title	Histogram title
axes	Array of axes with binning and metadata

Member Function Documentation

acceptedHistogram()

template<std::size_t Dim>

const BoostHist & Acts::Experimental::Efficiency< Dim >::acceptedHistogram

(

)

const

Access to accepted histogram (for converters and tests).

fill()

template<std::size_t Dim>

void Acts::Experimental::Efficiency< Dim >::fill	(	const std::array< double, Dim > &	values,
		bool	accepted )

Fill efficiency histogram.

Parameters

values	Values to fill (one per axis)
accepted	Whether the event passed selection

name()

template<std::size_t Dim>

const std::string & Acts::Experimental::Efficiency< Dim >::name

(

)

const

Get histogram name.

rank()

template<std::size_t Dim>

constexpr std::size_t Acts::Experimental::Efficiency< Dim >::rank ( )

staticconstexpr

Get number of dimensions (compile-time constant).

title()

template<std::size_t Dim>

const std::string & Acts::Experimental::Efficiency< Dim >::title

(

)

const

Get histogram title.

totalHistogram()

template<std::size_t Dim>

const BoostHist & Acts::Experimental::Efficiency< Dim >::totalHistogram

(

)

const

Access to total histogram (for converters and tests).