LSSTApplications  18.1.0
LSSTDataManagementBasePackage
Interpolate.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 #if !defined(LSST_AFW_MATH_INTERPOLATE_H)
3 #define LSST_AFW_MATH_INTERPOLATE_H
4 
5 /*
6  * LSST Data Management System
7  * Copyright 2008, 2009, 2010 LSST Corporation.
8  *
9  * This product includes software developed by the
10  * LSST Project (http://www.lsst.org/).
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the LSST License Statement and
23  * the GNU General Public License along with this program. If not,
24  * see <http://www.lsstcorp.org/LegalNotices/>.
25  */
26 #include "lsst/base.h"
27 #include "ndarray_fwd.h"
28 
29 namespace lsst {
30 namespace afw {
31 namespace math {
32 
33 /*
34  * Interpolate values for a set of x,y vector<>s
35  */
36 class Interpolate {
37 public:
38  enum Style {
39  UNKNOWN = -1,
40  CONSTANT = 0,
41  LINEAR = 1,
48  };
49 
51  std::vector<double> const &y,
52  Interpolate::Style const style);
53 
54  Interpolate(Interpolate const &) = delete;
55  Interpolate(Interpolate &&) = delete;
56  Interpolate &operator=(Interpolate const &) = delete;
57  Interpolate &operator=(Interpolate &&) = delete;
58  virtual ~Interpolate() = default;
59  virtual double interpolate(double const x) const = 0;
61  ndarray::Array<double, 1> interpolate(ndarray::Array<double const, 1> const &x) const;
62 
63 protected:
68  std::vector<double> const &y,
69  Interpolate::Style const style = UNKNOWN
70  )
71  : _x(x), _y(y), _style(style) {}
81  Interpolate::Style const style = UNKNOWN);
82 
86 };
87 
97 std::shared_ptr<Interpolate> makeInterpolate(ndarray::Array<double const, 1> const &x,
98  ndarray::Array<double const, 1> const &y,
118 } // namespace math
119 } // namespace afw
120 } // namespace lsst
121 
122 #endif // LSST_AFW_MATH_INTERPOLATE_H
Interpolate::Style stringToInterpStyle(std::string const &style)
Conversion function to switch a string to an Interpolate::Style.
Definition: Interpolate.cc:257
Basic LSST definitions.
Interpolate(Interpolate const &)=delete
virtual double interpolate(double const x) const =0
friend 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.
Definition: Interpolate.cc:343
int y
Definition: SpanSet.cc:49
STL class.
Interpolate & operator=(Interpolate const &)=delete
A base class for image defects.
std::vector< double > const _x
Definition: Interpolate.h:83
virtual ~Interpolate()=default
double x
Interpolate::Style lookupMaxInterpStyle(int const n)
Get the highest order Interpolation::Style available for &#39;n&#39; points.
Definition: Interpolate.cc:275
int lookupMinInterpPoints(Interpolate::Style const style)
Get the minimum number of points needed to use the requested interpolation style. ...
Definition: Interpolate.cc:314
Interpolate(std::vector< double > const &x, std::vector< double > const &y, Interpolate::Style const style=UNKNOWN)
Base class ctor.
Definition: Interpolate.h:67
std::vector< double > const _y
Definition: Interpolate.h:84
Interpolate::Style const _style
Definition: Interpolate.h:85