FixedBinAxis Class Reference

Inheritance diagram for FixedBinAxis:

Collaboration diagram for FixedBinAxis:

Public Member Functions
	FixedBinAxis (const std::string &name, size_t nbins, double start, double end)
virtual	~FixedBinAxis ()
FixedBinAxis *	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
FixedBinAxis *	createClippedAxis (double left, double right) const
std::string	pyString (const std::string &units, size_t) 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
virtual bool	equals (const IAxis &other) const

Private Attributes
size_t	m_nbins
double	m_start
double	m_end
std::string	m_name

Detailed Description

Axis with fixed bin size.

Definition at line 23 of file FixedBinAxis.h.

Constructor & Destructor Documentation

FixedBinAxis()

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

FixedBinAxis constructor.

Parameters

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

Definition at line 22 of file FixedBinAxis.cpp.

    : IAxis(name), m_nbins(nbins), m_start(start), m_end(end)
{
}

Referenced by clone(), and createClippedAxis().

~FixedBinAxis()

virtual FixedBinAxis::~FixedBinAxis ( )

inlinevirtual

Definition at line 32 of file FixedBinAxis.h.

{}

Member Function Documentation

clone()

FixedBinAxis * FixedBinAxis::clone ( ) const

virtual

clone function

Implements IAxis.

Definition at line 27 of file FixedBinAxis.cpp.

{
    FixedBinAxis* result = new FixedBinAxis(getName(), m_nbins, m_start, m_end);
    return result;
}

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

Here is the call graph for this function:

size()

size_t FixedBinAxis::size ( ) const

inlinevirtual

retrieve the number of bins

Implements IAxis.

Definition at line 36 of file FixedBinAxis.h.

{ return m_nbins; }

References m_nbins.

Referenced by StandardSimulations::BasicSpecularQ(), createClippedAxis(), equals(), getBinBoundaries(), getBinCenters(), print(), pyString(), and StandardSimulations::TOFRWithPointwiseResolution().

operator[]()

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

virtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 33 of file FixedBinAxis.cpp.

{
    if (index >= m_nbins)
        throw Exceptions::OutOfBoundsException("FixedBinAxis::operator[] -> Error. Wrong index.");
 
    double step = (m_end - m_start) / m_nbins;
    return m_start + (index + 0.5) * step;
}

References m_end, m_nbins, and m_start.

getBin()

Bin1D FixedBinAxis::getBin ( size_t  index ) const

virtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 42 of file FixedBinAxis.cpp.

{
    if (index >= m_nbins)
        throw Exceptions::OutOfBoundsException("FixedBinAxis::getBin() -> Error. Wrong index.");
 
    double step = (m_end - m_start) / m_nbins;
    Bin1D result(m_start + step * index, m_start + step * (index + 1));
    return result;
}

References m_end, m_nbins, and m_start.

Referenced by createClippedAxis(), getBinBoundaries(), and getBinCenters().

getMin()

double FixedBinAxis::getMin ( ) const

inlinevirtual

Returns value of first point of axis.

Implements IAxis.

Definition at line 42 of file FixedBinAxis.h.

{ return m_start; }

References m_start.

Referenced by createClippedAxis(), findClosestIndex(), print(), and pyString().

getMax()

double FixedBinAxis::getMax ( ) const

inlinevirtual

Returns value of last point of axis.

Implements IAxis.

Definition at line 43 of file FixedBinAxis.h.

{ return m_end; }

References m_end.

Referenced by createClippedAxis(), findClosestIndex(), print(), and pyString().

getBinCenter()

double FixedBinAxis::getBinCenter ( size_t  index ) const

inlinevirtual

Implements IAxis.

Definition at line 45 of file FixedBinAxis.h.

{ return (*this)[index]; }

findClosestIndex()

size_t FixedBinAxis::findClosestIndex ( double  value ) const

virtual

find bin index which is best match for given value

Implements IAxis.

Definition at line 52 of file FixedBinAxis.cpp.

{
    if (value < getMin()) {
        return 0;
    } else if (value >= getMax()) {
        return m_nbins - 1;
    }
 
    double step = (m_end - m_start) / m_nbins;
    return int((value - m_start) / step);
}

References getMax(), getMin(), m_end, m_nbins, and m_start.

Referenced by createClippedAxis().

Here is the call graph for this function:

getBinCenters()

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

virtual

Reimplemented from IAxis.

Definition at line 64 of file FixedBinAxis.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().

Referenced by StandardSimulations::BasicSpecularQ(), and StandardSimulations::TOFRWithPointwiseResolution().

Here is the call graph for this function:

getBinBoundaries()

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

virtual

Reimplemented from IAxis.

Definition at line 74 of file FixedBinAxis.cpp.

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

References getBin(), Bin1D::m_lower, Bin1D::m_upper, and size().

Here is the call graph for this function:

createClippedAxis()

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

virtual

Creates a new clipped axis.

Reimplemented from IAxis.

Definition at line 85 of file FixedBinAxis.cpp.

{
    if (left >= right)
        throw Exceptions::LogicErrorException("FixedBinAxis::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);
 
    return new FixedBinAxis(getName(), nbin2 - nbin1 + 1, getBin(nbin1).m_lower,
                            getBin(nbin2).m_upper);
}

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

Here is the call graph for this function:

pyString()

std::string FixedBinAxis::pyString ( const std::string &  units, size_t    ) const

finalvirtual

Implements IAxis.

Definition at line 126 of file FixedBinAxis.cpp.

{
    std::ostringstream result;
    result << "ba.FixedBinAxis(" << pyfmt::printString(getName()) << ", " << size() << ", "
           << pyfmt::printValue(getMin(), units) << ", " << pyfmt::printValue(getMax(), units)
           << ")";
    return result.str();
}

References getMax(), getMin(), IAxis::getName(), pyfmt::printString(), pyfmt::printValue(), and size().

Here is the call graph for this function:

print()

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

protectedvirtual

Implements IAxis.

Definition at line 103 of file FixedBinAxis.cpp.

{
    ostr << "FixedBinAxis(\"" << getName() << "\", " << size() << ", "
         << std::setprecision(std::numeric_limits<double>::digits10 + 2) << getMin() << ", "
         << getMax() << ")";
}

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

Here is the call graph for this function:

equals()

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

protectedvirtual

Reimplemented from IAxis.

Definition at line 110 of file FixedBinAxis.cpp.

{
    if (!IAxis::equals(other))
        return false;
    if (const FixedBinAxis* otherAxis = dynamic_cast<const FixedBinAxis*>(&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 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(), clone(), VariableBinAxis::clone(), ConstKBinAxis::clone(), PointwiseAxis::clone(), createClippedAxis(), VariableBinAxis::createClippedAxis(), ConstKBinAxis::createClippedAxis(), PointwiseAxis::createClippedAxis(), IAxis::equals(), CustomBinAxis::print(), print(), VariableBinAxis::print(), ConstKBinAxis::print(), PointwiseAxis::print(), and 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 FixedBinAxis::m_nbins

private

Definition at line 62 of file FixedBinAxis.h.

Referenced by clone(), findClosestIndex(), getBin(), operator[](), and size().

m_start

double FixedBinAxis::m_start

private

Definition at line 63 of file FixedBinAxis.h.

Referenced by clone(), equals(), findClosestIndex(), getBin(), getMin(), and operator[]().

m_end

double FixedBinAxis::m_end

private

Definition at line 64 of file FixedBinAxis.h.

Referenced by clone(), equals(), findClosestIndex(), getBin(), getMax(), and operator[]().

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/FixedBinAxis.h
• /home/www/ba/Base/Axis/FixedBinAxis.cpp