VariableBinAxis Class Reference

Axis with variable bin size. More...

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)
	VariableBinAxis constructor. More...
virtual	~VariableBinAxis ()
Bin1D	bin (size_t index) const
	retrieve a 1d bin for the given index More...
std::vector< double >	binBoundaries () const
double	binCenter (size_t index) const
std::vector< double >	binCenters () const
double	center () const
	Returns midpoint of axis. More...
VariableBinAxis *	clone () const
	clone function More...
virtual bool	contains (double value) const
	Returns true if axis contains given point. More...
virtual VariableBinAxis *	createClippedAxis (double left, double right) const
	Creates a new clipped axis. More...
size_t	findClosestIndex (double value) const
	find bin index which is best match for given value More...
std::string	getName () const
	retrieve the label of the axis More...
double	lowerBound () const
	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
	indexed accessor retrieves a sample More...
void	setName (std::string name)
	Sets the axis label. More...
size_t	size () const
	retrieve the number of bins More...
double	span () const
	Returns distance from first to last point. More...
double	upperBound () const
	Returns value of last point of axis. More...

Protected Member Functions
	VariableBinAxis (const std::string &name, size_t nbins=0)
virtual bool	equals (const IAxis &other) const
virtual void	print (std::ostream &ostr) const
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...

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 20 of file VariableBinAxis.cpp.

    : IAxis(name), m_nbins(nbins)
{
    if (m_nbins != bin_boundaries.size() - 1)
        throw std::runtime_error("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 32 of file VariableBinAxis.h.

{}

VariableBinAxis() [2/2]

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

protected

Definition at line 31 of file VariableBinAxis.cpp.

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

Member Function Documentation

bin()

Bin1D VariableBinAxis::bin ( size_t  index ) const

virtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 47 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(), createClippedAxis(), ConstKBinAxis::createClippedAxis(), and operator[]().

binBoundaries()

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

inlinevirtual

Reimplemented from IAxis.

Definition at line 50 of file VariableBinAxis.h.

{ return m_bin_boundaries; }

References m_bin_boundaries.

Referenced by ConstKBinAxis::createClippedAxis().

binCenter()

double VariableBinAxis::binCenter ( size_t  index ) const

virtual

Implements IAxis.

Definition at line 66 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

virtual

Reimplemented from IAxis.

Definition at line 90 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:

center()

double IAxis::center ( ) const

inherited

Returns midpoint of axis.

Definition at line 47 of file IAxis.cpp.

{
    return (upperBound() + lowerBound()) / 2;
}

References IAxis::lowerBound(), and IAxis::upperBound().

Here is the call graph for this function:

clone()

VariableBinAxis * VariableBinAxis::clone ( ) const

virtual

clone function

Implements IAxis.

Definition at line 36 of file VariableBinAxis.cpp.

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

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

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 37 of file IAxis.cpp.

{
    return value >= lowerBound() && value < upperBound();
}

References IAxis::lowerBound(), and IAxis::upperBound().

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

Here is the call graph for this function:

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 100 of file VariableBinAxis.cpp.

{
 
    if (left >= right)
        throw std::runtime_error("VariableBinAxis::createClippedAxis() -> Error. "
                                 "'left'' should be smaller than 'right'");
 
    if (left < lowerBound())
        left = bin(0).center();
    if (right >= upperBound())
        right = bin(size() - 1).center();
 
    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 VariableBinAxis(), bin(), Bin1D::center(), findClosestIndex(), IAxis::getName(), lowerBound(), m_bin_boundaries, size(), and upperBound().

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 135 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:

findClosestIndex()

size_t VariableBinAxis::findClosestIndex ( double  value ) const

virtual

find bin index which is best match for given value

Implements IAxis.

Definition at line 71 of file VariableBinAxis.cpp.

{
    if (m_bin_boundaries.size() < 2)
        throw std::runtime_error("VariableBinAxis::findClosestIndex() -> Error! "
                                 "VariableBinAxis not  correctly initialized");
    if (value < lowerBound()) {
        return 0;
    } else if (value >= upperBound()) {
        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 lowerBound(), m_bin_boundaries, m_nbins, and upperBound().

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

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(), ImportDataUtils::CreateSimplifiedOutputData(), IAxis::equals(), CustomBinAxis::print(), FixedBinAxis::print(), print(), ConstKBinAxis::print(), PointwiseAxis::print(), and TransformFromDomain::setAxisItem().

lowerBound()

double VariableBinAxis::lowerBound ( ) const

virtual

Returns value of first point of axis.

Implements IAxis.

Definition at line 56 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.front();
}

References m_bin_boundaries.

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

operator!=()

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

inlineinherited

Definition at line 70 of file IAxis.h.

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

operator==()

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

inlineinherited

test for equality

Definition at line 69 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

virtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 42 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

protectedvirtual

Implements IAxis.

Reimplemented in ConstKBinAxis, and CustomBinAxis.

Definition at line 124 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:

setBinBoundaries()

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

protected

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

References m_bin_boundaries.

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

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, and RealSpace::Particles::name().

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 36 of file VariableBinAxis.h.

{ return m_nbins; }

References m_nbins.

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

span()

double IAxis::span ( ) const

inherited

Returns distance from first to last point.

Definition at line 42 of file IAxis.cpp.

{
    return upperBound() - lowerBound();
}

References IAxis::lowerBound(), and IAxis::upperBound().

Referenced by RectangularDetector::getHeight(), RectangularDetector::getWidth(), and DetectorUtils::isQuadratic().

Here is the call graph for this function:

upperBound()

double VariableBinAxis::upperBound ( ) const

virtual

Returns value of last point of axis.

Implements IAxis.

Definition at line 61 of file VariableBinAxis.cpp.

{
    return m_bin_boundaries.back();
}

References m_bin_boundaries.

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

Member Data Documentation

m_bin_boundaries

std::vector<double> VariableBinAxis::m_bin_boundaries

private

vector containing the bin limits

Definition at line 63 of file VariableBinAxis.h.

Referenced by bin(), binBoundaries(), clone(), createClippedAxis(), equals(), findClosestIndex(), lowerBound(), print(), setBinBoundaries(), and upperBound().

m_name

std::string IAxis::m_name

privateinherited

axis name

Definition at line 96 of file IAxis.h.

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

m_nbins

size_t VariableBinAxis::m_nbins

protected

Definition at line 60 of file VariableBinAxis.h.

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

---

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