ConstKBinAxis Class Reference

Description

Axis with fixed bin size in sin(angle) space.

Definition at line 23 of file ConstKBinAxis.h.

Inheritance diagram for ConstKBinAxis:

Collaboration diagram for ConstKBinAxis:

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

Protected Attributes
double	m_end
size_t	m_nbins
double	m_start

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

Constructor & Destructor Documentation

ConstKBinAxis() [1/2]

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

ConstKBinAxis constructor.

Parameters

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

Definition at line 28 of file ConstKBinAxis.cpp.

    : VariableBinAxis(name, nbins)
    , m_start(start)
    , m_end(end)
{
    if (m_start >= m_end)
        throw std::runtime_error(
            "ConstKBinAxis::ConstKBinAxis() -> Error. start >= end is not allowed.");
 
    double start_sin = std::sin(m_start);
    double end_sin = std::sin(m_end);
    double step = (end_sin - start_sin) / (m_nbins);
 
    std::vector<double> bin_boundaries;
    bin_boundaries.resize(m_nbins + 1, 0.0);
    for (size_t i = 0; i < bin_boundaries.size(); ++i)
        bin_boundaries[i] = std::asin(start_sin + step * i);
    setBinBoundaries(bin_boundaries);
}

References m_end, VariableBinAxis::m_nbins, m_start, and VariableBinAxis::setBinBoundaries().

Referenced by clone().

Here is the call graph for this function:

~ConstKBinAxis()

ConstKBinAxis::~ConstKBinAxis ( )

overridedefault

ConstKBinAxis() [2/2]

ConstKBinAxis::ConstKBinAxis ( const std::string &  name, size_t  nbins  )

protected

Definition at line 21 of file ConstKBinAxis.cpp.

    : VariableBinAxis(name, nbins)
    , m_start(0)
    , m_end(0)
{
}

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 clone(), CustomBinAxis::clone(), FixedBinAxis::clone(), PointwiseAxis::clone(), VariableBinAxis::clone(), IAxis::equals(), print(), CustomBinAxis::print(), FixedBinAxis::print(), PointwiseAxis::print(), and VariableBinAxis::print().

bin()

Bin1D VariableBinAxis::bin ( size_t  index ) const

overridevirtualinherited

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 VariableBinAxis::m_bin_boundaries, and VariableBinAxis::m_nbins.

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

binBoundaries()

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

inlineoverridevirtualinherited

Reimplemented from IAxis.

Definition at line 48 of file VariableBinAxis.h.

{ return m_bin_boundaries; }

References VariableBinAxis::m_bin_boundaries.

Referenced by clip().

binCenter()

double VariableBinAxis::binCenter ( size_t  index ) const

overridevirtualinherited

Implements IAxis.

Definition at line 64 of file VariableBinAxis.cpp.

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

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

Here is the call graph for this function:

binCenters()

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

overridevirtualinherited

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 VariableBinAxis::bin(), Bin1D::center(), and VariableBinAxis::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 ConstKBinAxis::clip ( double  lower, double  upper  )

overridevirtual

Clips this axis to the given values.

Reimplemented from IAxis.

Definition at line 53 of file ConstKBinAxis.cpp.

{
    if (lower >= upper)
        throw std::runtime_error(
            "ConstKBinAxis::clip() -> Error. 'lower' should be smaller than 'upper'");
 
    if (lower < min())
        lower = bin(0).center();
    if (upper >= max())
        upper = bin(size() - 1).center();
 
    size_t nbin1 = findClosestIndex(lower);
    size_t nbin2 = findClosestIndex(upper);
 
    size_t new_nbins = nbin2 - nbin1 + 1;
    std::vector<double> new_boundaries;
    std::vector<double> old_boundaries = binBoundaries();
    for (size_t i = 0; i < new_nbins + 1; ++i)
        new_boundaries.push_back(old_boundaries[nbin1 + i]);
 
    m_nbins = new_nbins;
    m_start = new_boundaries.front();
    m_end = new_boundaries.back();
    setBinBoundaries(new_boundaries);
}

References VariableBinAxis::bin(), VariableBinAxis::binBoundaries(), Bin1D::center(), VariableBinAxis::findClosestIndex(), m_end, VariableBinAxis::m_nbins, m_start, VariableBinAxis::max(), VariableBinAxis::min(), VariableBinAxis::setBinBoundaries(), and VariableBinAxis::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()

ConstKBinAxis * ConstKBinAxis::clone ( ) const

overridevirtual

Implements IAxis.

Definition at line 48 of file ConstKBinAxis.cpp.

{
    return new ConstKBinAxis(axisName(), m_nbins, m_start, m_end);
}

References ConstKBinAxis(), IAxis::axisName(), m_end, VariableBinAxis::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 ConstKBinAxis::equals ( const IAxis &  other ) const

overrideprotectedvirtual

Reimplemented from IAxis.

Definition at line 79 of file ConstKBinAxis.cpp.

{
    if (!IAxis::equals(other))
        return false;
    if (const auto* otherAxis = dynamic_cast<const ConstKBinAxis*>(&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 VariableBinAxis::size().

Here is the call graph for this function:

findClosestIndex()

size_t VariableBinAxis::findClosestIndex ( double  value ) const

overridevirtualinherited

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 VariableBinAxis::m_bin_boundaries, VariableBinAxis::m_nbins, VariableBinAxis::max(), and VariableBinAxis::min().

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

Here is the call graph for this function:

max()

double VariableBinAxis::max ( ) const

overridevirtualinherited

Returns value of last point of axis.

Implements IAxis.

Definition at line 59 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.back();
}

References VariableBinAxis::m_bin_boundaries.

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

min()

double VariableBinAxis::min ( ) const

overridevirtualinherited

Returns value of first point of axis.

Implements IAxis.

Definition at line 54 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.front();
}

References VariableBinAxis::m_bin_boundaries.

Referenced by clip(), VariableBinAxis::clip(), and VariableBinAxis::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

overridevirtualinherited

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 40 of file VariableBinAxis.cpp.

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

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

Here is the call graph for this function:

print()

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

overrideprotectedvirtual

Implements IAxis.

Definition at line 95 of file ConstKBinAxis.cpp.

{
    ostr << "ConstKBinAxis(\"" << axisName() << "\", " << size() << ", "
         << std::setprecision(std::numeric_limits<double>::digits10 + 2) << m_start << ", " << m_end
         << ")";
}

References IAxis::axisName(), m_end, m_start, and VariableBinAxis::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 )

protectedinherited

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 VariableBinAxis::m_bin_boundaries.

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

size()

size_t VariableBinAxis::size ( ) const

inlineoverridevirtualinherited

Returns the number of bins.

Implements IAxis.

Definition at line 34 of file VariableBinAxis.h.

{ return m_nbins; }

References VariableBinAxis::m_nbins.

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

privateinherited

vector containing the bin limits

Definition at line 61 of file VariableBinAxis.h.

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

m_end

double ConstKBinAxis::m_end

protected

Definition at line 44 of file ConstKBinAxis.h.

Referenced by ConstKBinAxis(), clip(), clone(), equals(), and print().

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

protectedinherited

Definition at line 58 of file VariableBinAxis.h.

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

m_start

double ConstKBinAxis::m_start

protected

Definition at line 43 of file ConstKBinAxis.h.

Referenced by ConstKBinAxis(), clip(), clone(), equals(), and print().

---

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

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