CustomBinAxis Class Reference

Inheritance diagram for CustomBinAxis:

Collaboration diagram for CustomBinAxis:

Public Member Functions
	CustomBinAxis (const std::string &name, size_t nbins, double start, double end)
virtual	~CustomBinAxis ()
CustomBinAxis *	clone () const
Bin1D	getBin (size_t index) const
std::vector< double >	getBinCenters () const
CustomBinAxis *	createClippedAxis (double left, double right) const
size_t	size () const
double	operator[] (size_t index) const
double	getMin () const
double	getMax () const
double	getBinCenter (size_t index) const
size_t	findClosestIndex (double value) const
std::vector< double >	getBinBoundaries () const
std::string	pyString (const std::string &units, size_t offset) const final
std::string	getName () const
void	setName (std::string name)
bool	operator== (const IAxis &right) const
bool	operator!= (const IAxis &right) const
virtual bool	contains (double value) const

Protected Member Functions
void	print (std::ostream &ostr) const
bool	equals (const IAxis &other) const
void	setBinBoundaries (const std::vector< double > &bin_boundaries)

Protected Attributes
double	m_start
double	m_end
std::vector< double >	m_bin_centers
size_t	m_nbins

Private Attributes
std::vector< double >	m_bin_boundaries
std::string	m_name

Detailed 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.

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 21 of file CustomBinAxis.cpp.

    : VariableBinAxis(name, nbins), m_start(start), m_end(end)
{
    if (m_start >= m_end)
        throw Exceptions::LogicErrorException("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()

virtual CustomBinAxis::~CustomBinAxis ( )

inlinevirtual

Definition at line 33 of file CustomBinAxis.h.

{}

Member Function Documentation

clone()

CustomBinAxis * CustomBinAxis::clone ( ) const

virtual

clone function

Implements IAxis.

Definition at line 45 of file CustomBinAxis.cpp.

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

References CustomBinAxis(), IAxis::getName(), m_end, VariableBinAxis::m_nbins, and m_start.

Here is the call graph for this function:

getBin()

Bin1D CustomBinAxis::getBin ( size_t  index ) const

virtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 50 of file CustomBinAxis.cpp.

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

References m_bin_centers, and VariableBinAxis::m_nbins.

getBinCenters()

std::vector< double > CustomBinAxis::getBinCenters ( ) const

virtual

Reimplemented from IAxis.

Definition at line 59 of file CustomBinAxis.cpp.

{
    return m_bin_centers;
}

References m_bin_centers.

createClippedAxis()

CustomBinAxis * CustomBinAxis::createClippedAxis ( double  left, double  right  ) const

virtual

Creates a new clipped axis.

Reimplemented from VariableBinAxis.

Definition at line 64 of file CustomBinAxis.cpp.

{
    throw Exceptions::NotImplementedException("VariableBinAxis::CustomBinAxis() -> Error."
                                              " Not implemented.");
}

print()

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

protectedvirtual

Reimplemented from VariableBinAxis.

Definition at line 70 of file CustomBinAxis.cpp.

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

References IAxis::getName(), m_end, m_start, and VariableBinAxis::size().

Here is the call graph for this function:

equals()

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

protectedvirtual

Reimplemented from VariableBinAxis.

Definition at line 77 of file CustomBinAxis.cpp.

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

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

Here is the call graph for this function:

size()

size_t VariableBinAxis::size ( ) const

inlinevirtualinherited

retrieve the number of bins

Implements IAxis.

Definition at line 37 of file VariableBinAxis.h.

{ return m_nbins; }

References VariableBinAxis::m_nbins.

Referenced by VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), equals(), VariableBinAxis::equals(), ConstKBinAxis::equals(), VariableBinAxis::getBinCenters(), print(), VariableBinAxis::print(), and ConstKBinAxis::print().

operator[]()

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

virtualinherited

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 44 of file VariableBinAxis.cpp.

{
    return getBin(index).getMidPoint();
}

References VariableBinAxis::getBin(), and Bin1D::getMidPoint().

Here is the call graph for this function:

getMin()

double VariableBinAxis::getMin ( ) const

virtualinherited

Returns value of first point of axis.

Implements IAxis.

Definition at line 58 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.front();
}

References VariableBinAxis::m_bin_boundaries.

Referenced by VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), and VariableBinAxis::findClosestIndex().

getMax()

double VariableBinAxis::getMax ( ) const

virtualinherited

Returns value of last point of axis.

Implements IAxis.

Definition at line 63 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.back();
}

References VariableBinAxis::m_bin_boundaries.

Referenced by VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), and VariableBinAxis::findClosestIndex().

getBinCenter()

double VariableBinAxis::getBinCenter ( size_t  index ) const

virtualinherited

Implements IAxis.

Definition at line 68 of file VariableBinAxis.cpp.

{
    return getBin(index).getMidPoint();
}

References VariableBinAxis::getBin(), and Bin1D::getMidPoint().

Here is the call graph for this function:

findClosestIndex()

size_t VariableBinAxis::findClosestIndex ( double  value ) const

virtualinherited

find bin index which is best match for given value

Implements IAxis.

Definition at line 73 of file VariableBinAxis.cpp.

{
    if (m_bin_boundaries.size() < 2)
        throw Exceptions::ClassInitializationException(
            "VariableBinAxis::findClosestIndex() -> Error! "
            "VariableBinAxis not  correctly initialized");
    if (value < getMin()) {
        return 0;
    } else if (value >= getMax()) {
        return m_nbins - 1;
    }
 
    std::vector<double>::const_iterator 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::getMax(), VariableBinAxis::getMin(), VariableBinAxis::m_bin_boundaries, and VariableBinAxis::m_nbins.

Referenced by VariableBinAxis::createClippedAxis(), and ConstKBinAxis::createClippedAxis().

Here is the call graph for this function:

getBinBoundaries()

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

inlinevirtualinherited

Reimplemented from IAxis.

Definition at line 51 of file VariableBinAxis.h.

{ return m_bin_boundaries; }

References VariableBinAxis::m_bin_boundaries.

Referenced by ConstKBinAxis::createClippedAxis().

pyString()

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

finalvirtualinherited

Implements IAxis.

Definition at line 127 of file VariableBinAxis.cpp.

{
    throw std::runtime_error("VariableBinAxis::pyString not yet implemented"); // TODO
}

setBinBoundaries()

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

protectedinherited

Definition at line 160 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 Exceptions::LogicErrorException("VariableBinAxis::VariableBinAxis() -> 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 Exceptions::LogicErrorException("VariableBinAxis::VariableBinAxis() -> Error. "
                                              "Array with bin edges contains repeating values.");
 
    m_bin_boundaries = bin_boundaries;
}

References VariableBinAxis::m_bin_boundaries.

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

getName()

std::string IAxis::getName ( ) const

inlineinherited

retrieve the label of the axis

Definition at line 40 of file IAxis.h.

{ return m_name; }

References IAxis::m_name.

Referenced by OutputData< T >::addAxis(), RegionOfInterest::clipAxisToRoi(), clone(), FixedBinAxis::clone(), VariableBinAxis::clone(), ConstKBinAxis::clone(), PointwiseAxis::clone(), FixedBinAxis::createClippedAxis(), VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), PointwiseAxis::createClippedAxis(), IAxis::equals(), print(), FixedBinAxis::print(), VariableBinAxis::print(), ConstKBinAxis::print(), PointwiseAxis::print(), and FixedBinAxis::pyString().

setName()

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

inlineinherited

Sets the axis label.

Definition at line 43 of file IAxis.h.

{ m_name = name; }

References IAxis::m_name.

operator==()

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

inlineinherited

test for equality

Definition at line 63 of file IAxis.h.

{ return equals(right); }

References IAxis::equals().

Here is the call graph for this function:

operator!=()

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

inlineinherited

Definition at line 64 of file IAxis.h.

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

contains()

bool IAxis::contains ( double  value ) const

virtualinherited

Returns true if axis contains given point.

Definition at line 40 of file IAxis.cpp.

{
    return value >= getMin() && value < getMax();
}

References IAxis::getMax(), and IAxis::getMin().

Referenced by Histogram1D::crop(), Histogram2D::crop(), RectangularDetector::indexOfSpecular(), and SphericalDetector::indexOfSpecular().

Here is the call graph for this function:

Member Data Documentation

m_start

double CustomBinAxis::m_start

protected

Definition at line 47 of file CustomBinAxis.h.

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

m_end

double CustomBinAxis::m_end

protected

Definition at line 48 of file CustomBinAxis.h.

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

m_bin_centers

std::vector<double> CustomBinAxis::m_bin_centers

protected

Definition at line 49 of file CustomBinAxis.h.

Referenced by CustomBinAxis(), getBin(), and getBinCenters().

m_nbins

size_t VariableBinAxis::m_nbins

protectedinherited

Definition at line 63 of file VariableBinAxis.h.

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

m_bin_boundaries

std::vector<double> VariableBinAxis::m_bin_boundaries

privateinherited

vector containing the bin limits

Definition at line 66 of file VariableBinAxis.h.

Referenced by VariableBinAxis::clone(), VariableBinAxis::createClippedAxis(), VariableBinAxis::equals(), VariableBinAxis::findClosestIndex(), VariableBinAxis::getBin(), VariableBinAxis::getBinBoundaries(), VariableBinAxis::getMax(), VariableBinAxis::getMin(), VariableBinAxis::print(), and VariableBinAxis::setBinBoundaries().

m_name

std::string IAxis::m_name

privateinherited

axis name

Definition at line 92 of file IAxis.h.

Referenced by IAxis::getName(), and IAxis::setName().

---

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

• /home/www/ba/Base/Axis/CustomBinAxis.h
• /home/www/ba/Base/Axis/CustomBinAxis.cpp