PointwiseAxis Class Reference

Inheritance diagram for PointwiseAxis:

Collaboration diagram for PointwiseAxis:

Public Member Functions
template<class String , class Vector >
	PointwiseAxis (String &&name, Vector &&coordinate_values)
PointwiseAxis *	clone () const override
	~PointwiseAxis () override=default
size_t	size () const override
double	operator[] (size_t index) const override
Bin1D	getBin (size_t index) const override
double	getMin () const override
double	getMax () const override
double	getBinCenter (size_t index) const override
size_t	findClosestIndex (double value) const override
std::vector< double >	getBinCenters () const override
std::vector< double >	getBinBoundaries () const override
PointwiseAxis *	createClippedAxis (double left, double right) const override
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

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

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

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::getBinCenter 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 32 of file PointwiseAxis.h.

Constructor & Destructor Documentation

PointwiseAxis()

template<class String , class Vector >

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

inline

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

clone()

PointwiseAxis * PointwiseAxis::clone ( ) const

overridevirtual

clone function

Implements IAxis.

Definition at line 23 of file PointwiseAxis.cpp.

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

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

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 48 of file PointwiseAxis.h.

{ return m_coordinates.size(); }

References m_coordinates.

operator[]()

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

inlineoverridevirtual

indexed accessor retrieves a sample

Implements IAxis.

Definition at line 51 of file PointwiseAxis.h.

{ return getBinCenter(index); }

References getBinCenter().

Here is the call graph for this function:

getBin()

Bin1D PointwiseAxis::getBin ( size_t  index ) const

overridevirtual

retrieve a 1d bin for the given index

Implements IAxis.

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

getMin()

double PointwiseAxis::getMin ( ) const

overridevirtual

Returns value of first on-axis point.

Implements IAxis.

Definition at line 34 of file PointwiseAxis.cpp.

{
    return lowerBoundary(0);
}

References lowerBoundary().

Here is the call graph for this function:

getMax()

double PointwiseAxis::getMax ( ) const

overridevirtual

Returns value of last on-axis point.

Implements IAxis.

Definition at line 39 of file PointwiseAxis.cpp.

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

References m_coordinates, and upperBoundary().

Here is the call graph for this function:

getBinCenter()

double PointwiseAxis::getBinCenter ( size_t  index ) const

overridevirtual

Returns the coordinate corresponding to the given index.

Implements IAxis.

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

findClosestIndex()

size_t PointwiseAxis::findClosestIndex ( double  value ) const

overridevirtual

find index of the coordinate closest to the given value

Implements IAxis.

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

getBinCenters()

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

inlineoverridevirtual

Reimplemented from IAxis.

Definition at line 69 of file PointwiseAxis.h.

{ return m_coordinates; }

References m_coordinates.

Referenced by pyString().

getBinBoundaries()

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

overridevirtual

Reimplemented from IAxis.

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

createClippedAxis()

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

overridevirtual

Creates a new clipped axis.

Reimplemented from IAxis.

Definition at line 74 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 findClosestIndex(), IAxis::getName(), m_coordinates, and PointwiseAxis().

Here is the call graph for this function:

pyString()

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

finalvirtual

Implements IAxis.

Definition at line 87 of file PointwiseAxis.cpp.

{
    std::ostringstream result;
    const std::string py_def_call = "numpy.asarray([";
    const size_t total_offset = offset + py_def_call.size();
    result << py_def_call;
    std::vector<double> points = getBinCenters();
    for (auto iter = points.begin(); iter != points.end() - 1; ++iter) {
        result << pyfmt::printValue(*iter, units) << ",\n";
        result << pyfmt::indent(total_offset);
    }
    result << pyfmt::printValue(points.back(), units) << "])";
    return result.str();
}

References getBinCenters(), pyfmt::indent(), and pyfmt::printValue().

Here is the call graph for this function:

print()

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

overrideprivatevirtual

Implements IAxis.

Definition at line 102 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(), m_coordinates, and anonymous_namespace{OutputDataWriteStrategy.cpp}::precision.

Here is the call graph for this function:

equals()

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

overrideprivatevirtual

Reimplemented from IAxis.

Definition at line 112 of file PointwiseAxis.cpp.

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

References IAxis::equals(), and m_coordinates.

Here is the call graph for this function:

lowerBoundary()

double PointwiseAxis::lowerBoundary ( size_t  index ) const

private

Definition at line 121 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 findClosestIndex(), getBin(), getBinBoundaries(), and getMin().

upperBoundary()

double PointwiseAxis::upperBoundary ( size_t  index ) const

private

Definition at line 128 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 getBin(), getBinBoundaries(), and getMax().

checkIndex()

void PointwiseAxis::checkIndex ( size_t  index ) const

private

Definition at line 135 of file PointwiseAxis.cpp.

{
    if (m_coordinates.size() > index)
        return;
    std::string message = "Error in PointwiseAxis::getBinCenter: 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 getBin(), and getBinCenter().

sanityCheck()

void PointwiseAxis::sanityCheck ( ) const

private

Definition at line 145 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().

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(), IAxis::equals(), CustomBinAxis::print(), FixedBinAxis::print(), VariableBinAxis::print(), ConstKBinAxis::print(), 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_coordinates

std::vector<double> PointwiseAxis::m_coordinates

private

Definition at line 87 of file PointwiseAxis.h.

Referenced by checkIndex(), clone(), createClippedAxis(), equals(), findClosestIndex(), getBinBoundaries(), getBinCenter(), getBinCenters(), getMax(), lowerBoundary(), print(), sanityCheck(), size(), and upperBoundary().

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