LSST Applications g04e9c324dd+8c5ae1fdc5,g134cb467dc+1b3060144d,g18429d2f64+f642bf4753,g199a45376c+0ba108daf9,g1fd858c14a+2dcf163641,g262e1987ae+7b8c96d2ca,g29ae962dfc+3bd6ecb08a,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+53e1a9e7c5,g4595892280+fef73a337f,g47891489e3+2efcf17695,g4d44eb3520+642b70b07e,g53246c7159+8c5ae1fdc5,g67b6fd64d1+2efcf17695,g67fd3c3899+b70e05ef52,g74acd417e5+317eb4c7d4,g786e29fd12+668abc6043,g87389fa792+8856018cbb,g89139ef638+2efcf17695,g8d7436a09f+3be3c13596,g8ea07a8fe4+9f5ccc88ac,g90f42f885a+a4e7b16d9b,g97be763408+ad77d7208f,g9dd6db0277+b70e05ef52,ga681d05dcb+a3f46e7fff,gabf8522325+735880ea63,gac2eed3f23+2efcf17695,gb89ab40317+2efcf17695,gbf99507273+8c5ae1fdc5,gd8ff7fe66e+b70e05ef52,gdab6d2f7ff+317eb4c7d4,gdc713202bf+b70e05ef52,gdfd2d52018+b10e285e0f,ge365c994fd+310e8507c4,ge410e46f29+2efcf17695,geaed405ab2+562b3308c0,gffca2db377+8c5ae1fdc5,w.2025.35
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
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
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
lsst::geom::Extent2I getGridShape() const noexcept
Return the number of grid points in x and y.
lsst::geom::Box2D getBBox() const noexcept
Return the pixel-coordinate bounding box over which the approximation should be valid.
SipApproximation(SipApproximation const &)=delete
double getAP(int p, int q) const
Return a coefficient of the reverse transform polynomial.
SipApproximation(SipApproximation &&) noexcept=default
double getB(int p, int q) const
Return a coefficient of the forward transform polynomial.
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.
double getA(int p, int q) const
Return a coefficient of the forward transform polynomial.
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.
double getBP(int p, int q) const
Return a coefficient of the reverse 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.
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.
A floating-point coordinate rectangle geometry.
Definition Box.h:413
Definition __init__.py:1
Transform< Point2Endpoint, Point2Endpoint > TransformPoint2ToPoint2
Definition Transform.h:300
Point< double, 2 > Point2D
Definition Point.h:324
Extent< int, 2 > Extent2I
Definition Extent.h:397
STL namespace.