PointwiseAxis Class Reference

Axis containing arbitrary (non-equidistant) coordinate values. More...

Inheritance diagram for PointwiseAxis:

Collaboration diagram for PointwiseAxis:

Public Member Functions
template<class String , class Vector >
	PointwiseAxis (String &&name, Vector &&coordinate_values)
	~PointwiseAxis () override=default
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
	Returns the coordinate corresponding to the given index. More...
std::vector< double >	binCenters () const override
double	center () const
	Returns midpoint of axis. More...
PointwiseAxis *	clone () const override
	clone function More...
virtual bool	contains (double value) const
	Returns true if axis contains given point. More...
PointwiseAxis *	createClippedAxis (double left, double right) const override
	Creates a new clipped axis. More...
size_t	findClosestIndex (double value) const override
	find index of the coordinate closest to the given value More...
std::string	getName () const
	retrieve the label of the axis More...
double	lowerBound () const override
	Returns value of first on-axis point. 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	setName (std::string name)
	Sets the axis label. More...
size_t	size () const override
	retrieve the number of bins More...
double	span () const
	Returns distance from first to last point. More...
double	upperBound () const override
	Returns value of last on-axis point. More...

Private Member Functions
void	checkIndex (size_t index) const
bool	equals (const IAxis &other) const override
double	lowerBoundary (size_t index) const
void	print (std::ostream &ostr) const override
void	sanityCheck () const
double	upperBoundary (size_t index) const

Private Attributes
std::vector< double >	m_coordinates
std::string	m_name
	axis name More...

Detailed Description

Axis containing arbitrary (non-equidistant) coordinate values.

Lower boundary of the first bin and upper boundary of the last bin correspond to first and last passed coordinates. Other bin boundaries are computed as arithmetical mean of two adjacent coordinates. One should be aware, that bin centers reported by PointwiseAxis::binCenter do not coincide with the values produced by Bin1D::getMidPoint. On-axis values are bounded by minimum/maximum values passed to the constructor.

Definition at line 37 of file PointwiseAxis.h.

Constructor & Destructor Documentation

PointwiseAxis()

template<class String , class Vector >

PointwiseAxis::PointwiseAxis ( String &&  name, Vector &&  coordinate_values  )

inline

Definition at line 40 of file PointwiseAxis.h.

        : IAxis(std::forward<String>(name)), m_coordinates(std::forward<Vector>(coordinate_values))
    {
        sanityCheck();
    }

References sanityCheck().

Referenced by clone(), and createClippedAxis().

Here is the call graph for this function:

~PointwiseAxis()

PointwiseAxis::~PointwiseAxis ( )

overridedefault

Member Function Documentation

bin()

Bin1D PointwiseAxis::bin ( size_t  index ) const

overridevirtual

retrieve a 1d bin for the given index

Implements IAxis.

Definition at line 27 of file PointwiseAxis.cpp.

{
    checkIndex(index);
    return Bin1D(lowerBoundary(index), upperBoundary(index));
}

References checkIndex(), lowerBoundary(), and upperBoundary().

Here is the call graph for this function:

binBoundaries()

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

overridevirtual

Reimplemented from IAxis.

Definition at line 62 of file PointwiseAxis.cpp.

{
    std::vector<double> result;
    const size_t v_size = m_coordinates.size();
    result.reserve(v_size + 1);
    for (size_t i = 0; i < v_size; ++i)
        result.push_back(lowerBoundary(i));
    result.push_back(upperBoundary(v_size - 1));
    return result;
}

References lowerBoundary(), m_coordinates, and upperBoundary().

Here is the call graph for this function:

binCenter()

double PointwiseAxis::binCenter ( size_t  index ) const

overridevirtual

Returns the coordinate corresponding to the given index.

For this type of axis ("pointwise") this equals returning an explicitly defined coordinate.

Implements IAxis.

Definition at line 43 of file PointwiseAxis.cpp.

{
    checkIndex(index);
    return m_coordinates[index];
}

References checkIndex(), and m_coordinates.

Referenced by operator[]().

Here is the call graph for this function:

binCenters()

std::vector<double> PointwiseAxis::binCenters ( ) const

inlineoverridevirtual

Reimplemented from IAxis.

Definition at line 74 of file PointwiseAxis.h.

{ return m_coordinates; }

References m_coordinates.

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:

checkIndex()

void PointwiseAxis::checkIndex ( size_t  index ) const

private

Definition at line 119 of file PointwiseAxis.cpp.

{
    if (m_coordinates.size() > index)
        return;
    std::string message = "Error in PointwiseAxis::binCenter: passed index ";
    message += std::to_string(index) + " exceeds the size ";
    message += std::to_string(m_coordinates.size()) + " of the axis";
    throw std::runtime_error(message);
}

References m_coordinates.

Referenced by bin(), and binCenter().

clone()

PointwiseAxis * PointwiseAxis::clone ( ) const

overridevirtual

clone function

Implements IAxis.

Definition at line 22 of file PointwiseAxis.cpp.

{
    return new PointwiseAxis(getName(), m_coordinates);
}

References PointwiseAxis(), IAxis::getName(), and m_coordinates.

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

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

overridevirtual

Creates a new clipped axis.

Reimplemented from IAxis.

Definition at line 73 of file PointwiseAxis.cpp.

{
    if (left >= right)
        throw std::runtime_error("Error in PointwiseAxis::createClippedAxis: "
                                 "'left' should be smaller than 'right'");
 
    using diff_t = std::vector<double>::iterator::difference_type;
    auto begin = m_coordinates.begin() + static_cast<diff_t>(findClosestIndex(left));
    auto end = m_coordinates.begin() + static_cast<diff_t>(findClosestIndex(right)) + 1;
 
    return new PointwiseAxis(getName(), std::vector<double>(begin, end));
}

References PointwiseAxis(), findClosestIndex(), IAxis::getName(), and m_coordinates.

Here is the call graph for this function:

equals()

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

overrideprivatevirtual

Reimplemented from IAxis.

Definition at line 96 of file PointwiseAxis.cpp.

{
    if (!IAxis::equals(other))
        return false;
    if (const PointwiseAxis* otherAxis = dynamic_cast<const PointwiseAxis*>(&other))
        return m_coordinates == otherAxis->binCenters();
    return false;
}

References IAxis::equals(), and m_coordinates.

Here is the call graph for this function:

findClosestIndex()

size_t PointwiseAxis::findClosestIndex ( double  value ) const

overridevirtual

find index of the coordinate closest to the given value

Implements IAxis.

Definition at line 49 of file PointwiseAxis.cpp.

{
    if (value <= m_coordinates.front())
        return 0;
    if (value >= m_coordinates.back())
        return m_coordinates.size() - 1;
 
    const auto begin = m_coordinates.begin();
    auto result = std::lower_bound(begin, m_coordinates.end(), value);
    size_t index = static_cast<size_t>(std::distance(begin, result));
    return value < lowerBoundary(index) ? index - 1 : index;
}

References lowerBoundary(), and m_coordinates.

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

lowerBound()

double PointwiseAxis::lowerBound ( ) const

overridevirtual

Returns value of first on-axis point.

Implements IAxis.

Definition at line 33 of file PointwiseAxis.cpp.

{
    return lowerBoundary(0);
}

References lowerBoundary().

Here is the call graph for this function:

lowerBoundary()

double PointwiseAxis::lowerBoundary ( size_t  index ) const

private

Definition at line 105 of file PointwiseAxis.cpp.

{
    if (index == 0)
        return m_coordinates.front();
    return 0.5 * (m_coordinates[index] + m_coordinates[index - 1]);
}

References m_coordinates.

Referenced by bin(), binBoundaries(), findClosestIndex(), and lowerBound().

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 PointwiseAxis::operator[] ( size_t  index ) const

inlineoverridevirtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 55 of file PointwiseAxis.h.

{ return binCenter(index); }

References binCenter().

Here is the call graph for this function:

print()

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

overrideprivatevirtual

Implements IAxis.

Definition at line 86 of file PointwiseAxis.cpp.

{
    auto precision = std::setprecision(std::numeric_limits<double>::digits10 + 2);
    ostr << "PointwiseAxis(\"" << getName() << "\", "
         << ", [";
    for (size_t i = 0, fin = m_coordinates.size() - 1; i < fin; ++i)
        ostr << precision << m_coordinates[i] << ",";
    ostr << precision << m_coordinates.back() << "])";
}

References IAxis::getName(), and m_coordinates.

Here is the call graph for this function:

sanityCheck()

void PointwiseAxis::sanityCheck ( ) const

private

Definition at line 129 of file PointwiseAxis.cpp.

{
    if (m_coordinates.size() < min_axis_size)
        throw std::runtime_error(
            "Error in PointwiseAxis::PointwiseAxis: the size of passed coordinate array is "
            "less than minimum acceptable value");
 
    const auto begin = m_coordinates.begin();
    const auto end = m_coordinates.end();
 
    if (!std::is_sorted(begin, end))
        throw std::runtime_error("Error in PointwiseAxis::PointwiseAxis: passed coordinates are "
                                 "not sorted in ascending order");
 
    if (std::adjacent_find(begin, end) != end)
        throw std::runtime_error("Error in PointwiseAxis::PointwiseAxis: passed coordinate vector "
                                 "contains repeating values");
}

References m_coordinates, and min_axis_size.

Referenced by PointwiseAxis().

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 PointwiseAxis::size ( ) const

inlineoverridevirtual

retrieve the number of bins

Implements IAxis.

Definition at line 52 of file PointwiseAxis.h.

{ return m_coordinates.size(); }

References m_coordinates.

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 PointwiseAxis::upperBound ( ) const

overridevirtual

Returns value of last on-axis point.

Implements IAxis.

Definition at line 38 of file PointwiseAxis.cpp.

{
    return upperBoundary(m_coordinates.size() - 1);
}

References m_coordinates, and upperBoundary().

Here is the call graph for this function:

upperBoundary()

double PointwiseAxis::upperBoundary ( size_t  index ) const

private

Definition at line 112 of file PointwiseAxis.cpp.

{
    if (index + 1 == m_coordinates.size())
        return m_coordinates.back();
    return 0.5 * (m_coordinates[index] + m_coordinates[index + 1]);
}

References m_coordinates.

Referenced by bin(), binBoundaries(), and upperBound().

Member Data Documentation

m_coordinates

std::vector<double> PointwiseAxis::m_coordinates

private

Definition at line 90 of file PointwiseAxis.h.

Referenced by binBoundaries(), binCenter(), binCenters(), checkIndex(), clone(), createClippedAxis(), equals(), findClosestIndex(), lowerBoundary(), print(), sanityCheck(), size(), upperBound(), and upperBoundary().

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

---

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

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