lsst::afw::math::Interpolate Class Reference

#include <Interpolate.h>

Inheritance diagram for lsst::afw::math::Interpolate:

Public Types
enum	Style {   UNKNOWN = -1 , CONSTANT = 0 , LINEAR = 1 , NATURAL_SPLINE = 2 ,   CUBIC_SPLINE = 3 , CUBIC_SPLINE_PERIODIC = 4 , AKIMA_SPLINE = 5 , AKIMA_SPLINE_PERIODIC = 6 ,   NUM_STYLES }

Public Member Functions
	Interpolate (Interpolate const &)=delete
	Interpolate (Interpolate &&)=delete
Interpolate &	operator= (Interpolate const &)=delete
Interpolate &	operator= (Interpolate &&)=delete
virtual	~Interpolate ()=default
virtual double	interpolate (double const x) const =0
std::vector< double >	interpolate (std::vector< double > const &x) const
ndarray::Array< double, 1 >	interpolate (ndarray::Array< double const, 1 > const &x) const

Protected Member Functions
	Interpolate (std::vector< double > const &x, std::vector< double > const &y, Interpolate::Style const style=UNKNOWN)
	Base class ctor.
	Interpolate (std::pair< std::vector< double >, std::vector< double > > const xy, Interpolate::Style const style=UNKNOWN)
	Base class ctor.

Protected Attributes
std::vector< double > const	_x
std::vector< double > const	_y
Interpolate::Style const	_style

Friends
std::shared_ptr< Interpolate >	makeInterpolate (std::vector< double > const &x, std::vector< double > const &y, Interpolate::Style const style)
	A factory function to make Interpolate objects.

Detailed Description

Definition at line 36 of file Interpolate.h.

Member Enumeration Documentation

Style

enum lsst::afw::math::Interpolate::Style

Enumerator
UNKNOWN
CONSTANT
LINEAR
NATURAL_SPLINE
CUBIC_SPLINE
CUBIC_SPLINE_PERIODIC
AKIMA_SPLINE
AKIMA_SPLINE_PERIODIC
NUM_STYLES

Definition at line 38 of file Interpolate.h.

               {
        UNKNOWN = -1,
        CONSTANT = 0,
        LINEAR = 1,
        NATURAL_SPLINE = 2,
        CUBIC_SPLINE = 3,
        CUBIC_SPLINE_PERIODIC = 4,
        AKIMA_SPLINE = 5,
        AKIMA_SPLINE_PERIODIC = 6,
        NUM_STYLES
    };

Constructor & Destructor Documentation

Interpolate() [1/4]

lsst::afw::math::Interpolate::Interpolate ( Interpolate const & )

delete

Interpolate() [2/4]

lsst::afw::math::Interpolate::Interpolate ( Interpolate && )

delete

~Interpolate()

virtual lsst::afw::math::Interpolate::~Interpolate ( )

virtualdefault

Interpolate() [3/4]

lsst::afw::math::Interpolate::Interpolate ( std::vector< double > const & x, std::vector< double > const & y, Interpolate::Style const style = UNKNOWN )

inlineprotected

Base class ctor.

Parameters

x	the ordinates of points
y	the values at x[]
style	desired interpolator

Definition at line 67 of file Interpolate.h.

            : _x(x), _y(y), _style(style) {}

Interpolate() [4/4]

lsst::afw::math::Interpolate::Interpolate ( std::pair< std::vector< double >, std::vector< double > > const xy, Interpolate::Style const style = UNKNOWN )

protected

Base class ctor.

Note that we should use rvalue references when available as the vectors in xy will typically be movable (although the returned-value-optimisation might suffice for the cases we care about)

Parameters

xy	pair (x,y) where x are the ordinates of points and y are the values at x[]
style	desired interpolator

Definition at line 340 of file Interpolate.cc.

        : _x(xy.first), _y(xy.second), _style(style) {
    ;
}

Member Function Documentation

interpolate() [1/3]

virtual double lsst::afw::math::Interpolate::interpolate ( double const x ) const

pure virtual

Implemented in lsst::afw::math::InterpolateConstant, and lsst::afw::math::InterpolateGsl.

interpolate() [2/3]

ndarray::Array< double, 1 > lsst::afw::math::Interpolate::interpolate

(

ndarray::Array< double const, 1 > const &

x

)

const

Definition at line 308 of file Interpolate.cc.

                                                                                             {
    int const num = x.getShape()[0];
    ndarray::Array<double, 1> out = ndarray::allocate(ndarray::makeVector(num));
    for (int i = 0; i < num; ++i) {
        std::cout << "Interpolating " << x[i] << std::endl;
        out[i] = interpolate(x[i]);
    }
    return out;
}

interpolate() [3/3]

std::vector< double > lsst::afw::math::Interpolate::interpolate

(

std::vector< double > const &

x

)

const

Definition at line 299 of file Interpolate.cc.

                                                                           {
    size_t const num = x.size();
    std::vector<double> out(num);
    for (size_t i = 0; i < num; ++i) {
        out[i] = interpolate(x[i]);
    }
    return out;
}

operator=() [1/2]

Interpolate & lsst::afw::math::Interpolate::operator= ( Interpolate && )

delete

operator=() [2/2]

Interpolate & lsst::afw::math::Interpolate::operator= ( Interpolate const & )

delete

Friends And Related Symbol Documentation

makeInterpolate

std::shared_ptr< Interpolate > makeInterpolate ( std::vector< double > const & x, std::vector< double > const & y, Interpolate::Style const style = Interpolate::AKIMA_SPLINE )

friend

A factory function to make Interpolate objects.

Parameters

x	the x-values of points
y	the values at x[]
style	desired interpolator

Definition at line 347 of file Interpolate.cc.

                                                                           {
    switch (style) {
        case Interpolate::CONSTANT:
            return std::shared_ptr<Interpolate>(new InterpolateConstant(x, y, style));
        default:  // use GSL
            return std::shared_ptr<Interpolate>(new InterpolateGsl(x, y, style));
    }
}

Member Data Documentation

_style

Interpolate::Style const lsst::afw::math::Interpolate::_style

protected

Definition at line 85 of file Interpolate.h.

_x

std::vector<double> const lsst::afw::math::Interpolate::_x

protected

Definition at line 83 of file Interpolate.h.

_y

std::vector<double> const lsst::afw::math::Interpolate::_y

protected

Definition at line 84 of file Interpolate.h.

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/include/lsst/afw/math/Interpolate.h
• /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/afw/g5a732f18d5+53520f316c/src/math/Interpolate.cc