Description

Axis with fixed bin size.

Definition at line 23 of file FixedBinAxis.h.

Inheritance diagram for FixedBinAxis:

Collaboration diagram for FixedBinAxis:

Public Member Functions
	FixedBinAxis (const std::string &name, size_t nbins, double start, double end)
	FixedBinAxis constructor. More...

	~FixedBinAxis () override=default

std::string	axisName () const
	Returns the label of the axis. More...

Bin1D	bin (size_t index) const override
	retrieve a 1d bin for the given index More...

std::vector< double >	binBoundaries () const override

double	binCenter (size_t index) const override

std::vector< double >	binCenters () const override

std::pair< double, double >	bounds () const
	Returns lower and upper bound in a pair. first is lower, second is upper. More...

double	center () const
	Returns midpoint of axis. More...

void	clip (double lower, double upper) override
	Clips this axis to the given values. More...

void	clip (std::pair< double, double > bounds)
	Convenience overload to clip this axis to the given values. bounds.first is lower, bounds.second is upper value. More...

FixedBinAxis *	clone () const override

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

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

double	max () const override
	Returns value of last point of axis. More...

double	min () const override
	Returns value of first point of axis. More...

bool	operator!= (const IAxis &right) const

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

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

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

size_t	size () const override
	Returns the number of bins. More...

double	span () const
	Returns distance from first to last point. More...

Protected Member Functions
bool	equals (const IAxis &other) const override

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

Private Attributes
double	m_end

std::string	m_name
	axis name More...

size_t	m_nbins

double	m_start

Constructor & Destructor Documentation

◆ FixedBinAxis()

FixedBinAxis::FixedBinAxis	(	const std::string &	name,
		size_t	nbins,
		double	start,
		double	end
	)

FixedBinAxis constructor.

Parameters

name	Axis name
nbins	number of bins
start	low edge of first bin
end	upper edge of last bin

Definition at line 21 of file FixedBinAxis.cpp.

     : IAxis(name)
     , m_nbins(nbins)
     , m_start(start)
     , m_end(end)
 {
 }

Referenced by clone().

◆ ~FixedBinAxis()

FixedBinAxis::~FixedBinAxis ( )

overridedefault

Member Function Documentation

◆ axisName()

std::string IAxis::axisName ( ) const

inlineinherited

Returns the label of the axis.

Definition at line 61 of file IAxis.h.

61 { return m_name; }

IAxis::m_name

std::string m_name

axis name

Definition: IAxis.h:103

References IAxis::m_name.

Referenced by ConstKBinAxis::clone(), CustomBinAxis::clone(), clone(), PointwiseAxis::clone(), VariableBinAxis::clone(), IAxis::equals(), ConstKBinAxis::print(), CustomBinAxis::print(), print(), PointwiseAxis::print(), and VariableBinAxis::print().

◆ bin()

Bin1D FixedBinAxis::bin ( size_t index ) const

overridevirtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 44 of file FixedBinAxis.cpp.

 {
     if (index >= m_nbins)
         throw std::runtime_error("FixedBinAxis::bin() -> Error. Wrong index.");
  
     double step = (m_end - m_start) / m_nbins;
     Bin1D result(m_start + step * index, m_start + step * (index + 1));
     return result;
 }

References m_end, m_nbins, and m_start.

Referenced by binBoundaries(), binCenters(), and clip().

◆ binBoundaries()

std::vector< double > FixedBinAxis::binBoundaries ( ) const

overridevirtual

Reimplemented from IAxis.

Definition at line 74 of file FixedBinAxis.cpp.

 {
     std::vector<double> result;
     result.resize(size() + 1, 0.0);
     for (size_t i = 0; i < size(); ++i)
         result[i] = bin(i).m_lower;
     result[size()] = bin(size() - 1).m_upper;
     return result;
 }

References bin(), Bin1D::m_lower, Bin1D::m_upper, and size().

Here is the call graph for this function:

◆ binCenter()

double FixedBinAxis::binCenter ( size_t index ) const

inlineoverridevirtual

Implements IAxis.

Definition at line 44 of file FixedBinAxis.h.

44 { return (*this)[index]; }

◆ binCenters()

std::vector< double > FixedBinAxis::binCenters ( ) const

overridevirtual

Reimplemented from IAxis.

Definition at line 65 of file FixedBinAxis.cpp.

 {
     std::vector<double> result;
     result.resize(size(), 0.0);
     for (size_t i = 0; i < size(); ++i)
         result[i] = bin(i).center();
     return result;
 }

References bin(), Bin1D::center(), and size().

Here is the call graph for this function:

◆ bounds()

std::pair< double, double > IAxis::bounds ( ) const

inherited

Returns lower and upper bound in a pair. first is lower, second is upper.

Definition at line 50 of file IAxis.cpp.

 {
     return {min(), max()};
 }

References IAxis::max(), and IAxis::min().

Referenced by IAxis::clip().

Here is the call graph for this function:

◆ center()

double IAxis::center ( ) const

inherited

Returns midpoint of axis.

Definition at line 60 of file IAxis.cpp.

 {
     return (max() + min()) / 2;
 }

References IAxis::max(), and IAxis::min().

Here is the call graph for this function:

◆ clip() [1/2]

void FixedBinAxis::clip	(	double	lower,
		double	upper
	)

overridevirtual

Clips this axis to the given values.

Reimplemented from IAxis.

Definition at line 84 of file FixedBinAxis.cpp.

 {
     if (lower >= upper)
         throw std::runtime_error(
             "FixedBinAxis::clip() -> Error. 'lower' should be smaller than 'upper'");
  
     if (lower < min())
         lower = bin(0).center();
     if (upper >= max())
         upper = bin(size() - 1).center();
  
     const size_t nbin1 = findClosestIndex(lower);
     const size_t nbin2 = findClosestIndex(upper);
  
     // create tmp vars until everything is calculated, otherwise the calculation will be corrupted
     // by partially changed values
     const auto newStart = bin(nbin1).m_lower;
     const auto newEnd = bin(nbin2).m_upper;
  
     m_nbins = nbin2 - nbin1 + 1;
     m_start = newStart;
     m_end = newEnd;
 }

References bin(), Bin1D::center(), findClosestIndex(), m_end, Bin1D::m_lower, m_nbins, m_start, Bin1D::m_upper, max(), min(), and size().

Here is the call graph for this function:

◆ clip() [2/2]

void IAxis::clip ( std::pair< double, double > bounds )

inherited

Convenience overload to clip this axis to the given values. bounds.first is lower, bounds.second is upper value.

Definition at line 40 of file IAxis.cpp.

 {
     return clip(bounds.first, bounds.second);
 }

References IAxis::bounds(), and IAxis::clip().

Here is the call graph for this function:

◆ clone()

FixedBinAxis * FixedBinAxis::clone ( ) const

overridevirtual

Implements IAxis.

Definition at line 29 of file FixedBinAxis.cpp.

 {
     auto* result = new FixedBinAxis(axisName(), m_nbins, m_start, m_end);
     return result;
 }

References FixedBinAxis(), IAxis::axisName(), m_end, m_nbins, and m_start.

Here is the call graph for this function:

◆ contains()

bool IAxis::contains ( double value ) const

virtualinherited

Returns true if axis contains given point.

Definition at line 45 of file IAxis.cpp.

 {
     return value >= min() && value < max();
 }

References IAxis::max(), and IAxis::min().

Referenced by RectangularDetector::indexOfSpecular(), and SphericalDetector::indexOfSpecular().

Here is the call graph for this function:

◆ equals()

bool FixedBinAxis::equals ( const IAxis & other ) const

overrideprotectedvirtual

Reimplemented from IAxis.

Definition at line 115 of file FixedBinAxis.cpp.

 {
     if (!IAxis::equals(other))
         return false;
     if (const auto* otherAxis = dynamic_cast<const FixedBinAxis*>(&other)) {
         if (size() != otherAxis->size())
             return false;
         if (!BaseUtils::algo::almostEqual(m_start, otherAxis->m_start))
             return false;
         if (!BaseUtils::algo::almostEqual(m_end, otherAxis->m_end))
             return false;
         return true;
     }
     return false;
 }

References BaseUtils::algo::almostEqual(), IAxis::equals(), m_end, m_start, and size().

Here is the call graph for this function:

◆ findClosestIndex()

size_t FixedBinAxis::findClosestIndex ( double value ) const

overridevirtual

find bin index which is best match for given value

Implements IAxis.

Definition at line 54 of file FixedBinAxis.cpp.

 {
     if (value < min())
         return 0;
     if (value >= max())
         return m_nbins - 1;
  
     double step = (m_end - m_start) / m_nbins;
     return int((value - m_start) / step);
 }

References m_end, m_nbins, m_start, max(), and min().

Referenced by clip().

Here is the call graph for this function:

◆ max()

double FixedBinAxis::max ( ) const

inlineoverridevirtual

Returns value of last point of axis.

Implements IAxis.

Definition at line 42 of file FixedBinAxis.h.

42 { return m_end; }

References m_end.

Referenced by clip(), findClosestIndex(), and print().

◆ min()

double FixedBinAxis::min ( ) const

inlineoverridevirtual

Returns value of first point of axis.

Implements IAxis.

Definition at line 41 of file FixedBinAxis.h.

41 { return m_start; }

References m_start.

Referenced by clip(), findClosestIndex(), and print().

◆ operator!=()

bool IAxis::operator!= ( const IAxis & right ) const

inlineinherited

Definition at line 90 of file IAxis.h.

90 { return !(*this == right); }

◆ operator==()

bool IAxis::operator== ( const IAxis & right ) const

inlineinherited

test for equality

Definition at line 89 of file IAxis.h.

89 { return equals(right); }

References IAxis::equals().

Here is the call graph for this function:

◆ operator[]()

double FixedBinAxis::operator[] ( size_t index ) const

overridevirtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 35 of file FixedBinAxis.cpp.

 {
     if (index >= m_nbins)
         throw std::runtime_error("FixedBinAxis::operator[] -> Error. Wrong index.");
  
     double step = (m_end - m_start) / m_nbins;
     return m_start + (index + 0.5) * step;
 }

References m_end, m_nbins, and m_start.

◆ print()

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

overrideprotectedvirtual

Implements IAxis.

Definition at line 108 of file FixedBinAxis.cpp.

 {
     ostr << "FixedBinAxis(\"" << axisName() << "\", " << size() << ", "
          << std::setprecision(std::numeric_limits<double>::digits10 + 2) << min() << ", " << max()
          << ")";
 }

References IAxis::axisName(), max(), min(), and size().

Here is the call graph for this function:

◆ setAxisName()

void IAxis::setAxisName ( std::string name )

inlineinherited

Sets the axis label.

Definition at line 39 of file IAxis.h.

39 { m_name = name; }

References IAxis::m_name.

◆ size()

size_t FixedBinAxis::size ( ) const

inlineoverridevirtual

Returns the number of bins.

Implements IAxis.

Definition at line 35 of file FixedBinAxis.h.

35 { return m_nbins; }

References m_nbins.

Referenced by binBoundaries(), binCenters(), clip(), equals(), and print().

◆ span()

double IAxis::span ( ) const

inherited

Returns distance from first to last point.

Definition at line 55 of file IAxis.cpp.

 {
     return max() - min();
 }

References IAxis::max(), and IAxis::min().

Referenced by RectangularDetector::height(), and RectangularDetector::width().

Here is the call graph for this function:

Member Data Documentation

◆ m_end

double FixedBinAxis::m_end

private

Definition at line 61 of file FixedBinAxis.h.

Referenced by bin(), clip(), clone(), equals(), findClosestIndex(), max(), and operator[]().

◆ m_name

std::string IAxis::m_name

privateinherited

axis name

Definition at line 103 of file IAxis.h.

Referenced by IAxis::axisName(), and IAxis::setAxisName().

◆ m_nbins

size_t FixedBinAxis::m_nbins

private

Definition at line 59 of file FixedBinAxis.h.

Referenced by bin(), clip(), clone(), findClosestIndex(), operator[](), and size().

◆ m_start

double FixedBinAxis::m_start

private

Definition at line 60 of file FixedBinAxis.h.

Referenced by bin(), clip(), clone(), equals(), findClosestIndex(), min(), and operator[]().

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

/home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Axis/FixedBinAxis.h
/home/build/builds/o5h8MZZm/0/mlz/bornagain/Base/Axis/FixedBinAxis.cpp

Description

Public Member Functions

Protected Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ FixedBinAxis()

◆ ~FixedBinAxis()

Member Function Documentation

◆ axisName()

◆ bin()

◆ binBoundaries()

◆ binCenter()

◆ binCenters()

◆ bounds()

◆ center()

◆ clip() [1/2]

◆ clip() [2/2]

◆ clone()

◆ contains()

◆ equals()

◆ findClosestIndex()

◆ max()

◆ min()

◆ operator!=()

◆ operator==()

◆ operator[]()

◆ print()

◆ setAxisName()

◆ size()

◆ span()

Member Data Documentation

◆ m_end

◆ m_name

◆ m_nbins

◆ m_start