VariableBinAxis Class Reference

Description

Axis with variable bin size.

Definition at line 23 of file VariableBinAxis.h.

Inheritance diagram for VariableBinAxis:

Collaboration diagram for VariableBinAxis:

Public Member Functions
	VariableBinAxis (const std::string &name, const std::vector< double > &bin_boundaries)
	VariableBinAxis constructor. More...
	~VariableBinAxis () 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...
VariableBinAxis *	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
	VariableBinAxis (const std::string &name, size_t nbins=0)
bool	equals (const IAxis &other) const override
void	print (std::ostream &ostr) const override
void	setBinBoundaries (const std::vector< double > &bin_boundaries)

Protected Attributes
size_t	m_nbins

Private Attributes
std::vector< double >	m_bin_boundaries
	vector containing the bin limits More...
std::string	m_name
	axis name More...

Constructor & Destructor Documentation

VariableBinAxis() [1/2]

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

VariableBinAxis constructor.

Parameters

name	Axis name
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.

    : IAxis(name)
    , m_nbins(bin_boundaries.size() - 1)
{
    setBinBoundaries(bin_boundaries);
}

References setBinBoundaries().

Referenced by clone().

Here is the call graph for this function:

~VariableBinAxis()

VariableBinAxis::~VariableBinAxis ( )

overridedefault

VariableBinAxis() [2/2]

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

explicitprotected

Definition at line 28 of file VariableBinAxis.cpp.

    : IAxis(name)
    , m_nbins(nbins)
{
}

Member Function Documentation

axisName()

std::string IAxis::axisName ( ) const

inlineinherited

Returns the label of the axis.

Definition at line 61 of file IAxis.h.

{ return m_name; }

References IAxis::m_name.

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

bin()

Bin1D VariableBinAxis::bin ( size_t  index ) const

overridevirtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 45 of file VariableBinAxis.cpp.

{
    if (index >= m_nbins)
        throw std::runtime_error("VariableBinAxis::bin() -> Error. Wrong index.");
 
    Bin1D result(m_bin_boundaries[index], m_bin_boundaries[index + 1]);
    return result;
}

References m_bin_boundaries, and m_nbins.

Referenced by binCenter(), binCenters(), ConstKBinAxis::clip(), clip(), and operator[]().

binBoundaries()

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

inlineoverridevirtual

Reimplemented from IAxis.

Definition at line 48 of file VariableBinAxis.h.

{ return m_bin_boundaries; }

References m_bin_boundaries.

Referenced by ConstKBinAxis::clip().

binCenter()

double VariableBinAxis::binCenter ( size_t  index ) const

overridevirtual

Implements IAxis.

Definition at line 64 of file VariableBinAxis.cpp.

{
    return bin(index).center();
}

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

Here is the call graph for this function:

binCenters()

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

overridevirtual

Reimplemented from IAxis.

Definition at line 86 of file VariableBinAxis.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 VariableBinAxis::clip ( double  lower, double  upper  )

overridevirtual

Clips this axis to the given values.

Reimplemented from IAxis.

Definition at line 95 of file VariableBinAxis.cpp.

{
    if (lower >= upper)
        throw std::runtime_error("VariableBinAxis::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);
    const size_t new_nbins = nbin2 - nbin1 + 1;
 
    std::vector<double> new_boundaries;
    for (size_t i = 0; i < new_nbins + 1; ++i)
        new_boundaries.push_back(m_bin_boundaries[nbin1 + i]);
 
    m_nbins = new_nbins;
    setBinBoundaries(new_boundaries);
}

References bin(), Bin1D::center(), findClosestIndex(), m_bin_boundaries, m_nbins, max(), min(), setBinBoundaries(), 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()

VariableBinAxis * VariableBinAxis::clone ( ) const

overridevirtual

Implements IAxis.

Definition at line 34 of file VariableBinAxis.cpp.

{
    auto* result = new VariableBinAxis(axisName(), m_bin_boundaries);
    return result;
}

References VariableBinAxis(), IAxis::axisName(), and m_bin_boundaries.

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 VariableBinAxis::equals ( const IAxis &  other ) const

overrideprotectedvirtual

Reimplemented from IAxis.

Definition at line 129 of file VariableBinAxis.cpp.

{
    if (!IAxis::equals(other))
        return false;
    if (const auto* p_other_cast = dynamic_cast<const VariableBinAxis*>(&other)) {
        if (size() != p_other_cast->size())
            return false;
        for (size_t i = 0; i < m_bin_boundaries.size(); ++i) {
            if (!BaseUtils::algo::almostEqual(m_bin_boundaries[i],
                                              p_other_cast->m_bin_boundaries[i]))
                return false;
        }
        return true;
    }
    return false;
}

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

Here is the call graph for this function:

findClosestIndex()

size_t VariableBinAxis::findClosestIndex ( double  value ) const

overridevirtual

find bin index which is best match for given value

Implements IAxis.

Definition at line 69 of file VariableBinAxis.cpp.

{
    if (m_bin_boundaries.size() < 2)
        throw std::runtime_error("VariableBinAxis::findClosestIndex() -> Error! "
                                 "VariableBinAxis not  correctly initialized");
    if (value < min())
        return 0;
    if (value >= max())
        return m_nbins - 1;
 
    auto top_limit = std::lower_bound(m_bin_boundaries.begin(), m_bin_boundaries.end(), value);
    if (*top_limit != value)
        --top_limit;
    size_t nbin = top_limit - m_bin_boundaries.begin();
    return nbin;
}

References m_bin_boundaries, m_nbins, max(), and min().

Referenced by ConstKBinAxis::clip(), and clip().

Here is the call graph for this function:

max()

double VariableBinAxis::max ( ) const

overridevirtual

Returns value of last point of axis.

Implements IAxis.

Definition at line 59 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.back();
}

References m_bin_boundaries.

Referenced by ConstKBinAxis::clip(), clip(), and findClosestIndex().

min()

double VariableBinAxis::min ( ) const

overridevirtual

Returns value of first point of axis.

Implements IAxis.

Definition at line 54 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.front();
}

References m_bin_boundaries.

Referenced by ConstKBinAxis::clip(), clip(), and findClosestIndex().

operator!=()

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

inlineinherited

Definition at line 90 of file IAxis.h.

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

operator==()

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

inlineinherited

test for equality

Definition at line 89 of file IAxis.h.

{ return equals(right); }

References IAxis::equals().

Here is the call graph for this function:

operator[]()

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

overridevirtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 40 of file VariableBinAxis.cpp.

{
    return bin(index).center();
}

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

Here is the call graph for this function:

print()

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

overrideprotectedvirtual

Implements IAxis.

Definition at line 118 of file VariableBinAxis.cpp.

{
    ostr << "VariableBinAxis(\"" << axisName() << "\", " << size() << ", [";
    for (size_t i = 0; i < m_bin_boundaries.size(); ++i) {
        ostr << std::setprecision(std::numeric_limits<double>::digits10 + 2) << m_bin_boundaries[i];
        if (i != m_bin_boundaries.size() - 1)
            ostr << ", ";
    }
    ostr << "])";
}

References IAxis::axisName(), m_bin_boundaries, 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.

{ m_name = name; }

References IAxis::m_name.

setBinBoundaries()

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

protected

Definition at line 146 of file VariableBinAxis.cpp.

{
    // checking that values are sorted
    std::vector<double> vec_sorted = bin_boundaries;
    std::sort(vec_sorted.begin(), vec_sorted.end());
    for (size_t i = 0; i < bin_boundaries.size(); ++i) {
        if (vec_sorted[i] != bin_boundaries[i])
            throw std::runtime_error("VariableBinAxis::setBinBoundaries() -> Error. "
                                     "Array with bin edges is not sorted.");
    }
 
    std::vector<double> vec = bin_boundaries;
    vec.erase(std::unique(vec.begin(), vec.end()), vec.end());
 
    if (vec.size() != bin_boundaries.size())
        throw std::runtime_error("VariableBinAxis::setBinBoundaries() -> Error. "
                                 "Array with bin edges contains repeating values.");
 
    m_bin_boundaries = bin_boundaries;
}

References m_bin_boundaries.

Referenced by ConstKBinAxis::ConstKBinAxis(), CustomBinAxis::CustomBinAxis(), VariableBinAxis(), ConstKBinAxis::clip(), and clip().

size()

size_t VariableBinAxis::size ( ) const

inlineoverridevirtual

Returns the number of bins.

Implements IAxis.

Definition at line 34 of file VariableBinAxis.h.

{ return m_nbins; }

References m_nbins.

Referenced by binCenters(), ConstKBinAxis::clip(), clip(), ConstKBinAxis::equals(), CustomBinAxis::equals(), equals(), ConstKBinAxis::print(), CustomBinAxis::print(), 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_bin_boundaries

std::vector<double> VariableBinAxis::m_bin_boundaries

private

vector containing the bin limits

Definition at line 61 of file VariableBinAxis.h.

Referenced by bin(), binBoundaries(), clip(), clone(), equals(), findClosestIndex(), max(), min(), print(), and setBinBoundaries().

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 VariableBinAxis::m_nbins

protected

Definition at line 58 of file VariableBinAxis.h.

Referenced by ConstKBinAxis::ConstKBinAxis(), CustomBinAxis::CustomBinAxis(), CustomBinAxis::bin(), bin(), ConstKBinAxis::clip(), clip(), ConstKBinAxis::clone(), CustomBinAxis::clone(), findClosestIndex(), and size().

---

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

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