LSST Applications g0265f82a02+093ff98f47,g02d81e74bb+10352d6f39,g1f3e9fa97e+40b0fc677d,g2079a07aa2+14824f138e,g2bbee38e9b+093ff98f47,g337abbeb29+093ff98f47,g3ddfee87b4+064c02c7ee,g487adcacf7+7e842ebf4b,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g568d43a26c+1d7ac31cb0,g591dd9f2cf+fb1f69e2ea,g858d7b2824+10352d6f39,g8a8a8dda67+a6fc98d2e7,g8cdfe0ae6a+66d966b544,g99cad8db69+7ce8a7c20a,g9ddcbc5298+d4bad12328,ga1e77700b3+246acaaf9c,ga2e4dd1c03+064c02c7ee,ga8c6da7877+04f6ba86dc,gae46bcf261+093ff98f47,gb0e22166c9+3863383f4c,gba4ed39666+9664299f35,gbb8dafda3b+db40f59a7d,gbeb006f7da+e6a448e96d,gbf5cecdb8a+10352d6f39,gc0f3af6251+10a3fd39cd,gc120e1dc64+5839e50a77,gc28159a63d+093ff98f47,gcf0d15dbbd+064c02c7ee,gd2a12a3803+0c2c227a2b,gdaeeff99f8+a38ce5ea23,ge79ae78c31+093ff98f47,gee10cc3b42+a6fc98d2e7,gf1cff7945b+10352d6f39,w.2024.15
LSST Data Management Base Package
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
lsst::afw::math::InterpolateConstant Class Reference
Inheritance diagram for lsst::afw::math::InterpolateConstant:
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

 ~InterpolateConstant () override=default
 
double interpolate (double const x) const override
 
std::vector< double > interpolate (std::vector< double > const &x) const
 
ndarray::Array< double, 1 > interpolate (ndarray::Array< double const, 1 > const &x) const
 

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)
 A factory function to make Interpolate objects.
 

Detailed Description

Definition at line 76 of file Interpolate.cc.

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

◆ ~InterpolateConstant()

lsst::afw::math::InterpolateConstant::~InterpolateConstant ( )
overridedefault

Member Function Documentation

◆ interpolate() [1/3]

double lsst::afw::math::InterpolateConstant::interpolate ( double const x) const
overridevirtual

Implements lsst::afw::math::Interpolate.

Definition at line 95 of file Interpolate.cc.

96 {
97 //
98 // Look for the interval wherein lies xInterp. We could naively use std::upper_bound, but that requires a
99 // logarithmic time lookup so we'll cache the previous answer in _old -- this is a good idea if people
100 // usually call this routine repeatedly for a range of x
101 //
102 // We start by searching up from _old
103 //
104 if (xInterp < *_old) { // We're to the left of the cache
105 if (_old == _x.begin()) { // ... actually off the array
106 return _y[0];
107 }
108 _old = _x.begin(); // reset the cached point to the start of the array
109 } else { // see if we're still in the same interval
110 if (_old < _x.end() - 1 and xInterp < *(_old + 1)) { // we are, so we're done
111 return _y[_old - _x.begin()];
112 }
113 }
114 // We're to the right of the cached point and not in the same inverval, so search up from _old
115 std::vector<double>::const_iterator low = std::upper_bound(_old, _x.end(), xInterp);
116 //
117 // Did that work?
118 if (low == _old && _old != _x.begin()) {
119 // No. Sigh. Search the entire range.
120 low = std::upper_bound(_x.begin(), low + 1, xInterp);
121 }
122 //
123 // OK, we've found the right interval. Return the desired value, being careful at the ends
124 //
125 if (low == _x.end()) {
126 return _y[_y.size() - 1];
127 } else if (low == _x.begin()) {
128 return _y[0];
129 } else {
130 --low;
131 _old = low;
132 return _y[low - _x.begin()];
133 }
134}
T begin(T... args)
std::vector< double > const _x
Definition Interpolate.h:83
std::vector< double > const _y
Definition Interpolate.h:84
T end(T... args)
T size(T... args)
T upper_bound(T... args)

◆ interpolate() [2/3]

ndarray::Array< double, 1 > lsst::afw::math::Interpolate::interpolate ( ndarray::Array< double const, 1 > const & x) const
inherited

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
inherited

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}

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}
int y
Definition SpanSet.cc:48

Member Data Documentation

◆ _style

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

Definition at line 85 of file Interpolate.h.

◆ _x

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

Definition at line 83 of file Interpolate.h.

◆ _y

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

Definition at line 84 of file Interpolate.h.


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