LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
_skyWcs.cc
Go to the documentation of this file.
1/*
2 * This file is part of afw.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#include "pybind11/pybind11.h"
25#include <lsst/utils/python.h>
26#include "pybind11/eigen.h"
27
28#include <memory>
29
30#include "astshim.h"
31#include "Eigen/Core"
32#include "pybind11/stl.h"
33#include "ndarray/pybind11.h"
34
35#include "lsst/geom.h"
39#include "lsst/afw/table/io/python.h" // for addPersistableMethods
40
41namespace py = pybind11;
42using namespace py::literals;
43
44namespace lsst {
45namespace afw {
46namespace geom {
47namespace {
48
49void declareSkyWcs(lsst::utils::python::WrapperCollection &wrappers) {
50 wrappers.wrap([](auto &mod) {
51 mod.def("makeCdMatrix", makeCdMatrix, "scale"_a, "orientation"_a = 0 * lsst::geom::degrees,
52 "flipX"_a = false);
53 mod.def("makeFlippedWcs", makeFlippedWcs, "wcs"_a, "flipLR"_a, "flipTB"_a, "center"_a);
54 mod.def("makeModifiedWcs", makeModifiedWcs, "pixelTransform"_a, "wcs"_a, "modifyActualPixels"_a);
55 mod.def("makeSkyWcs",
57 Eigen::Matrix2d const &, std::string const &))makeSkyWcs,
58 "crpix"_a, "crval"_a, "cdMatrix"_a, "projection"_a = "TAN");
59 mod.def("makeSkyWcs", (std::shared_ptr<SkyWcs>(*)(daf::base::PropertySet &, bool))makeSkyWcs,
60 "metadata"_a, "strip"_a = false);
61 mod.def("makeSkyWcs",
62 (std::shared_ptr<SkyWcs>(*)(TransformPoint2ToPoint2 const &, lsst::geom::Angle const &, bool,
63 lsst::geom::SpherePoint const &, std::string const &))makeSkyWcs,
64 "pixelsToFieldAngle"_a, "orientation"_a, "flipX"_a, "boresight"_a, "projection"_a = "TAN");
65 mod.def("makeTanSipWcs",
67 Eigen::Matrix2d const &, Eigen::MatrixXd const &,
68 Eigen::MatrixXd const &))makeTanSipWcs,
69 "crpix"_a, "crval"_a, "cdMatrix"_a, "sipA"_a, "sipB"_a);
70 mod.def("makeTanSipWcs",
72 Eigen::Matrix2d const &, Eigen::MatrixXd const &,
73 Eigen::MatrixXd const &, Eigen::MatrixXd const &,
74 Eigen::MatrixXd const &))makeTanSipWcs,
75 "crpix"_a, "crval"_a, "cdMatrix"_a, "sipA"_a, "sipB"_a, "sipAp"_a, "sipBp"_a);
76 mod.def("makeWcsPairTransform", makeWcsPairTransform, "src"_a, "dst"_a);
77 mod.def("getIntermediateWorldCoordsToSky", getIntermediateWorldCoordsToSky, "wcs"_a,
78 "simplify"_a = true);
79 mod.def("getPixelToIntermediateWorldCoords", getPixelToIntermediateWorldCoords, "wcs"_a,
80 "simplify"_a = true);
81 });
82 wrappers.wrapType(
83 py::class_<SkyWcs, std::shared_ptr<SkyWcs>, typehandling::Storable>(wrappers.module, "SkyWcs"),
84 [](auto &mod, auto &cls) {
85 cls.def(py::init<daf::base::PropertySet &, bool>(), "metadata"_a, "strip"_a = false);
86 cls.def(py::init<ast::FrameDict const &>(), "frameDict"_a);
87
88 cls.def("__eq__", &SkyWcs::operator==, py::is_operator());
89 cls.def("__ne__", &SkyWcs::operator!=, py::is_operator());
90
91 table::io::python::addPersistableMethods<SkyWcs>(cls);
92
93 cls.def("copyAtShiftedPixelOrigin", &SkyWcs::copyAtShiftedPixelOrigin, "shift"_a);
94 cls.def("getFitsMetadata", &SkyWcs::getFitsMetadata, "precise"_a = false);
95 cls.def("getPixelScale",
96 (lsst::geom::Angle(SkyWcs::*)(lsst::geom::Point2D const &) const) &
97 SkyWcs::getPixelScale,
98 "pixel"_a);
99 cls.def("getPixelScale", (lsst::geom::Angle(SkyWcs::*)() const) & SkyWcs::getPixelScale);
100 cls.def("getPixelOrigin", &SkyWcs::getPixelOrigin);
101 cls.def("getSkyOrigin", &SkyWcs::getSkyOrigin);
102 cls.def("getCdMatrix",
103 (Eigen::Matrix2d(SkyWcs::*)(lsst::geom::Point2D const &) const) & SkyWcs::getCdMatrix,
104 "pixel"_a);
105 cls.def("getCdMatrix", (Eigen::Matrix2d(SkyWcs::*)() const) & SkyWcs::getCdMatrix);
106 cls.def("getTanWcs", &SkyWcs::getTanWcs, "pixel"_a);
107 cls.def("getFrameDict", [](SkyWcs const &self) { return self.getFrameDict()->copy(); });
108 cls.def("getTransform", &SkyWcs::getTransform);
109
110 cls.def_property_readonly("isFits", &SkyWcs::isFits);
111 cls.def_property_readonly("isFlipped", &SkyWcs::isFlipped);
112 cls.def("linearizePixelToSky",
113 (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::SpherePoint const &,
114 lsst::geom::AngleUnit const &) const) &
115 SkyWcs::linearizePixelToSky,
116 "coord"_a, "skyUnit"_a);
117 cls.def("linearizePixelToSky",
118 (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::Point2D const &,
119 lsst::geom::AngleUnit const &) const) &
120 SkyWcs::linearizePixelToSky,
121 "coord"_a, "skyUnit"_a);
122 cls.def("linearizeSkyToPixel",
123 (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::SpherePoint const &,
124 lsst::geom::AngleUnit const &) const) &
125 SkyWcs::linearizeSkyToPixel,
126 "coord"_a, "skyUnit"_a);
127 cls.def("linearizeSkyToPixel",
128 (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::Point2D const &,
129 lsst::geom::AngleUnit const &) const) &
130 SkyWcs::linearizeSkyToPixel,
131 "coord"_a, "skyUnit"_a);
132 cls.def("pixelToSky",
133 (lsst::geom::SpherePoint(SkyWcs::*)(lsst::geom::Point2D const &) const) &
134 SkyWcs::pixelToSky,
135 "pixel"_a);
136 cls.def("pixelToSky",
137 (lsst::geom::SpherePoint(SkyWcs::*)(double, double) const) & SkyWcs::pixelToSky,
138 "x"_a, "y"_a);
139 cls.def("pixelToSky",
141 std::vector<lsst::geom::Point2D> const &) const) &
142 SkyWcs::pixelToSky,
143 "pixel"_a);
144 cls.def("skyToPixel",
145 (lsst::geom::Point2D(SkyWcs::*)(lsst::geom::SpherePoint const &) const) &
146 SkyWcs::skyToPixel,
147 "sky"_a);
148 cls.def("skyToPixel",
150 std::vector<lsst::geom::SpherePoint> const &) const) &
151 SkyWcs::skyToPixel,
152 "sky"_a);
153 // Do not wrap getShortClassName because it returns the name of the class;
154 // use `<class>.__name__` or `type(<instance>).__name__` instead.
155 // Do not wrap readStream or writeStream because C++ streams are not easy to wrap.
156 cls.def_static("readString", &SkyWcs::readString);
157 cls.def("writeString", &SkyWcs::writeString);
158
159 utils::python::addOutputOp(cls, "__str__");
160 // For repr, we could instead call writeString for the very long AST Frame/Mapping output.
161 utils::python::addOutputOp(cls, "__repr__");
162 });
163}
164} // namespace
165void wrapSkyWcs(lsst::utils::python::WrapperCollection &wrappers) {
166 wrappers.addInheritanceDependency("lsst.afw.table.io");
167 wrappers.addInheritanceDependency("lsst.afw.typehandling");
168 wrappers.addSignatureDependency("astshim");
169 declareSkyWcs(wrappers);
170}
171} // namespace geom
172} // namespace afw
173} // namespace lsst
std::string writeString() const
Serialize this SkyWcs to a string, using the same format as writeStream.
Definition SkyWcs.cc:342
static std::shared_ptr< SkyWcs > readString(std::string &str)
Deserialize a SkyWcs from a string, using the same format as readStream.
Definition SkyWcs.cc:332
std::shared_ptr< const TransformPoint2ToSpherePoint > getTransform() const
Get a TransformPoint2ToSpherePoint that transforms pixels to sky in the forward direction and sky to ...
Definition SkyWcs.h:257
bool isFlipped() const
Does the WCS follow the convention of North=Up, East=Left?
Definition SkyWcs.cc:296
bool isFits() const
Return true getFitsMetadata(true) will succeed, false if not.
Definition SkyWcs.cc:264
An affine coordinate transformation consisting of a linear transformation and an offset.
A class representing an angle.
Definition Angle.h:128
Point in an unspecified spherical coordinate system.
Definition SpherePoint.h:57
void wrapSkyWcs(lsst::utils::python::WrapperCollection &)
Definition _skyWcs.cc:165
AngleUnit constexpr degrees
constant with units of degrees
Definition Angle.h:110
Point< double, 2 > Point2D
Definition Point.h:324
STL namespace.