LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Approximate.h
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 #if !defined(LSST_AFW_MATH_APPROXIMATE_H)
3 #define LSST_AFW_MATH_APPROXIMATE_H
4 
5 /*
6  * LSST Data Management System
7  * Copyright 2008-2015 AURA/LSST.
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 <https://www.lsstcorp.org/LegalNotices/>.
25  */
26 #include "lsst/base.h"
27 #include "lsst/geom.h"
28 
29 namespace lsst {
30 namespace afw {
31 namespace image {
32 template <typename PixelT>
33 class Image;
34 template <typename PixelT, typename U, typename V>
35 class MaskedImage;
36 } // namespace image
37 namespace math {
38 template <typename T>
39 class Approximate;
40 
49 public:
51  enum Style {
52  UNKNOWN = -1,
55  };
56 
64  ApproximateControl(Style style, int orderX, int orderY = -1, bool weighting = true);
66  Style getStyle() const { return _style; }
68  void setStyle(Style const style) { _style = style; }
70  int getOrderX() const { return _orderX; }
72  void setOrderX(int const orderX) { _orderX = orderX; }
74  int getOrderY() const { return _orderY; }
76  void setOrderY(int const orderY) { _orderY = orderY; }
78  bool getWeighting() const { return _weighting; }
80  void setWeighting(bool const weighting) { _weighting = weighting; }
81 
82 private:
83  Style _style;
84  int _orderX;
85  int _orderY;
86  bool _weighting;
87 };
88 
98 template <typename PixelT>
100  std::vector<double> const& y,
101  image::MaskedImage<PixelT> const& im,
102  lsst::geom::Box2I const& bbox,
103  ApproximateControl const& ctrl);
104 
108 template <typename PixelT>
109 class Approximate {
110 public:
111  using OutPixelT = float;
112 
113  friend std::shared_ptr<Approximate<PixelT>> makeApproximate<>(std::vector<double> const& x,
114  std::vector<double> const& y,
115  image::MaskedImage<PixelT> const& im,
116  lsst::geom::Box2I const& bbox,
117  ApproximateControl const& ctrl);
118  Approximate(Approximate const&) = delete;
120  Approximate& operator=(Approximate const&) = delete;
122 
124  virtual ~Approximate() = default;
126  std::shared_ptr<image::Image<OutPixelT>> getImage(int orderX = -1, int orderY = -1) const {
127  return doGetImage(orderX, orderY);
128  }
131  return doGetMaskedImage(orderX, orderY);
132  }
133 
134 protected:
139  std::vector<double> const& y,
140  lsst::geom::Box2I const& bbox,
141  ApproximateControl const& ctrl
142  )
143  : _xVec(x), _yVec(y), _bbox(bbox), _ctrl(ctrl) {}
144 
149 private:
150  virtual std::shared_ptr<image::Image<OutPixelT>> doGetImage(int orderX, int orderY) const = 0;
152 };
153 } // namespace math
154 } // namespace afw
155 } // namespace lsst
156 
157 #endif // LSST_AFW_MATH_APPROXIMATE_H
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
table::Key< int > orderX
double x
int y
Definition: SpanSet.cc:48
Basic LSST definitions.
A class to manipulate images, masks, and variance as a single object.
Definition: MaskedImage.h:73
Control how to make an approximation.
Definition: Approximate.h:48
void setWeighting(bool const weighting)
Set whether inverse variance weighting will be used in calculation.
Definition: Approximate.h:80
int getOrderX() const
Return the order of approximation to use in the x-direction.
Definition: Approximate.h:70
void setStyle(Style const style)
Set the Style.
Definition: Approximate.h:68
ApproximateControl(Style style, int orderX, int orderY=-1, bool weighting=true)
ctor
Definition: Approximate.cc:46
bool getWeighting() const
Return whether inverse variance weighting will be used in calculation.
Definition: Approximate.h:78
void setOrderX(int const orderX)
Set the order of approximation to use in the x-direction.
Definition: Approximate.h:72
void setOrderY(int const orderY)
Set the order of approximation to use in the y-direction.
Definition: Approximate.h:76
Style getStyle() const
Return the Style.
Definition: Approximate.h:66
Style
Choose the type of approximation to use.
Definition: Approximate.h:51
@ CHEBYSHEV
Use a 2-D Chebyshev polynomial.
Definition: Approximate.h:53
int getOrderY() const
Return the order of approximation to use in the y-direction.
Definition: Approximate.h:74
Approximate values for a MaskedImage.
Definition: Approximate.h:109
ApproximateControl const _ctrl
desired approximation algorithm
Definition: Approximate.h:148
float OutPixelT
The pixel type of returned images.
Definition: Approximate.h:111
std::shared_ptr< image::MaskedImage< OutPixelT > > getMaskedImage(int orderX=-1, int orderY=-1) const
Return the approximate image as a MaskedImage.
Definition: Approximate.h:130
Approximate & operator=(Approximate const &)=delete
virtual ~Approximate()=default
dtor
virtual std::shared_ptr< image::Image< OutPixelT > > doGetImage(int orderX, int orderY) const =0
Approximate(Approximate &&)=delete
lsst::geom::Box2I const _bbox
Domain for approximation.
Definition: Approximate.h:147
Approximate(Approximate const &)=delete
std::vector< double > const _xVec
the x-values of points
Definition: Approximate.h:145
std::shared_ptr< image::Image< OutPixelT > > getImage(int orderX=-1, int orderY=-1) const
Return the approximate image as a Image.
Definition: Approximate.h:126
Approximate & operator=(Approximate &&)=delete
virtual std::shared_ptr< image::MaskedImage< OutPixelT > > doGetMaskedImage(int orderX, int orderY) const =0
Approximate(std::vector< double > const &x, std::vector< double > const &y, lsst::geom::Box2I const &bbox, ApproximateControl const &ctrl)
Base class ctor.
Definition: Approximate.h:138
std::vector< double > const _yVec
the y-values of points
Definition: Approximate.h:146
An integer coordinate rectangle.
Definition: Box.h:55
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects.
std::shared_ptr< Approximate< PixelT > > makeApproximate(std::vector< double > const &x, std::vector< double > const &y, image::MaskedImage< PixelT > const &im, lsst::geom::Box2I const &bbox, ApproximateControl const &ctrl)
Construct a new Approximate object, inferring the type from the type of the given MaskedImage.
Definition: Approximate.cc:279
A base class for image defects.