lsst::meas::base::python Namespace Reference

Functions
template<class Algorithm, class PyAlg>
std::enable_if<!std::is_abstract< Algorithm >::value, void >::type	declareAlgorithmConstructor (PyAlg &cls)
	Wrap the standard algorithm constructor.
template<class Algorithm, class PyAlg>
std::enable_if< std::is_abstract< Algorithm >::value, void >::type	declareAlgorithmConstructor (PyAlg &cls)
	Dummy function for not wrapping the constructor of an abstract base class.
template<class Algorithm, class PyAlg>
void	declareAlgorithm (PyAlg &clsAlgorithm)
	Wrap the implicit API used by meas_base's algorithms.
template<class Algorithm, class Control, class PyAlg, class PyCtrl>
void	declareAlgorithm (PyAlg &clsAlgorithm, PyCtrl &clsControl)
	Wrap the implicit API used by meas_base's algorithm-control pairs (no transform).
template<class Algorithm, class Control, class Transform, class PyAlg, class PyCtrl, class PyXform>
void	declareAlgorithm (PyAlg &clsAlgorithm, PyCtrl &clsControl, PyXform &clsTransform)
	Wrap the implicit API used by meas_base's algorithm-control-transform triads.

Function Documentation

declareAlgorithm() [1/3]

template<class Algorithm, class PyAlg>

void lsst::meas::base::python::declareAlgorithm

(

PyAlg &

clsAlgorithm

)

Wrap the implicit API used by meas_base's algorithms.

This function only initializes constructors, fields, and methods common to all Algorithms.

Template Parameters

Algorithm	The algorithm class.
PyAlg	The pybind11::class_ class corresponding to Algorithm.

Parameters

[in,out]

clsAlgorithm

The pybind11 wrapper for Algorithm.

Definition at line 87 of file python.h.

                                           {
    /* 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);
}

declareAlgorithm() [2/3]

template<class Algorithm, class Control, class PyAlg, class PyCtrl>

void lsst::meas::base::python::declareAlgorithm	(	PyAlg &	clsAlgorithm,
		PyCtrl &	clsControl )

Wrap the implicit API used by meas_base's algorithm-control pairs (no transform).

This function only initializes constructors, fields, and methods common to all Algorithms and Controls.

Template Parameters

Algorithm	The algorithm class.
Control	The control class. Must equal Algorithm::Control and Transform::Control.
PyAlg	The pybind11::class_ class corresponding to Algorithm.
PyCtrl	The pybind11::class_ class corresponding to Control.

Parameters

[in,out]

clsAlgorithm,clsControl

The pybind11 wrappers for the respective C++ classes.

Definition at line 116 of file python.h.

                                                               {
    declareAlgorithm<Algorithm>(clsAlgorithm);
 
    /* Member types and enums */
 
    /* Constructors */
    clsControl.def(py::init<>());
 
    /* Operators */
 
    /* Members */
}

declareAlgorithm() [3/3]

template<class Algorithm, class Control, class Transform, class PyAlg, class PyCtrl, class PyXform>

void lsst::meas::base::python::declareAlgorithm	(	PyAlg &	clsAlgorithm,
		PyCtrl &	clsControl,
		PyXform &	clsTransform )

Wrap the implicit API used by meas_base's algorithm-control-transform triads.

This function only initializes constructors, fields, and methods common to all Algorithms, Controls, and Transforms.

Template Parameters

Algorithm	The algorithm class.
Control	The control class. Must equal Algorithm::Control and Transform::Control.
Transform	The transform class.
PyAlg	The pybind11::class_ class corresponding to Algorithm.
PyCtrl	The pybind11::class_ class corresponding to Control.
PyXform	The pybind11::class_ class corresponding to Transform.

Parameters

[in,out]

clsAlgorithm,clsControl,clsTransform

The pybind11 wrappers for the respective C++ classes.

Definition at line 148 of file python.h.

                                                                                      {
    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 */
}

declareAlgorithmConstructor() [1/2]

template<class Algorithm, class PyAlg>

std::enable_if<!std::is_abstract< Algorithm >::value, void >::type lsst::meas::base::python::declareAlgorithmConstructor

(

PyAlg &

cls

)

Wrap the standard algorithm constructor.

Template Parameters

Algorithm	The algorithm class.
PyAlg	The pybind11::class_ class corresponding to Algorithm.

Parameters

[in,out]

cls

The pybind11 wrapper for Algorithm.

Definition at line 55 of file python.h.

                    {
    cls.def(py::init<typename Algorithm::Control const &, std::string const &, afw::table::Schema &>(),
            "ctrl"_a, "name"_a, "schema"_a);
}

declareAlgorithmConstructor() [2/2]

template<class Algorithm, class PyAlg>

std::enable_if< std::is_abstract< Algorithm >::value, void >::type lsst::meas::base::python::declareAlgorithmConstructor

(

PyAlg &

cls

)

Dummy function for not wrapping the constructor of an abstract base class.

Pybind11 cannot wrap such constructors, and there is no reason to call them from Python anyway.

Template Parameters

Algorithm	The algorithm class.
PyAlg	The pybind11::class_ class corresponding to Algorithm.

Parameters

[in,out]

cls

The pybind11 wrapper for Algorithm.

Definition at line 72 of file python.h.

                    {}