readers.cc

Go to the documentation of this file.

/*
 * 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 "ndarray/pybind11.h"

#include "lsst/utils/python/TemplateInvoker.h"
#include "lsst/afw/image/ImageBaseFitsReader.h"
#include "lsst/afw/image/ImageFitsReader.h"
#include "lsst/afw/image/MaskFitsReader.h"
#include "lsst/afw/image/MaskedImageFitsReader.h"
#include "lsst/afw/image/ExposureFitsReader.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/geom/polygon/Polygon.h"
#include "lsst/afw/detection/Psf.h"
#include "lsst/afw/image/PhotoCalib.h"
#include "lsst/afw/image/Filter.h"
#include "lsst/afw/image/CoaddInputs.h"
#include "lsst/afw/image/VisitInfo.h"
#include "lsst/afw/image/ApCorrMap.h"
#include "lsst/afw/image/TransmissionCurve.h"
#include "lsst/afw/cameraGeom/Detector.h"

namespace py = pybind11;
using namespace pybind11::literals;

namespace lsst { namespace afw { namespace image { namespace {

// ImageBaseFitsReader is an implementation detail and is not exposed directly
// to Python, as we have better ways to share wrapper code between classes
// at the pybind11 level (e.g. declareCommon below).
using PyImageFitsReader = py::class_<ImageFitsReader, std::shared_ptr<ImageFitsReader>>;
using PyMaskFitsReader = py::class_<MaskFitsReader, std::shared_ptr<MaskFitsReader>>;
using PyMaskedImageFitsReader = py::class_<MaskedImageFitsReader, std::shared_ptr<MaskedImageFitsReader>>;
using PyExposureFitsReader = py::class_<ExposureFitsReader, std::shared_ptr<ExposureFitsReader>>;

// Declare attributes common to all FitsReaders.  Excludes constructors
// because ExposureFitsReader's don't take an HDU argument.
template <typename Class, typename ...Args>
void declareCommonMethods(py::class_<Class, Args...> & cls) {
    cls.def("readBBox", &Class::readBBox, "origin"_a=PARENT);
    cls.def("readXY0", &Class::readXY0, "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT);
    cls.def("getFileName", &Class::getFileName);
    cls.def_property_readonly("fileName", &Class::getFileName);
}

// Declare attributes common to ImageFitsReader and MaskFitsReader
template <typename Class, typename ...Args>
void declareSinglePlaneMethods(py::class_<Class, Args...> & cls) {
    cls.def(py::init<std::string const &, int>(), "fileName"_a, "hdu"_a=fits::DEFAULT_HDU);
    cls.def(py::init<fits::MemFileManager&, int>(), "manager"_a, "hdu"_a=fits::DEFAULT_HDU);
    cls.def("readMetadata", &Class::readMetadata);
    cls.def("readDType", [](Class & self) { return py::dtype(self.readDType()); });
    cls.def("getHdu", &Class::getHdu);
    cls.def_property_readonly("hdu", &Class::getHdu);
    cls.def(
        "readArray",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readArray<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
}

// Declare attributes shared by MaskedImageFitsReader and MaskedImageFitsReader.
template <typename Class, typename ...Args>
void declareMultiPlaneMethods(py::class_<Class, Args...> & cls) {
    cls.def("readImageDType", [](Class & self) { return py::dtype(self.readImageDType()); } );
    cls.def("readMaskDType", [](Class & self) { return py::dtype(self.readMaskDType()); });
    cls.def("readVarianceDType", [](Class & self) { return py::dtype(self.readVarianceDType()); });
    cls.def(
        "readImage",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readImageDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readImage<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
    cls.def(
        "readImageArray",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readImageDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readImageArray<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
    cls.def(
        "readMask",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool conformMasks,
           bool allowUnsafe, py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readMaskDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readMask<decltype(t)>(bbox, origin, conformMasks, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<MaskPixel>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "conformMasks"_a=false, "allowUnsafe"_a=false,
        "dtype"_a=py::none()
    );
    cls.def(
        "readMaskArray",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readMaskDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readMaskArray<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<MaskPixel>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
    cls.def(
        "readVariance",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readVarianceDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readVariance<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<VariancePixel>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
    cls.def(
        "readVarianceArray",
        [](Class & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readVarianceDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.template readVarianceArray<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<VariancePixel>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
}

void declareImageFitsReader(py::module & mod) {
    PyImageFitsReader cls(mod, "ImageFitsReader");
    declareCommonMethods(cls);
    declareSinglePlaneMethods(cls);
    cls.def(
        "read",
        [](ImageFitsReader & self, lsst::geom::Box2I const & bbox, ImageOrigin origin, bool allowUnsafe,
           py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.read<decltype(t)>(bbox, origin, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
}

void declareMaskFitsReader(py::module & mod) {
    PyMaskFitsReader cls(mod, "MaskFitsReader");
    declareCommonMethods(cls);
    declareSinglePlaneMethods(cls);
    cls.def(
        "read",
        [](MaskFitsReader & self, lsst::geom::Box2I const & bbox, ImageOrigin origin,
           bool conformMasks, bool allowUnsafe, py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.read<decltype(t)>(bbox, origin, conformMasks, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<MaskPixel>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "conformMasks"_a=false, "allowUnsafe"_a=false,
        "dtype"_a=py::none()
    );
    // all other methods provided by base class wrappers
}

void declareMaskedImageFitsReader(py::module & mod) {
    PyMaskedImageFitsReader cls(mod, "MaskedImageFitsReader");
    cls.def(py::init<std::string const &, int>(), "fileName"_a, "hdu"_a=fits::DEFAULT_HDU);
    cls.def(py::init<fits::MemFileManager&, int>(), "manager"_a, "hdu"_a=fits::DEFAULT_HDU);
    declareCommonMethods(cls);
    declareMultiPlaneMethods(cls);
    cls.def("readPrimaryMetadata", &MaskedImageFitsReader::readPrimaryMetadata);
    cls.def("readImageMetadata", &MaskedImageFitsReader::readImageMetadata);
    cls.def("readMaskMetadata", &MaskedImageFitsReader::readMaskMetadata);
    cls.def("readVarianceMetadata", &MaskedImageFitsReader::readVarianceMetadata);
    cls.def(
        "read",
        [](MaskedImageFitsReader & self, lsst::geom::Box2I const & bbox, ImageOrigin origin,
           bool conformMasks, bool needAllHdus, bool allowUnsafe, py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readImageDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.read<decltype(t)>(bbox, origin, conformMasks, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "conformMasks"_a=false, "needAllHdus"_a=false,
        "allowUnsafe"_a=false, "dtype"_a=py::none()
    );
}

void declareExposureFitsReader(py::module & mod) {
    PyExposureFitsReader cls(mod, "ExposureFitsReader");
    cls.def(py::init<std::string const &>(), "fileName"_a);
    cls.def(py::init<fits::MemFileManager&>(), "manager"_a);
    declareCommonMethods(cls);
    declareMultiPlaneMethods(cls);
    cls.def("readMetadata", &ExposureFitsReader::readMetadata);
    cls.def("readWcs", &ExposureFitsReader::readWcs);
    cls.def("readFilter", &ExposureFitsReader::readFilter);
    cls.def("readPhotoCalib", &ExposureFitsReader::readPhotoCalib);
    cls.def("readPsf", &ExposureFitsReader::readPsf);
    cls.def("readValidPolygon", &ExposureFitsReader::readValidPolygon);
    cls.def("readApCorrMap", &ExposureFitsReader::readApCorrMap);
    cls.def("readCoaddInputs", &ExposureFitsReader::readCoaddInputs);
    cls.def("readVisitInfo", &ExposureFitsReader::readVisitInfo);
    cls.def("readTransmissionCurve", &ExposureFitsReader::readTransmissionCurve);
    cls.def("readDetector", &ExposureFitsReader::readDetector);
    cls.def("readExposureInfo", &ExposureFitsReader::readExposureInfo);
    cls.def(
        "readMaskedImage",
        [](ExposureFitsReader & self, lsst::geom::Box2I const & bbox, ImageOrigin origin,
           bool conformMasks, bool allowUnsafe, py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readImageDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.readMaskedImage<decltype(t)>(bbox, origin, conformMasks, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "conformMasks"_a=false, "allowUnsafe"_a=false,
        "dtype"_a=py::none()
    );
    cls.def(
        "read",
        [](ExposureFitsReader & self, lsst::geom::Box2I const & bbox, ImageOrigin origin,
           bool conformMasks, bool allowUnsafe, py::object dtype) {
            if (dtype.is(py::none())) {
                dtype = py::dtype(self.readImageDType());
            }
            return utils::python::TemplateInvoker().apply(
                [&](auto t) {
                    return self.read<decltype(t)>(bbox, origin, conformMasks, allowUnsafe);
                },
                py::dtype(dtype),
                utils::python::TemplateInvoker::Tag<std::uint16_t, int, float, double, std::uint64_t>()
            );
        },
        "bbox"_a=lsst::geom::Box2I(), "origin"_a=PARENT, "conformMasks"_a=false, "allowUnsafe"_a=false,
        "dtype"_a=py::none()
    );
}


PYBIND11_MODULE(readers, mod) {
    py::module::import("lsst.daf.base");
    py::module::import("lsst.geom");
    py::module::import("lsst.afw.image.image");
    py::module::import("lsst.afw.image.maskedImage");
    py::module::import("lsst.afw.image.exposure");
    declareImageFitsReader(mod);
    declareMaskFitsReader(mod);
    declareMaskedImageFitsReader(mod);
    declareExposureFitsReader(mod);
}

}}}}  // namespace lsst::afw::image::<anonymous>