camera.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 "pybind11/stl.h"

#include "lsst/utils/python.h"
#include "lsst/afw/table/io/python.h"
#include "lsst/afw/cameraGeom/Camera.h"

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

namespace lsst {
namespace afw {
namespace cameraGeom {

using PyCamera = py::class_<Camera, DetectorCollection, std::shared_ptr<Camera>>;
using PyCameraBuilder = py::class_<Camera::Builder, DetectorCollectionBase<Detector::InCameraBuilder>,
                                   std::shared_ptr<Camera::Builder>>;

// Bindings here are ordered to match the order of the declarations in
// Camera.h to the greatest extent possible; modifications to this file should
// attempt to preserve this.

void declareCameraBuilder(PyCamera & parent);

void declareCamera(py::module & mod) {
    PyCamera cls(mod, "Camera");
    declareCameraBuilder(cls);
    cls.def("rebuild", &Camera::rebuild);
    cls.def("getName", &Camera::getName);
    cls.def("getPupilFactoryName", &Camera::getPupilFactoryName);
    cls.def("findDetectors", &Camera::findDetectors, "point"_a, "cameraSys"_a);
    cls.def("findDetectorsList", &Camera::findDetectorsList, "pointList"_a, "cameraSys"_a);
    // transform methods are wrapped with lambdas that translate exceptions for backwards compatibility
    cls.def(
        "getTransform",
        [](Camera const & self, CameraSys const & fromSys, CameraSys const & toSys) {
            try {
                return self.getTransform(fromSys, toSys);
            } catch (pex::exceptions::NotFoundError & err) {
                PyErr_SetString(PyExc_KeyError, err.what());
                throw py::error_already_set();
            }
        },
        "fromSys"_a, "toSys"_a
    );
    cls.def("getTransformMap", &Camera::getTransformMap);
    cls.def(
        "transform",
        [](
            Camera const & self,
            lsst::geom::Point2D const & point,
            CameraSys const & fromSys,
            CameraSys const & toSys
        ) {
            try {
                return self.transform(point, fromSys, toSys);
            } catch (pex::exceptions::NotFoundError & err) {
                PyErr_SetString(PyExc_KeyError, err.what());
                throw py::error_already_set();
            }
        },
        "point"_a, "fromSys"_a, "toSys"_a
    );
    cls.def(
        "transform",
        [](
            Camera const & self,
            std::vector<lsst::geom::Point2D> const & points,
            CameraSys const & fromSys,
            CameraSys const & toSys
        ) {
            try {
                return self.transform(points, fromSys, toSys);
            } catch (pex::exceptions::NotFoundError & err) {
                PyErr_SetString(PyExc_KeyError, err.what());
                throw py::error_already_set();
            }
        },
        "points"_a, "fromSys"_a, "toSys"_a
    );
    table::io::python::addPersistableMethods(cls);
}

void declareCameraBuilder(PyCamera & parent) {
    PyCameraBuilder cls(parent, "Builder");
    cls.def(py::init<std::string const &>(), "name"_a);
    cls.def(py::init<Camera const &>(), "camera"_a);
    cls.def("finish", &Camera::Builder::finish);
    cls.def("getName", &Camera::Builder::getName);
    cls.def("setName", &Camera::Builder::setName);
    cls.def("getPupilFactoryName", &Camera::Builder::getPupilFactoryName);
    cls.def("setPupilFactoryName", &Camera::Builder::setPupilFactoryName);
    cls.def("setPupilFactoryClass",
            [](Camera::Builder & self, py::object pupilFactoryClass) {
                std::string pupilFactoryName = "lsst.afw.cameraGeom.pupil.PupilFactory";
                if (!pupilFactoryClass.is(py::none())) {
                    pupilFactoryName = py::str("{}.{}").format(
                        pupilFactoryClass.attr("__module__"),
                        pupilFactoryClass.attr("__name__")
                    );
                }
                self.setPupilFactoryName(pupilFactoryName);
            });
    cls.def("setTransformFromFocalPlaneTo", &Camera::Builder::setTransformFromFocalPlaneTo,
            "toSys"_a, "transform"_a);
    cls.def("discardTransformFromFocalPlaneTo",&Camera::Builder::discardTransformFromFocalPlaneTo);
    cls.def("add", &Camera::Builder::add);
    cls.def("__delitem__", py::overload_cast<int>(&Camera::Builder::remove));
    cls.def("__delitem__", py::overload_cast<std::string const &>(&Camera::Builder::remove));
}

PYBIND11_MODULE(camera, mod){
    py::module::import("lsst.afw.cameraGeom.detectorCollection");
    py::module::import("lsst.afw.cameraGeom.detector");
    py::module::import("lsst.afw.cameraGeom.transformMap");

    declareCamera(mod);
}

} // cameraGeom
} // afw
} // lsst