python.h

Go to the documentation of this file.

// -*- lsst-c++ -*-
/*
 * LSST Data Management System
 * See COPYRIGHT file at the top of the source tree.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_MEAS_BASE_PYTHON_H
#define LSST_MEAS_BASE_PYTHON_H

#include "pybind11/pybind11.h"

#include <string>

#include "ndarray.h"
#include "lsst/afw/geom/SkyWcs.h"
#include "lsst/afw/image/PhotoCalib.h"
#include "lsst/afw/table/fwd.h"
#include "lsst/afw/table/Schema.h"
#include "lsst/afw/table/SchemaMapper.h"

namespace lsst {
namespace meas {
namespace base {
namespace python {

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

template <class Algorithm, class PyAlg>
typename std::enable_if<!std::is_abstract<Algorithm>::value, void>::type declareAlgorithmConstructor(
        PyAlg &cls) {
    cls.def(py::init<typename Algorithm::Control const &, std::string const &, afw::table::Schema &>(),
            "ctrl"_a, "name"_a, "schema"_a);
}
template <class Algorithm, class PyAlg>
typename std::enable_if<std::is_abstract<Algorithm>::value, void>::type declareAlgorithmConstructor(
        PyAlg &cls) {}

template <class Algorithm, class PyAlg>
void declareAlgorithm(PyAlg &clsAlgorithm) {
    /* Member types and enums */

    /* Constructors */
    declareAlgorithmConstructor<Algorithm>(clsAlgorithm);

    /* Operators */

    /* Members */
    clsAlgorithm.def("fail", &Algorithm::fail, "measRecord"_a, "error"_a = NULL);
    clsAlgorithm.def("measure", &Algorithm::measure, "record"_a, "exposure"_a);
}

template <class Algorithm, class Control, class PyAlg, class PyCtrl>
void declareAlgorithm(PyAlg &clsAlgorithm, PyCtrl &clsControl) {
    declareAlgorithm<Algorithm>(clsAlgorithm);

    /* Member types and enums */

    /* Constructors */
    clsControl.def(py::init<>());

    /* Operators */

    /* Members */
}

template <class Algorithm, class Control, class Transform, class PyAlg, class PyCtrl, class PyXform>
void declareAlgorithm(PyAlg &clsAlgorithm, PyCtrl &clsControl, PyXform &clsTransform) {
    declareAlgorithm<Algorithm, Control>(clsAlgorithm, clsControl);

    /* Member types and enums */

    /* Constructors */
    clsTransform.def(
            py::init<typename Transform::Control const &, std::string const &, afw::table::SchemaMapper &>(),
            "ctrl"_a, "name"_a, "mapper"_a);

    /* Operators */
    clsTransform.def("__call__",
                     [](Transform const &self, afw::table::SourceCatalog const &inputCatalog,
                        afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs,
                        afw::image::PhotoCalib const &photoCalib) {
                         return self(inputCatalog, outputCatalog, wcs, photoCalib);
                     },
                     "inputCatalog"_a, "outputCatalog"_a, "wcs"_a, "photoCalib"_a);

    /* Members */
}

}  // namespace python
}  // namespace base
}  // namespace meas
}  // namespace lsst

#endif