LSSTApplications  17.0+10,17.0+51,17.0+88,18.0.0+10,18.0.0+15,18.0.0+34,18.0.0+4,18.0.0+6,18.0.0-2-ge43143a+6,18.1.0-1-g0001055+2,18.1.0-1-g0896a44+10,18.1.0-1-g1349e88+9,18.1.0-1-g2505f39+7,18.1.0-1-g380d4d4+9,18.1.0-1-g5e4b7ea+2,18.1.0-1-g7e8fceb,18.1.0-1-g85f8cd4+7,18.1.0-1-g9a6769a+3,18.1.0-1-ga1a4c1a+6,18.1.0-1-gc037db8+2,18.1.0-1-gd55f500+3,18.1.0-1-ge10677a+7,18.1.0-10-g73b8679e+12,18.1.0-12-gf30922b,18.1.0-13-g451e75588,18.1.0-13-gbfe7f7f,18.1.0-2-g31c43f9+7,18.1.0-2-g9c63283+9,18.1.0-2-gdf0b915+9,18.1.0-2-gf03bb23+2,18.1.0-3-g52aa583+3,18.1.0-3-g8f4a2b1+1,18.1.0-3-g9cb968e+8,18.1.0-4-g7bbbad0,18.1.0-5-g510c42a+8,18.1.0-5-ga46117f,18.1.0-5-gaeab27e+9,18.1.0-6-gdda7f3e+11,18.1.0-8-g4084bf03+1,w.2019.34
LSSTDataManagementBasePackage
Functions
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. More...
 
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. More...
 
template<class Algorithm , class PyAlg >
void declareAlgorithm (PyAlg &clsAlgorithm)
 Wrap the implicit API used by meas_base's algorithms. More...
 
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). More...
 
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. More...
 

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
AlgorithmThe algorithm class.
PyAlgThe pybind11::class_ class corresponding to Algorithm.
Parameters
[in,out]clsAlgorithmThe pybind11 wrapper for Algorithm.

Definition at line 87 of file python.h.

87  {
88  /* Member types and enums */
89 
90  /* Constructors */
91  declareAlgorithmConstructor<Algorithm>(clsAlgorithm);
92 
93  /* Operators */
94 
95  /* Members */
96  clsAlgorithm.def("fail", &Algorithm::fail, "measRecord"_a, "error"_a = NULL);
97  clsAlgorithm.def("measure", &Algorithm::measure, "record"_a, "exposure"_a);
98 }
def measure(mi, x, y, size, statistic, stats)
Definition: fringe.py:473

◆ 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
AlgorithmThe algorithm class.
ControlThe control class. Must equal Algorithm::Control and Transform::Control.
PyAlgThe pybind11::class_ class corresponding to Algorithm.
PyCtrlThe pybind11::class_ class corresponding to Control.
Parameters
[in,out]clsAlgorithm,clsControlThe pybind11 wrappers for the respective C++ classes.

Definition at line 116 of file python.h.

116  {
117  declareAlgorithm<Algorithm>(clsAlgorithm);
118 
119  /* Member types and enums */
120 
121  /* Constructors */
122  clsControl.def(py::init<>());
123 
124  /* Operators */
125 
126  /* Members */
127 }

◆ 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
AlgorithmThe algorithm class.
ControlThe control class. Must equal Algorithm::Control and Transform::Control.
TransformThe transform class.
PyAlgThe pybind11::class_ class corresponding to Algorithm.
PyCtrlThe pybind11::class_ class corresponding to Control.
PyXformThe pybind11::class_ class corresponding to Transform.
Parameters
[in,out]clsAlgorithm,clsControl,clsTransformThe pybind11 wrappers for the respective C++ classes.

Definition at line 148 of file python.h.

148  {
149  declareAlgorithm<Algorithm, Control>(clsAlgorithm, clsControl);
150 
151  /* Member types and enums */
152 
153  /* Constructors */
154  clsTransform.def(
155  py::init<typename Transform::Control const &, std::string const &, afw::table::SchemaMapper &>(),
156  "ctrl"_a, "name"_a, "mapper"_a);
157 
158  /* Operators */
159  clsTransform.def("__call__",
160  [](Transform const &self, afw::table::SourceCatalog const &inputCatalog,
161  afw::table::BaseCatalog &outputCatalog, afw::geom::SkyWcs const &wcs,
162  afw::image::PhotoCalib const &photoCalib) {
163  return self(inputCatalog, outputCatalog, wcs, photoCalib);
164  },
165  "inputCatalog"_a, "outputCatalog"_a, "wcs"_a, "photoCalib"_a);
166 
167  /* Members */
168 }
CatalogT< BaseRecord > BaseCatalog
Definition: fwd.h:71
Key< int > photoCalib
Definition: Exposure.cc:67
table::Key< table::Array< std::uint8_t > > wcs
Definition: SkyWcs.cc:71
SortedCatalogT< SourceRecord > SourceCatalog
Definition: fwd.h:85

◆ 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
AlgorithmThe algorithm class.
PyAlgThe pybind11::class_ class corresponding to Algorithm.
Parameters
[in,out]clsThe pybind11 wrapper for Algorithm.

Definition at line 55 of file python.h.

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

◆ 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
AlgorithmThe algorithm class.
PyAlgThe pybind11::class_ class corresponding to Algorithm.
Parameters
[in,out]clsThe pybind11 wrapper for Algorithm.

Definition at line 72 of file python.h.

73  {}