Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst::afw::math::Interpolate Class Referenceabstract

#include <Interpolate.h>

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

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
 
Interpolateoperator= (Interpolate const &)=delete
 
Interpolateoperator= (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< InterpolatemakeInterpolate (std::vector< double > const &x, std::vector< double > const &y, Interpolate::Style const style=Interpolate::AKIMA_SPLINE)
 A factory function to make Interpolate objects.
 

Detailed Description

Definition at line 36 of file Interpolate.h.

Member Enumeration Documentation

◆ 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.

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
xthe ordinates of points
ythe values at x[]
styledesired interpolator

Definition at line 67 of file Interpolate.h.

71 : _x(x), _y(y), _style(style) {}
std::vector< double > const _x
Definition Interpolate.h:83
std::vector< double > const _y
Definition Interpolate.h:84
Interpolate::Style const _style
Definition Interpolate.h:85

◆ 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
xypair (x,y) where x are the ordinates of points and y are the values at x[]
styledesired interpolator

Definition at line 340 of file Interpolate.cc.

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

Member Function Documentation

◆ interpolate() [1/3]

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

◆ 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.

308 {
309 int const num = x.getShape()[0];
310 ndarray::Array<double, 1> out = ndarray::allocate(ndarray::makeVector(num));
311 for (int i = 0; i < num; ++i) {
312 std::cout << "Interpolating " << x[i] << std::endl;
313 out[i] = interpolate(x[i]);
314 }
315 return out;
316}
virtual double interpolate(double const x) const =0
T endl(T... args)

◆ 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.

299 {
300 size_t const num = x.size();
301 std::vector<double> out(num);
302 for (size_t i = 0; i < num; ++i) {
303 out[i] = interpolate(x[i]);
304 }
305 return out;
306}

◆ 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
xthe x-values of points
ythe values at x[]
styledesired interpolator

Definition at line 347 of file Interpolate.cc.

348 {
349 switch (style) {
351 return std::shared_ptr<Interpolate>(new InterpolateConstant(x, y, style));
352 default: // use GSL
353 return std::shared_ptr<Interpolate>(new InterpolateGsl(x, y, style));
354 }
355}

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: