Common base class for all Axis instances. More...

#include <Acts/Utilities/IAxis.hpp>

Inheritance diagram for Acts::IAxis:

Public Member Functions
	IAxis (std::optional< AxisDirection > direction)
	Constructs a new axis with the given direction.
virtual std::size_t	getBin (double x) const =0
	Get corresponding bin index for given coordinate.
virtual double	getBinCenter (std::size_t bin) const =0
	Get bin center.
virtual std::vector< double >	getBinEdges () const =0
	Returns a vector of bin edges.
virtual double	getBinLowerBound (std::size_t bin) const =0
	Get lower bound of bin.
virtual double	getBinUpperBound (std::size_t bin) const =0
	Get upper bound of bin.
virtual double	getBinWidth (std::size_t bin) const =0
	Get bin width.
virtual AxisBoundaryType	getBoundaryType () const =0
	Returns the boundary type set in the template param.
std::optional< AxisDirection >	getDirection () const
	Returns the direction of the axis.
virtual double	getMax () const =0
	Get maximum of binning range.
virtual double	getMin () const =0
	Get minimum of binning range.
virtual std::size_t	getNBins () const =0
	Get total number of bins.
virtual AxisType	getType () const =0
	Returns the type of the axis.
virtual bool	isEquidistant () const =0
	Returns whether the axis is equidistant.
virtual bool	isInside (double x) const =0
	Check whether value is inside axis limits.
virtual bool	isVariable () const =0
	Returns whether the axis is variable.
template<typename callable_t>
decltype(auto)	visit (const callable_t &callable) const
	Helper function that dispatches from the `IAxis` base class to a concrete axis type.

Static Public Member Functions
static std::unique_ptr< IAxis >	createEquidistant (AxisBoundaryType aBoundaryType, double min, double max, std::size_t nbins, std::optional< AxisDirection > direction=std::nullopt)
	Centralized axis factory for equidistant binning.
static std::unique_ptr< IAxis >	createVariable (AxisBoundaryType aBoundaryType, const std::vector< double > &edges, std::optional< AxisDirection > direction=std::nullopt)
	Centralized axis factory for variable binning.

Protected Member Functions
virtual void	toStream (std::ostream &os) const =0
	Dispatch to the correct stream operator.

Detailed Description

Common base class for all Axis instances.

This allows generice handling such as for inspection.

Constructor & Destructor Documentation

◆ IAxis()

Acts::IAxis::IAxis ( std::optional< AxisDirection > direction )

explicit

Constructs a new axis with the given direction.

Parameters

direction the optional direction of the axis

Member Function Documentation

◆ createEquidistant()

std::unique_ptr< IAxis > Acts::IAxis::createEquidistant	(	AxisBoundaryType	aBoundaryType,
		double	min,
		double	max,
		std::size_t	nbins,
		std::optional< AxisDirection >	direction = std::nullopt )

static

Centralized axis factory for equidistant binning.

Parameters

aBoundaryType	the axis boundary type
min	the minimum edge of the axis
max	the maximum edge of the axis
nbins	the number of bins
direction	the optional direction of the axis

Exceptions

std::invalid_argument if min >= max or nbins == 0

Returns: a unique pointer to the axis

◆ createVariable()

std::unique_ptr< IAxis > Acts::IAxis::createVariable	(	AxisBoundaryType	aBoundaryType,
		const std::vector< double > &	edges,
		std::optional< AxisDirection >	direction = std::nullopt )

static

Centralized axis factory for variable binning.

Parameters

aBoundaryType	the axis boundary type
edges	are the bin edges
direction	the optional direction of the axis

Exceptions

std::invalid_argument if edges is empty or not strictly increasing

Returns: a unique pointer to the axis

◆ getBin()

virtual std::size_t Acts::IAxis::getBin ( double x ) const

pure virtual

Get corresponding bin index for given coordinate.

Parameters

[in] x input coordinate

Returns: index of bin containing the given value

Note: Bin indices start at 1. The underflow bin has the index 0 while the index nBins + 1 indicates the overflow bin .

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getBinCenter()

virtual double Acts::IAxis::getBinCenter ( std::size_t bin ) const

pure virtual

Get bin center.

Parameters

bin	index of bin

Returns: bin center position

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getBinEdges()

virtual std::vector< double > Acts::IAxis::getBinEdges ( ) const

pure virtual

Returns a vector of bin edges.

Returns: Vector which contains the bin edges

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getBinLowerBound()

virtual double Acts::IAxis::getBinLowerBound ( std::size_t bin ) const

pure virtual

Get lower bound of bin.

Parameters

bin	index of bin

Returns: lower bin boundary

Note: Bin intervals have a closed lower bound, i.e. the lower boundary belongs to the bin with the given bin index.

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getBinUpperBound()

virtual double Acts::IAxis::getBinUpperBound ( std::size_t bin ) const

pure virtual

Get upper bound of bin.

Parameters

bin	index of bin

Returns: upper bin boundary

Note: Bin intervals have an open upper bound, i.e. the upper boundary does not belong to the bin with the given bin index.

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getBinWidth()

virtual double Acts::IAxis::getBinWidth ( std::size_t bin ) const

pure virtual

Get bin width.

Parameters

bin	index of bin

Returns: width of given bin

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getBoundaryType()

virtual AxisBoundaryType Acts::IAxis::getBoundaryType ( ) const

pure virtual

Returns the boundary type set in the template param.

Returns: AxisBoundaryType of this axis

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getDirection()

std::optional< AxisDirection > Acts::IAxis::getDirection ( ) const

Returns the direction of the axis.

Returns: AxisDirection of this axis

◆ getMax()

virtual double Acts::IAxis::getMax ( ) const

pure virtual

Get maximum of binning range.

Returns: maximum of binning range

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getMin()

virtual double Acts::IAxis::getMin ( ) const

pure virtual

Get minimum of binning range.

Returns: minimum of binning range

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getNBins()

virtual std::size_t Acts::IAxis::getNBins ( ) const

pure virtual

Get total number of bins.

Returns: total number of bins (excluding under-/overflow bins)

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ getType()

virtual AxisType Acts::IAxis::getType ( ) const

pure virtual

Returns the type of the axis.

Returns: AxisType of this axis

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ isEquidistant()

virtual bool Acts::IAxis::isEquidistant ( ) const

pure virtual

Returns whether the axis is equidistant.

Returns: bool is equidistant

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ isInside()

virtual bool Acts::IAxis::isInside ( double x ) const

pure virtual

Check whether value is inside axis limits.

Parameters

x	The value to check

Returns: true if the value is within the axis range, otherwise false

Postcondition: If true is returned, the bin containing the given value is a valid bin, i.e. it is neither the underflow nor the overflow bin.

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ isVariable()

virtual bool Acts::IAxis::isVariable ( ) const

pure virtual

Returns whether the axis is variable.

Returns: bool is variable

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ toStream()

virtual void Acts::IAxis::toStream ( std::ostream & os ) const

protectedpure virtual

Dispatch to the correct stream operator.

Parameters

os	output stream

Implemented in Acts::Axis< AxisType::Equidistant, bdt >, and Acts::Axis< AxisType::Variable, bdt >.

◆ visit()

template<typename callable_t>

decltype(auto) Acts::IAxis::visit ( const callable_t & callable ) const

Helper function that dispatches from the IAxis base class to a concrete axis type.

It will call the provided callable with a const reference to the concrete axis type.

Template Parameters

callable_t the callable type

Parameters

callable the callable object

Returns: the value returned by the callable

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IAxis()

Member Function Documentation

◆ createEquidistant()

◆ createVariable()

◆ getBin()

◆ getBinCenter()

◆ getBinEdges()

◆ getBinLowerBound()

◆ getBinUpperBound()

◆ getBinWidth()

◆ getBoundaryType()

◆ getDirection()

◆ getMax()

◆ getMin()

◆ getNBins()

◆ getType()

◆ isEquidistant()

◆ isInside()

◆ isVariable()

◆ toStream()

◆ visit()