LSSTApplications  20.0.0
LSSTDataManagementBasePackage
SipApproximation.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * Developed for the LSST Data Management System.
4  * This product includes software developed by the LSST Project
5  * (https://www.lsst.org).
6  * See the COPYRIGHT file at the top-level directory of this distribution
7  * for details of code ownership.
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program. If not, see <https://www.gnu.org/licenses/>.
21  */
22 
23 #ifndef LSST_AFW_GEOM_SipApproximation_h_INCLUDED
24 #define LSST_AFW_GEOM_SipApproximation_h_INCLUDED
25 
26 #include <memory>
27 #include <vector>
28 
29 #include "Eigen/Core"
30 
32 #include "lsst/geom/Box.h"
34 
35 namespace lsst { namespace afw { namespace geom {
36 
94 class SipApproximation final {
95 public:
96 
129  lsst::geom::Point2D const & crpix,
130  Eigen::Matrix2d const & cd,
131  lsst::geom::Box2D const & bbox,
132  lsst::geom::Extent2I const & gridShape,
133  int order,
134  bool useInverse=true,
135  double svdThreshold=-1
136  );
137 
178  lsst::geom::Point2D const & crpix,
179  Eigen::Matrix2d const & cd,
180  lsst::geom::Box2D const & bbox,
181  lsst::geom::Extent2I const & gridShape,
182  ndarray::Array<double const, 2> const & a,
183  ndarray::Array<double const, 2> const & b,
184  ndarray::Array<double const, 2> const & ap,
185  ndarray::Array<double const, 2> const & bp,
186  bool useInverse=true
187  );
188 
189  // No copies just because they'd be a pain to implement and probably aren't necessary
192 
193  // Moves are fine.
194  SipApproximation(SipApproximation &&) noexcept = default;
195  SipApproximation & operator=(SipApproximation &&) noexcept = default;
196 
197  // Needs to be defined in .cc, where compiler can see the definitions of forward-declared
198  // private implementation classes.
199  ~SipApproximation() noexcept;
200 
202  int getOrder() const noexcept;
203 
211  double getA(int p, int q) const;
212 
220  double getB(int p, int q) const;
221 
229  double getAP(int p, int q) const;
230 
238  double getBP(int p, int q) const;
239 
241  Eigen::MatrixXd getA() const noexcept;
242 
244  Eigen::MatrixXd getB() const noexcept;
245 
247  Eigen::MatrixXd getAP() const noexcept;
248 
250  Eigen::MatrixXd getBP() const noexcept;
251 
259  lsst::geom::Point2D applyForward(lsst::geom::Point2D const & pix) const;
260 
266  std::vector<lsst::geom::Point2D> applyForward(std::vector<lsst::geom::Point2D> const & pix) const;
267 
275  lsst::geom::Point2D applyInverse(lsst::geom::Point2D const & iwcs) const;
276 
282  std::vector<lsst::geom::Point2D> applyInverse(std::vector<lsst::geom::Point2D> const & iwcs) const;
283 
285  lsst::geom::Extent2D getGridStep() const noexcept;
286 
288  lsst::geom::Extent2I getGridShape() const noexcept;
289 
291  lsst::geom::Box2D getBBox() const noexcept { return _bbox; }
292 
294  lsst::geom::Point2D getPixelOrigin() const noexcept { return lsst::geom::Point2D(_crpix); }
295 
297  Eigen::Matrix2d getCdMatrix() const noexcept { return _cdInv.inverted().getMatrix(); }
298 
311  void updateGrid(lsst::geom::Extent2I const & shape);
312 
321  void refineGrid(int factor=2);
322 
338  void fit(int order, double svdThreshold=-1);
339 
353 
354 private:
355 
356  struct Grid;
357  struct Solution;
358 
359  bool _useInverse;
360  std::shared_ptr<TransformPoint2ToPoint2> _pixelToIwc;
361  lsst::geom::Box2D _bbox;
362  lsst::geom::Extent2D _crpix;
363  lsst::geom::LinearTransform _cdInv;
364  std::unique_ptr<Grid const> _grid;
365  std::unique_ptr<Solution const> _solution;
366 };
367 
368 }}} // namespace lsst::afw::geom
369 
370 #endif // !LSST_AFW_GEOM_SipApproximation_h_INCLUDED
lsst::afw::geom::SipApproximation::getA
Eigen::MatrixXd getA() const noexcept
Return the coefficients of the forward transform polynomial.
Definition: SipApproximation.cc:294
lsst::afw::geom::SipApproximation::refineGrid
void refineGrid(int factor=2)
Update the grid by making it finer by a given integer factor.
Definition: SipApproximation.cc:369
lsst::afw::geom::SipApproximation::getGridShape
lsst::geom::Extent2I getGridShape() const noexcept
Return the number of grid points in x and y.
Definition: SipApproximation.cc:361
lsst::afw::geom::SipApproximation::operator=
SipApproximation & operator=(SipApproximation const &)=delete
lsst::afw::geom::SipApproximation
A fitter and results class for approximating a general Transform in a form compatible with FITS WCS p...
Definition: SipApproximation.h:94
Box.h
std::shared_ptr
STL class.
lsst::afw::geom::SipApproximation::applyInverse
lsst::geom::Point2D applyInverse(lsst::geom::Point2D const &iwcs) const
Convert a point from intermediate world coordinates to pixels.
Definition: SipApproximation.cc:340
lsst::afw::geom::SipApproximation::getCdMatrix
Eigen::Matrix2d getCdMatrix() const noexcept
Return the CD matrix of the WCS being approximated.
Definition: SipApproximation.h:297
lsst::afw::geom::Transform
Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint,...
Definition: Transform.h:68
lsst::afw::geom::SipApproximation::applyForward
lsst::geom::Point2D applyForward(lsst::geom::Point2D const &pix) const
Convert a point from pixels to intermediate world coordinates.
Definition: SipApproximation.cc:322
std::pair< double, double >
lsst::afw::geom::SipApproximation::SipApproximation
SipApproximation(std::shared_ptr< TransformPoint2ToPoint2 > pixelToIwc, lsst::geom::Point2D const &crpix, Eigen::Matrix2d const &cd, lsst::geom::Box2D const &bbox, lsst::geom::Extent2I const &gridShape, int order, bool useInverse=true, double svdThreshold=-1)
Construct a new approximation by fitting on a grid of points.
Definition: SipApproximation.cc:210
lsst::afw::geom::SipApproximation::getPixelOrigin
lsst::geom::Point2D getPixelOrigin() const noexcept
Return the pixel origin of the WCS being approximated.
Definition: SipApproximation.h:294
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom::SipApproximation::updateGrid
void updateGrid(lsst::geom::Extent2I const &shape)
Update the grid to the given number of points in x and y.
Definition: SipApproximation.cc:365
lsst::geom::Point2D
Point< double, 2 > Point2D
Definition: Point.h:324
Transform.h
lsst::afw::geom::SipApproximation::fit
void fit(int order, double svdThreshold=-1)
Obtain a new solution at the given order with the current grid.
Definition: SipApproximation.cc:377
lsst::afw::geom::SipApproximation::SipApproximation
SipApproximation(SipApproximation const &)=delete
lsst::afw::geom::SipApproximation::SipApproximation
SipApproximation(SipApproximation &&) noexcept=default
lsst::afw::geom::SipApproximation::getOrder
int getOrder() const noexcept
Return the polynomial order of the current solution (same for forward and reverse).
Definition: SipApproximation.cc:259
lsst::afw::geom::SipApproximation::getAP
Eigen::MatrixXd getAP() const noexcept
Return the coefficients of the reverse transform polynomial.
Definition: SipApproximation.cc:308
crpix
table::PointKey< double > crpix
Definition: OldWcs.cc:131
lsst::afw::geom::SipApproximation::getGridStep
lsst::geom::Extent2D getGridStep() const noexcept
Return the distance between grid points in pixels.
Definition: SipApproximation.cc:356
LinearTransform.h
lsst::geom::LinearTransform::inverted
LinearTransform const inverted() const
Return the inverse transform.
Definition: LinearTransform.cc:45
cd
table::Key< table::Array< double > > cd
Definition: OldWcs.cc:132
lsst::geom::LinearTransform::getMatrix
Matrix const & getMatrix() const noexcept
Definition: LinearTransform.h:151
b
table::Key< int > b
Definition: TransmissionCurve.cc:467
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::SipApproximation::getBP
Eigen::MatrixXd getBP() const noexcept
Return the coefficients of the reverse transform polynomial.
Definition: SipApproximation.cc:315
lsst::geom
Definition: geomOperators.dox:4
a
table::Key< int > a
Definition: TransmissionCurve.cc:466
std
STL namespace.
lsst::geom::Extent2I
Extent< int, 2 > Extent2I
Definition: Extent.h:397
lsst::geom::Point< double, 2 >
lsst::afw::geom::SipApproximation::computeMaxDeviation
std::pair< double, double > computeMaxDeviation() const noexcept
Return the maximum deviation of the solution from the exact transform on the current grid.
Definition: SipApproximation.cc:381
lsst::geom::Extent2D
Extent< double, 2 > Extent2D
Definition: Extent.h:400
lsst::afw::geom::SipApproximation::getB
Eigen::MatrixXd getB() const noexcept
Return the coefficients of the forward transform polynomial.
Definition: SipApproximation.cc:301
lsst::afw::geom::SipApproximation::getBBox
lsst::geom::Box2D getBBox() const noexcept
Return the pixel-coordinate bounding box over which the approximation should be valid.
Definition: SipApproximation.h:291
lsst::geom::Box2D
A floating-point coordinate rectangle geometry.
Definition: Box.h:413
lsst::geom::Extent< int, 2 >
bbox
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117