CustomBinAxis Class Reference

Description

Axis with fixed bin size in sin(angle) space used for numerical comparison with IsGisaxs. The main feature of the axis is that it produces zero bin sizes.

Definition at line 24 of file CustomBinAxis.h.

Inheritance diagram for CustomBinAxis:

Collaboration diagram for CustomBinAxis:

Public Member Functions
	CustomBinAxis (const std::string &name, size_t nbins, double start, double end)
	CustomBinAxis constructor. More...
	~CustomBinAxis () 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...
CustomBinAxis *	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
void	setBinBoundaries (const std::vector< double > &bin_boundaries)

Protected Attributes
std::vector< double >	m_bin_centers
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

CustomBinAxis()

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

CustomBinAxis constructor.

Parameters

name	Axis name
nbins	number of bins
start	center of first bin (IsGisaxs convention)
end	center of last bin (IsGisaxs convention)

Definition at line 22 of file CustomBinAxis.cpp.

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

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

Referenced by clone().

Here is the call graph for this function:

~CustomBinAxis()

CustomBinAxis::~CustomBinAxis ( )

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.

{ return m_name; }

References IAxis::m_name.

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

bin()

Bin1D CustomBinAxis::bin ( size_t  index ) const

overridevirtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 51 of file CustomBinAxis.cpp.

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

References m_bin_centers, and VariableBinAxis::m_nbins.

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 ConstKBinAxis::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 > CustomBinAxis::binCenters ( ) const

overridevirtual

Reimplemented from IAxis.

Definition at line 60 of file CustomBinAxis.cpp.

{
    return m_bin_centers;
}

References m_bin_centers.

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 CustomBinAxis::clip ( double  lower, double  upper  )

overridevirtual

Clips this axis to the given values.

Reimplemented from IAxis.

Definition at line 65 of file CustomBinAxis.cpp.

{
    throw std::runtime_error("CustomBinAxis::clip() -> Error."
                             " Not implemented.");
}

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()

CustomBinAxis * CustomBinAxis::clone ( ) const

overridevirtual

Implements IAxis.

Definition at line 46 of file CustomBinAxis.cpp.

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

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

overrideprotectedvirtual

Reimplemented from IAxis.

Definition at line 78 of file CustomBinAxis.cpp.

{
    if (!IAxis::equals(other))
        return false;
    if (const auto* otherAxis = dynamic_cast<const CustomBinAxis*>(&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 ConstKBinAxis::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 ConstKBinAxis::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 ConstKBinAxis::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 CustomBinAxis::print ( std::ostream &  ostr ) const

overrideprotectedvirtual

Implements IAxis.

Definition at line 71 of file CustomBinAxis.cpp.

{
    ostr << "CustomBinAxis(\"" << 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::ConstKBinAxis(), CustomBinAxis(), VariableBinAxis::VariableBinAxis(), ConstKBinAxis::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(), ConstKBinAxis::clip(), VariableBinAxis::clip(), ConstKBinAxis::equals(), equals(), VariableBinAxis::equals(), ConstKBinAxis::print(), 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_bin_centers

std::vector<double> CustomBinAxis::m_bin_centers

protected

Definition at line 48 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), bin(), and binCenters().

m_end

double CustomBinAxis::m_end

protected

Definition at line 47 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), 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::ConstKBinAxis(), CustomBinAxis(), bin(), VariableBinAxis::bin(), ConstKBinAxis::clip(), VariableBinAxis::clip(), ConstKBinAxis::clone(), clone(), VariableBinAxis::findClosestIndex(), and VariableBinAxis::size().

m_start

double CustomBinAxis::m_start

protected

Definition at line 46 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), clone(), equals(), and print().

---

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

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