LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
LSST Data Management Base Package
Loading...
Searching...
No Matches
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: