VariableBinAxis Class Reference

Inheritance diagram for VariableBinAxis:

Collaboration diagram for VariableBinAxis:

Public Member Functions
	VariableBinAxis (const std::string &name, size_t nbins, const std::vector< double > &bin_boundaries)
virtual	~VariableBinAxis ()
VariableBinAxis *	clone () const
size_t	size () const
double	operator[] (size_t index) const
Bin1D	getBin (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 >	getBinCenters () const
std::vector< double >	getBinBoundaries () const
virtual VariableBinAxis *	createClippedAxis (double left, double right) 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
	VariableBinAxis (const std::string &name, size_t nbins=0)
void	setBinBoundaries (const std::vector< double > &bin_boundaries)
virtual void	print (std::ostream &ostr) const
virtual bool	equals (const IAxis &other) const

Protected Attributes
size_t	m_nbins

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

Detailed Description

Axis with variable bin size.

Definition at line 23 of file VariableBinAxis.h.

Constructor & Destructor Documentation

VariableBinAxis() [1/2]

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

VariableBinAxis constructor.

Parameters

name	Axis name
nbins	number of bins
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(nbins)
{
    if (m_nbins != bin_boundaries.size() - 1)
        throw Exceptions::LogicErrorException(
            "VariableBinAxis::VariableBinAxis() -> Error! "
            "The size of bin_boundaries should be of size [nbins+1].");
 
    setBinBoundaries(bin_boundaries);
}

References m_nbins, and setBinBoundaries().

Referenced by clone(), and createClippedAxis().

Here is the call graph for this function:

~VariableBinAxis()

virtual VariableBinAxis::~VariableBinAxis ( )

inlinevirtual

Definition at line 33 of file VariableBinAxis.h.

{}

VariableBinAxis() [2/2]

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

protected

Definition at line 33 of file VariableBinAxis.cpp.

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

Member Function Documentation

clone()

VariableBinAxis * VariableBinAxis::clone ( ) const

virtual

clone function

Implements IAxis.

Definition at line 38 of file VariableBinAxis.cpp.

{
    VariableBinAxis* result = new VariableBinAxis(getName(), m_nbins, m_bin_boundaries);
    return result;
}

References IAxis::getName(), m_bin_boundaries, m_nbins, and VariableBinAxis().

Here is the call graph for this function:

size()

size_t VariableBinAxis::size ( ) const

inlinevirtual

retrieve the number of bins

Implements IAxis.

Definition at line 37 of file VariableBinAxis.h.

{ return m_nbins; }

References m_nbins.

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

operator[]()

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

virtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 44 of file VariableBinAxis.cpp.

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

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

Here is the call graph for this function:

getBin()

Bin1D VariableBinAxis::getBin ( size_t  index ) const

virtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 49 of file VariableBinAxis.cpp.

{
    if (index >= m_nbins)
        throw Exceptions::OutOfBoundsException("VariableBinAxis::getBin() -> 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 createClippedAxis(), ConstKBinAxis::createClippedAxis(), getBinCenter(), getBinCenters(), and operator[]().

getMin()

double VariableBinAxis::getMin ( ) const

virtual

Returns value of first point of axis.

Implements IAxis.

Definition at line 58 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.front();
}

References m_bin_boundaries.

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

getMax()

double VariableBinAxis::getMax ( ) const

virtual

Returns value of last point of axis.

Implements IAxis.

Definition at line 63 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.back();
}

References m_bin_boundaries.

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

getBinCenter()

double VariableBinAxis::getBinCenter ( size_t  index ) const

virtual

Implements IAxis.

Definition at line 68 of file VariableBinAxis.cpp.

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

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

Here is the call graph for this function:

findClosestIndex()

size_t VariableBinAxis::findClosestIndex ( double  value ) const

virtual

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 getMax(), getMin(), m_bin_boundaries, and m_nbins.

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

Here is the call graph for this function:

getBinCenters()

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

virtual

Reimplemented from IAxis.

Definition at line 93 of file VariableBinAxis.cpp.

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

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

Here is the call graph for this function:

getBinBoundaries()

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

inlinevirtual

Reimplemented from IAxis.

Definition at line 51 of file VariableBinAxis.h.

{ return m_bin_boundaries; }

References m_bin_boundaries.

Referenced by ConstKBinAxis::createClippedAxis().

createClippedAxis()

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

virtual

Creates a new clipped axis.

Reimplemented from IAxis.

Reimplemented in ConstKBinAxis, and CustomBinAxis.

Definition at line 103 of file VariableBinAxis.cpp.

{
 
    if (left >= right)
        throw Exceptions::LogicErrorException("VariableBinAxis::createClippedAxis() -> Error. "
                                              "'left'' should be smaller than 'right'");
 
    if (left < getMin())
        left = getBin(0).getMidPoint();
    if (right >= getMax())
        right = getBin(size() - 1).getMidPoint();
 
    size_t nbin1 = findClosestIndex(left);
    size_t nbin2 = findClosestIndex(right);
 
    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]);
    }
 
    return new VariableBinAxis(getName(), new_nbins, new_boundaries);
}

References findClosestIndex(), getBin(), getMax(), Bin1D::getMidPoint(), getMin(), IAxis::getName(), m_bin_boundaries, size(), and VariableBinAxis().

Here is the call graph for this function:

pyString()

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

finalvirtual

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 )

protected

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

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

print()

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

protectedvirtual

Implements IAxis.

Reimplemented in ConstKBinAxis, and CustomBinAxis.

Definition at line 132 of file VariableBinAxis.cpp.

{
    ostr << "VariableBinAxis(\"" << getName() << "\", " << 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::getName(), m_bin_boundaries, and size().

Here is the call graph for this function:

equals()

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

protectedvirtual

Reimplemented from IAxis.

Reimplemented in ConstKBinAxis, and CustomBinAxis.

Definition at line 143 of file VariableBinAxis.cpp.

{
    if (!IAxis::equals(other))
        return false;
    if (const VariableBinAxis* 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 (!algo::almostEqual(m_bin_boundaries[i], p_other_cast->m_bin_boundaries[i])) {
                return false;
            }
        }
        return true;
    }
    return false;
}

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

Here is the call graph for this function:

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(), CustomBinAxis::clone(), FixedBinAxis::clone(), clone(), ConstKBinAxis::clone(), PointwiseAxis::clone(), FixedBinAxis::createClippedAxis(), createClippedAxis(), ConstKBinAxis::createClippedAxis(), PointwiseAxis::createClippedAxis(), IAxis::equals(), CustomBinAxis::print(), FixedBinAxis::print(), 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_nbins

size_t VariableBinAxis::m_nbins

protected

Definition at line 63 of file VariableBinAxis.h.

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

m_bin_boundaries

std::vector<double> VariableBinAxis::m_bin_boundaries

private

vector containing the bin limits

Definition at line 66 of file VariableBinAxis.h.

Referenced by clone(), createClippedAxis(), equals(), findClosestIndex(), getBin(), getBinBoundaries(), getMax(), getMin(), print(), and 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/VariableBinAxis.h
• /home/www/ba/Base/Axis/VariableBinAxis.cpp