_skyWcs.cc

Go to the documentation of this file.

/*
 * This file is part of afw.
 *
 * Developed for the LSST Data Management System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#include "pybind11/pybind11.h"
#include <lsst/utils/python.h>
#include "pybind11/eigen.h"
 
#include <memory>
 
#include "astshim.h"
#include "Eigen/Core"
#include "pybind11/stl.h"
#include "ndarray/pybind11.h"
 
#include "lsst/geom.h"
#include "lsst/afw/geom/Transform.h"
#include "lsst/afw/typehandling/Storable.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/table/io/python.h"  // for addPersistableMethods
 
namespace py = pybind11;
using namespace py::literals;
 
namespace lsst {
namespace afw {
namespace geom {
namespace {
 
void declareSkyWcs(lsst::utils::python::WrapperCollection &wrappers) {
    wrappers.wrap([](auto &mod) {
        mod.def("makeCdMatrix", makeCdMatrix, "scale"_a, "orientation"_a = 0 * lsst::geom::degrees,
                "flipX"_a = false);
        mod.def("makeFlippedWcs", makeFlippedWcs, "wcs"_a, "flipLR"_a, "flipTB"_a, "center"_a);
        mod.def("makeModifiedWcs", makeModifiedWcs, "pixelTransform"_a, "wcs"_a, "modifyActualPixels"_a);
        mod.def("makeSkyWcs",
                (std::shared_ptr<SkyWcs>(*)(lsst::geom::Point2D const &, lsst::geom::SpherePoint const &,
                                            Eigen::Matrix2d const &, std::string const &))makeSkyWcs,
                "crpix"_a, "crval"_a, "cdMatrix"_a, "projection"_a = "TAN");
        mod.def("makeSkyWcs", (std::shared_ptr<SkyWcs>(*)(daf::base::PropertySet &, bool))makeSkyWcs,
                "metadata"_a, "strip"_a = false);
        mod.def("makeSkyWcs",
                (std::shared_ptr<SkyWcs>(*)(TransformPoint2ToPoint2 const &, lsst::geom::Angle const &, bool,
                                            lsst::geom::SpherePoint const &, std::string const &))makeSkyWcs,
                "pixelsToFieldAngle"_a, "orientation"_a, "flipX"_a, "boresight"_a, "projection"_a = "TAN");
        mod.def("makeTanSipWcs",
                (std::shared_ptr<SkyWcs>(*)(lsst::geom::Point2D const &, lsst::geom::SpherePoint 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>(*)(lsst::geom::Point2D const &, lsst::geom::SpherePoint 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);
    });
    wrappers.wrapType(
            py::class_<SkyWcs, std::shared_ptr<SkyWcs>, typehandling::Storable>(wrappers.module, "SkyWcs"),
            [](auto &mod, auto &cls) {
                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());
 
                table::io::python::addPersistableMethods<SkyWcs>(cls);
 
                cls.def("copyAtShiftedPixelOrigin", &SkyWcs::copyAtShiftedPixelOrigin, "shift"_a);
                cls.def("getFitsMetadata", &SkyWcs::getFitsMetadata, "precise"_a = false);
                cls.def("getPixelScale",
                        (lsst::geom::Angle(SkyWcs::*)(lsst::geom::Point2D const &) const) &
                                SkyWcs::getPixelScale,
                        "pixel"_a);
                cls.def("getPixelScale", (lsst::geom::Angle(SkyWcs::*)() const) & SkyWcs::getPixelScale);
                cls.def("getPixelOrigin", &SkyWcs::getPixelOrigin);
                cls.def("getSkyOrigin", &SkyWcs::getSkyOrigin);
                cls.def("getCdMatrix",
                        (Eigen::Matrix2d(SkyWcs::*)(lsst::geom::Point2D const &) const) & SkyWcs::getCdMatrix,
                        "pixel"_a);
                cls.def("getCdMatrix", (Eigen::Matrix2d(SkyWcs::*)() const) & SkyWcs::getCdMatrix);
                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",
                        (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::SpherePoint const &,
                                                                lsst::geom::AngleUnit const &) const) &
                                SkyWcs::linearizePixelToSky,
                        "coord"_a, "skyUnit"_a);
                cls.def("linearizePixelToSky",
                        (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::Point2D const &,
                                                                lsst::geom::AngleUnit const &) const) &
                                SkyWcs::linearizePixelToSky,
                        "coord"_a, "skyUnit"_a);
                cls.def("linearizeSkyToPixel",
                        (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::SpherePoint const &,
                                                                lsst::geom::AngleUnit const &) const) &
                                SkyWcs::linearizeSkyToPixel,
                        "coord"_a, "skyUnit"_a);
                cls.def("linearizeSkyToPixel",
                        (lsst::geom::AffineTransform(SkyWcs::*)(lsst::geom::Point2D const &,
                                                                lsst::geom::AngleUnit const &) const) &
                                SkyWcs::linearizeSkyToPixel,
                        "coord"_a, "skyUnit"_a);
                cls.def("pixelToSky",
                        (lsst::geom::SpherePoint(SkyWcs::*)(lsst::geom::Point2D const &) const) &
                                SkyWcs::pixelToSky,
                        "pixel"_a);
                cls.def("pixelToSky",
                        (lsst::geom::SpherePoint(SkyWcs::*)(double, double) const) & SkyWcs::pixelToSky,
                        "x"_a, "y"_a);
                cls.def("pixelToSky",
                        (std::vector<lsst::geom::SpherePoint>(SkyWcs::*)(
                                std::vector<lsst::geom::Point2D> const &) const) &
                                SkyWcs::pixelToSky,
                        "pixel"_a);
                cls.def("skyToPixel",
                        (lsst::geom::Point2D(SkyWcs::*)(lsst::geom::SpherePoint const &) const) &
                                SkyWcs::skyToPixel,
                        "sky"_a);
                cls.def("skyToPixel",
                        (std::vector<lsst::geom::Point2D>(SkyWcs::*)(
                                std::vector<lsst::geom::SpherePoint> const &) const) &
                                SkyWcs::skyToPixel,
                        "sky"_a);
                // Do not wrap getShortClassName because it returns the name of the class;
                // use `<class>.__name__` or `type(<instance>).__name__` instead.
                // Do not wrap readStream or writeStream because C++ streams are not easy to wrap.
                cls.def_static("readString", &SkyWcs::readString);
                cls.def("writeString", &SkyWcs::writeString);
 
                utils::python::addOutputOp(cls, "__str__");
                // For repr, we could instead call writeString for the very long AST Frame/Mapping output.
                utils::python::addOutputOp(cls, "__repr__");
            });
}
}  // namespace
void wrapSkyWcs(lsst::utils::python::WrapperCollection &wrappers) {
    wrappers.addInheritanceDependency("lsst.afw.table.io");
    wrappers.addInheritanceDependency("lsst.afw.typehandling");
    wrappers.addSignatureDependency("astshim");
    declareSkyWcs(wrappers);
}
}  // namespace geom
}  // namespace afw
}  // namespace lsst