Overhaul SkyWcs

Instead of inheriting from Transform, make it contain a FrameDict. Add FITS binary table persistence. Add missing methods and free functions that replace old Wcs methods. Member functions and free functions that returned a SkyWcs now return a shared_ptr<SkyWcs>.
lsst · Nov 30, 2017 · 66afc75 · 66afc75
1 parent 6677b7e
commit 66afc75
Show file tree

Hide file tree

Showing 9 changed files with 1,332 additions and 276 deletions.
diff --git a/include/lsst/afw/geom/SkyWcs.h b/include/lsst/afw/geom/SkyWcs.h
diff --git a/include/lsst/afw/geom/Transform.h b/include/lsst/afw/geom/Transform.h
@@ -37,6 +37,8 @@ namespace lsst {
 namespace afw {
 namespace geom {
 
+class SkyWcs;
+
 /**
  * Transform LSST spatial data, such as Point2D and IcrsCoord, using an AST transform.
  *
@@ -62,6 +64,8 @@ namespace geom {
  */
 template <class FromEndpoint, class ToEndpoint>
 class Transform {
+    friend class SkyWcs;
+
 public:
     using FromArray = typename FromEndpoint::Array;
     using FromPoint = typename FromEndpoint::Point;

diff --git a/python/lsst/afw/geom/python/transform.py b/python/lsst/afw/geom/python/transform.py
@@ -37,7 +37,7 @@
 
 from __future__ import absolute_import, division, print_function
 
-__all__ = ["addTransformMethods", "transformRegistry"]
+__all__ = ["addTransformMethods", "reduceTransform", "transformRegistry"]
 
 import lsst.pex.exceptions
 

diff --git a/python/lsst/afw/geom/skyWcs/skyWcs.cc b/python/lsst/afw/geom/skyWcs/skyWcs.cc
@@ -35,6 +35,8 @@
 #include "lsst/afw/geom/Point.h"
 #include "lsst/afw/geom/Transform.h"
 #include "lsst/afw/geom/SkyWcs.h"
+#include "lsst/afw/table/io/Persistable.h"
+#include "lsst/afw/table/io/python.h"  // for declarePersistableFacade
 
 namespace py = pybind11;
 using namespace py::literals;
@@ -48,6 +50,8 @@ PYBIND11_PLUGIN(skyWcs) {
     py::module mod("skyWcs");
 
     py::module::import("lsst.afw.geom.transform");
+    py::module::import("lsst.afw.geom.transform");
+    py::module::import("lsst.afw.table.io");
 
     // Need to import numpy for ndarray and eigen conversions
     if (_import_array() < 0) {
@@ -56,34 +60,75 @@ PYBIND11_PLUGIN(skyWcs) {
     }
 
     mod.def("makeCdMatrix", makeCdMatrix, "scale"_a, "orientation"_a = 0 * degrees, "flipX"_a = false);
+    mod.def("makeFlippedWcs", makeFlippedWcs, "wcs"_a, "flipLR"_a, "flipTB"_a, "center"_a);
+    mod.def("makeModifiedWcs", makeModifiedWcs, "pixelTransform"_a, "wcs"_a);
+    mod.def("makeTanSipWcs",
+            (std::shared_ptr<SkyWcs>(*)(Point2D const &, coord::IcrsCoord const &, Eigen::Matrix2d const &,
+                                        Eigen::MatrixXd const &, Eigen::MatrixXd const &))makeTanSipWcs,
+            "crpix"_a, "crval"_a, "cdMatrix"_a, "sipA"_a, "sipB"_a);
+    mod.def("makeTanSipWcs",
+            (std::shared_ptr<SkyWcs>(*)(Point2D const &, coord::IcrsCoord const &, Eigen::Matrix2d const &,
+                                        Eigen::MatrixXd const &, Eigen::MatrixXd const &,
+                                        Eigen::MatrixXd const &, Eigen::MatrixXd const &))makeTanSipWcs,
+            "crpix"_a, "crval"_a, "cdMatrix"_a, "sipA"_a, "sipB"_a, "sipAp"_a, "sipBp"_a);
     mod.def("makeWcsPairTransform", makeWcsPairTransform, "src"_a, "dst"_a);
+    mod.def("getIntermediateWorldCoordsToSky", getIntermediateWorldCoordsToSky, "wcs"_a, "simplify"_a = true);
+    mod.def("getPixelToIntermediateWorldCoords", getPixelToIntermediateWorldCoords, "wcs"_a,
+            "simplify"_a = true);
+
+    table::io::python::declarePersistableFacade<SkyWcs>(mod, "SkyWcs");
 
-    py::class_<SkyWcs, std::shared_ptr<SkyWcs>, TransformPoint2ToIcrsCoord> cls(mod, "SkyWcs");
+    py::class_<SkyWcs, std::shared_ptr<SkyWcs>, table::io::PersistableFacade<SkyWcs>, table::io::Persistable>
+            cls(mod, "SkyWcs");
 
-    cls.def(py::init<Point2D const &, coord::IcrsCoord const &, Eigen::Matrix2d const &>(), "crpix"_a,
-            "crval"_a, "cdMatrix"_a);
-    cls.def(py::init<daf::base::PropertyList &>(), "metadata"_a);
-    cls.def(py::init<ast::FrameSet const &>(), "frameSet"_a);
+    cls.def(py::init<Point2D const &, coord::IcrsCoord const &, Eigen::Matrix2d const &,
+                     std::string const &>(),
+            "crpix"_a, "crval"_a, "cdMatrix"_a, "projection"_a = "TAN");
+    cls.def(py::init<daf::base::PropertySet &, bool>(), "metadata"_a, "strip"_a = false);
+    cls.def(py::init<ast::FrameDict const &>(), "frameDict"_a);
 
+    cls.def("__eq__", &SkyWcs::operator==, py::is_operator());
+    cls.def("__ne__", &SkyWcs::operator!=, py::is_operator());
+
+    cls.def("copyAtShiftedPixelOrigin", &SkyWcs::copyAtShiftedPixelOrigin, "shift"_a);
+    cls.def("getFitsMetadata", &SkyWcs::getFitsMetadata, "precise"_a);
     cls.def("getPixelScale", (Angle(SkyWcs::*)(Point2D const &) const) & SkyWcs::getPixelScale, "pixel"_a);
     cls.def("getPixelScale", (Angle(SkyWcs::*)() const) & SkyWcs::getPixelScale);
     cls.def("getPixelOrigin", &SkyWcs::getPixelOrigin);
     cls.def("getSkyOrigin", &SkyWcs::getSkyOrigin);
     cls.def("getCdMatrix", (Eigen::Matrix2d(SkyWcs::*)(Point2D const &) const) & SkyWcs::getCdMatrix,
             "pixel"_a);
     cls.def("getCdMatrix", (Eigen::Matrix2d(SkyWcs::*)() const) & SkyWcs::getCdMatrix);
-    cls.def("copyAtShiftedPixelOrigin", &SkyWcs::copyAtShiftedPixelOrigin, "shift"_a);
-    cls.def("pixelToSky", (std::pair<Angle, Angle>(SkyWcs::*)(double, double) const) & SkyWcs::pixelToSky,
-            "x"_a, "y"_a);
+    cls.def("getTanWcs", &SkyWcs::getTanWcs, "pixel"_a);
+    cls.def("getFrameDict", [](SkyWcs const &self) { return self.getFrameDict()->copy(); });
+    cls.def("getTransform", &SkyWcs::getTransform);
+
+    cls.def_property_readonly("isFits", &SkyWcs::isFits);
+    cls.def_property_readonly("isFlipped", &SkyWcs::isFlipped);
+    cls.def("linearizePixelToSky",
+            (AffineTransform(SkyWcs::*)(coord::IcrsCoord const &, AngleUnit const &) const) &
+                    SkyWcs::linearizePixelToSky,
+            "coord"_a, "skyUnit"_a);
+    cls.def("linearizePixelToSky",
+            (AffineTransform(SkyWcs::*)(Point2D const &, AngleUnit const &) const) &
+                    SkyWcs::linearizePixelToSky,
+            "coord"_a, "skyUnit"_a);
+    cls.def("linearizeSkyToPixel",
+            (AffineTransform(SkyWcs::*)(coord::IcrsCoord const &, AngleUnit const &) const) &
+                    SkyWcs::linearizeSkyToPixel,
+            "coord"_a, "skyUnit"_a);
+    cls.def("linearizeSkyToPixel",
+            (AffineTransform(SkyWcs::*)(Point2D const &, AngleUnit const &) const) &
+                    SkyWcs::linearizeSkyToPixel,
+            "coord"_a, "skyUnit"_a);
     cls.def("pixelToSky", (coord::IcrsCoord(SkyWcs::*)(Point2D const &) const) & SkyWcs::pixelToSky,
             "pixel"_a);
+    cls.def("pixelToSky", (coord::IcrsCoord(SkyWcs::*)(double, double) const) & SkyWcs::pixelToSky, "x"_a,
+            "y"_a);
     cls.def("pixelToSky",
             (std::vector<coord::IcrsCoord>(SkyWcs::*)(std::vector<Point2D> const &) const) &
                     SkyWcs::pixelToSky,
             "pixel"_a);
-    cls.def("skyToPixel",
-            (std::pair<double, double>(SkyWcs::*)(Angle const &, Angle const &) const) & SkyWcs::skyToPixel,
-            "ra"_a, "dec"_a);
     cls.def("skyToPixel", (Point2D(SkyWcs::*)(coord::IcrsCoord const &) const) & SkyWcs::skyToPixel, "sky"_a);
     cls.def("skyToPixel",
             (std::vector<Point2D>(SkyWcs::*)(std::vector<coord::IcrsCoord> const &) const) &

diff --git a/python/lsst/afw/geom/skyWcs/skyWcsContinued.py b/python/lsst/afw/geom/skyWcs/skyWcsContinued.py
@@ -23,7 +23,7 @@
 
 __all__ = []
 
-from ..python import addTransformMethods
+from ..python import reduceTransform
 from .skyWcs import SkyWcs
 
-addTransformMethods(SkyWcs)
+SkyWcs.__reduce__ = reduceTransform
diff --git a/python/lsst/afw/geom/testUtils.py b/python/lsst/afw/geom/testUtils.py
@@ -285,7 +285,7 @@ def __init__(self, frameSet, permuteBase, permuteCurr):
 
 
 class TransformTestBaseClass(lsst.utils.tests.TestCase):
-    """Base class for unit tests of Transform<X>To<Y> and subclasses
+    """Base class for unit tests of Transform<X>To<Y>
 
     Subclasses must call `TransformTestBaseClass.setUp(self)`
     if they provide their own version.