Acts::DirectedProtoAxis Struct Reference

A Directed proto axis. More...

#include <Acts/Utilities/ProtoAxis.hpp>

Inheritance diagram for Acts::DirectedProtoAxis:

Collaboration diagram for Acts::DirectedProtoAxis:

Public Member Functions
	DirectedProtoAxis (AxisDirection axisDir, AxisBoundaryType abType, const std::vector< double > &edges)
	Convenience constructors - for variable binning.
	DirectedProtoAxis (AxisDirection axisDir, AxisBoundaryType abType, double minE, double maxE, std::size_t nbins)
	Convenience constructors - for equidistant binning.
	DirectedProtoAxis (AxisDirection axisDir, AxisBoundaryType abType, std::size_t nbins)
	Placeholder constructor for auto-range binning.
virtual	~DirectedProtoAxis ()=default
AxisDirection	getAxisDirection () const
	Access to the AxisDirection.
std::string	toString () const
	Dump into a string.
Public Member Functions inherited from Acts::ProtoAxis
	ProtoAxis (Acts::AxisBoundaryType abType, const std::vector< double > &edges)
	Convenience constructors - for variable binning.
	ProtoAxis (AxisBoundaryType abType, double minE, double maxE, std::size_t nbins)
	Convenience constructors - for equidistant binning.
	ProtoAxis (AxisBoundaryType abType, std::size_t nbins)
	Placeholder constructor for auto-range binning.
	ProtoAxis (const ProtoAxis &other)
	Custom copy constructor.
	ProtoAxis (ProtoAxis &&)=default
	Move constructor.
	~ProtoAxis ()=default
const IAxis &	getAxis () const
	Return the IAxis representation.
bool	isAutorange () const
	check if this is an auto-range binning
ProtoAxis &	operator= (const ProtoAxis &other)
	Custom assignment operator.
ProtoAxis &	operator= (ProtoAxis &&)=default
	Move assignment operator.
void	setRange (double minE, double maxE)
	Set the range, in case of autorange, this will toggle the autorange flag to false.
std::string	toString () const
	Dump into a string.

Additional Inherited Members
Protected Attributes inherited from Acts::ProtoAxis
bool	m_autorange = false
	Indicate if this is a place holder auto-range binning.
std::unique_ptr< IAxis >	m_axis = nullptr
	The axis representation.

Detailed Description

A Directed proto axis.

Constructor & Destructor Documentation

DirectedProtoAxis() [1/3]

Acts::DirectedProtoAxis::DirectedProtoAxis	(	AxisDirection	axisDir,
		AxisBoundaryType	abType,
		const std::vector< double > &	edges )

Convenience constructors - for variable binning.

Parameters

axisDir	the axis direction
abType	the axis boundary type
edges	the bin edges (variable binning)

DirectedProtoAxis() [2/3]

Acts::DirectedProtoAxis::DirectedProtoAxis	(	AxisDirection	axisDir,
		AxisBoundaryType	abType,
		double	minE,
		double	maxE,
		std::size_t	nbins )

Convenience constructors - for equidistant binning.

Parameters

axisDir	the axis direction
abType	the axis boundary type
minE	the lowest edge of the binning
maxE	the highest edge of the binning
nbins	the number of bins

DirectedProtoAxis() [3/3]

Acts::DirectedProtoAxis::DirectedProtoAxis	(	AxisDirection	axisDir,
		AxisBoundaryType	abType,
		std::size_t	nbins )

Placeholder constructor for auto-range binning.

Parameters

axisDir	the axis direction
abType	the axis boundary type
nbins	the number of bins

Note

that auto-range is only supported for equidistant binning

~DirectedProtoAxis()

virtual Acts::DirectedProtoAxis::~DirectedProtoAxis ( )

virtualdefault

Member Function Documentation

getAxisDirection()

AxisDirection Acts::DirectedProtoAxis::getAxisDirection

(

)

const

Access to the AxisDirection.

Returns

the axis direction

toString()

std::string Acts::DirectedProtoAxis::toString

(

)

const

Dump into a string.

Returns

the string representation