LSST Applications g070148d5b3+33e5256705,g0d53e28543+25c8b88941,g0da5cf3356+2dd1178308,g1081da9e2a+62d12e78cb,g17e5ecfddb+7e422d6136,g1c76d35bf8+ede3a706f7,g295839609d+225697d880,g2e2c1a68ba+cc1f6f037e,g2ffcdf413f+853cd4dcde,g38293774b4+62d12e78cb,g3b44f30a73+d953f1ac34,g48ccf36440+885b902d19,g4b2f1765b6+7dedbde6d2,g5320a0a9f6+0c5d6105b6,g56b687f8c9+ede3a706f7,g5c4744a4d9+ef6ac23297,g5ffd174ac0+0c5d6105b6,g6075d09f38+66af417445,g667d525e37+2ced63db88,g670421136f+2ced63db88,g71f27ac40c+2ced63db88,g774830318a+463cbe8d1f,g7876bc68e5+1d137996f1,g7985c39107+62d12e78cb,g7fdac2220c+0fd8241c05,g96f01af41f+368e6903a7,g9ca82378b8+2ced63db88,g9d27549199+ef6ac23297,gabe93b2c52+e3573e3735,gb065e2a02a+3dfbe639da,gbc3249ced9+0c5d6105b6,gbec6a3398f+0c5d6105b6,gc9534b9d65+35b9f25267,gd01420fc67+0c5d6105b6,geee7ff78d7+a14128c129,gf63283c776+ede3a706f7,gfed783d017+0c5d6105b6,w.2022.47
LSST Data Management Base Package
Loading...
Searching...
No Matches
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
35namespace lsst { namespace afw { namespace geom {
36
94class SipApproximation final {
95public:
96
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
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
354private:
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
AmpInfoBoxKey bbox
Definition: Amplifier.cc:117
table::PointKey< double > crpix
Definition: OldWcs.cc:129
table::Key< table::Array< double > > cd
Definition: OldWcs.cc:130
table::Key< int > b
table::Key< int > a
A fitter and results class for approximating a general Transform in a form compatible with FITS WCS p...
void fit(int order, double svdThreshold=-1)
Obtain a new solution at the given order with the current grid.
lsst::geom::Extent2I getGridShape() const noexcept
Return the number of grid points in x and y.
Eigen::MatrixXd getBP() const noexcept
Return the coefficients of the reverse transform polynomial.
Eigen::MatrixXd getAP() const noexcept
Return the coefficients of the reverse transform polynomial.
lsst::geom::Box2D getBBox() const noexcept
Return the pixel-coordinate bounding box over which the approximation should be valid.
SipApproximation(SipApproximation const &)=delete
Eigen::MatrixXd getA() const noexcept
Return the coefficients of the forward transform polynomial.
SipApproximation(SipApproximation &&) noexcept=default
int getOrder() const noexcept
Return the polynomial order of the current solution (same for forward and reverse).
lsst::geom::Extent2D getGridStep() const noexcept
Return the distance between grid points in pixels.
void updateGrid(lsst::geom::Extent2I const &shape)
Update the grid to the given number of points in x and y.
Eigen::Matrix2d getCdMatrix() const noexcept
Return the CD matrix of the WCS being approximated.
void refineGrid(int factor=2)
Update the grid by making it finer by a given integer factor.
SipApproximation & operator=(SipApproximation const &)=delete
lsst::geom::Point2D applyInverse(lsst::geom::Point2D const &iwcs) const
Convert a point from intermediate world coordinates to pixels.
Eigen::MatrixXd getB() const noexcept
Return the coefficients of the forward transform polynomial.
std::pair< double, double > computeMaxDeviation() const noexcept
Return the maximum deviation of the solution from the exact transform on the current grid.
lsst::geom::Point2D applyForward(lsst::geom::Point2D const &pix) const
Convert a point from pixels to intermediate world coordinates.
lsst::geom::Point2D getPixelOrigin() const noexcept
Return the pixel origin of the WCS being approximated.
Transform LSST spatial data, such as lsst::geom::Point2D and lsst::geom::SpherePoint,...
Definition: Transform.h:68
A floating-point coordinate rectangle geometry.
Definition: Box.h:413
Matrix const & getMatrix() const noexcept
LinearTransform const inverted() const
Return the inverse transform.
Point< double, 2 > Point2D
Definition: Point.h:324
STL namespace.
table::Key< int > order