Axis with variable bin size. More...

Inheritance diagram for VariableBinAxis:

Public Member Functions
	VariableBinAxis (const std::string &name, size_t nbins, const std::vector< double > &bin_boundaries)
	VariableBinAxis constructor. More...

VariableBinAxis *	clone () const
	clone function

size_t	size () const
	retrieve the number of bins

double	operator[] (size_t index) const
	indexed accessor retrieves a sample

Bin1D	getBin (size_t index) const
	retrieve a 1d bin for the given index

double	getMin () const
	Returns value of first point of axis.

double	getMax () const
	Returns value of last point of axis.

double	getBinCenter (size_t index) const

size_t	findClosestIndex (double value) const
	find bin index which is best match for given value

std::vector< double >	getBinCenters () const

std::vector< double >	getBinBoundaries () const

virtual VariableBinAxis *	createClippedAxis (double left, double right) const
	Creates a new clipped axis.

std::string	pyString (const std::string &units, size_t offset) const final

Public Member Functions inherited from IAxis
	IAxis (const std::string &name)
	constructors

virtual	~IAxis ()
	destructor

std::string	getName () const
	retrieve the label of the axis

void	setName (std::string name)
	Sets the axis label.

bool	operator== (const IAxis &right) const
	test for equality

bool	operator!= (const IAxis &right) const

virtual bool	contains (double value) const
	Returns true if axis contains given point.

Protected Member Functions
	VariableBinAxis (const std::string &name, size_t nbins=0)

void	setBinBoundaries (const std::vector< double > &bin_boundaries)

virtual void	print (std::ostream &ostr) const

virtual bool	equals (const IAxis &other) const

Detailed Description

Axis with variable bin size.

Definition at line 23 of file VariableBinAxis.h.

Constructor & Destructor Documentation

VariableBinAxis::VariableBinAxis	(	const std::string &	name,
		size_t	nbins,
		const std::vector< double > &	bin_boundaries
	)

Parameters

name	Axis name
nbins	number of bins
bin_boundaries	Array of size nbins+1 containing low-edges for each bin and upper edge of last bin.

Definition at line 21 of file VariableBinAxis.cpp.

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