LSSTApplications  20.0.0
LSSTDataManagementBasePackage
centroidUtilities.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2017 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include "pybind11/pybind11.h"
24 #include "pybind11/eigen.h"
25 
26 #include <memory>
27 
28 #include "ndarray/pybind11.h"
29 
31 
32 namespace py = pybind11;
33 using namespace pybind11::literals;
34 
35 namespace lsst {
36 namespace meas {
37 namespace base {
38 
39 namespace {
40 
41 using PyCentroidChecker = py::class_<CentroidChecker>;
42 using PyCentroidResult = py::class_<CentroidResult, std::shared_ptr<CentroidResult>>;
43 using PyCentroidResultKey = py::class_<CentroidResultKey>;
44 using PyCentroidTransform = py::class_<CentroidTransform, std::shared_ptr<CentroidTransform>, BaseTransform>;
45 
46 void declareCentroidResult(py::module &mod) {
47  PyCentroidResult cls(mod, "CentroidResult");
48 
49  cls.def_readwrite("x", &CentroidResult::x);
50  cls.def_readwrite("y", &CentroidResult::y);
51  cls.def_readwrite("xErr", &CentroidResult::xErr);
52  cls.def_readwrite("yErr", &CentroidResult::yErr);
53  cls.def_readwrite("x_y_Cov", &CentroidResult::x_y_Cov);
54 
55  cls.def(py::init<>());
56  cls.def(py::init<CentroidElement, CentroidElement, CentroidCov const &>(), "x"_a, "y"_a, "matrix"_a);
57  cls.def(py::init<CentroidElement, CentroidElement, ErrElement, ErrElement>(), "x"_a, "y"_a, "xErr"_a,
58  "yErr"_a);
59 
60  cls.def("getCentroid", &CentroidResult::getCentroid);
61  cls.def("setCentroid", &CentroidResult::setCentroid, "centroid"_a);
62  cls.def("getPoint", &CentroidResult::getPoint);
63  cls.def("getCentroidErr", &CentroidResult::getCentroidErr);
64  cls.def("setCentroidErr",
65  (void (CentroidResult::*)(CentroidCov const &)) & CentroidResult::setCentroidErr, "matrix"_a);
66  cls.def("setCentroidErr",
67  (void (CentroidResult::*)(ErrElement, ErrElement)) & CentroidResult::setCentroidErr, "xErr"_a,
68  "yErr"_a);
69 }
70 
71 void declareCentroidResultKey(py::module &mod) {
72  PyCentroidResultKey cls(mod, "CentroidResultKey");
73 
74  cls.def(py::init<>());
75  cls.def(py::init<afw::table::PointKey<CentroidElement> const &,
76  afw::table::CovarianceMatrixKey<ErrElement, 2> const &>(),
77  "centroid"_a, "uncertainty"_a);
78  cls.def(py::init<afw::table::SubSchema const &>(), "subSchema"_a);
79 
80  cls.def_static("addFields", &CentroidResultKey::addFields, "schema"_a, "name"_a, "doc"_a, "uncertainty"_a);
81 
82  cls.def("__eq__", &CentroidResultKey::operator==, py::is_operator());
83  cls.def("__nq__", &CentroidResultKey::operator!=, py::is_operator());
84 
85  cls.def("get", &CentroidResultKey::get, "record"_a);
86  cls.def("set", &CentroidResultKey::set, "record"_a, "value"_a);
87  cls.def("isValid", &CentroidResultKey::isValid);
88  cls.def("getCentroid", &CentroidResultKey::getCentroid);
89  cls.def("getCentroidErr", &CentroidResultKey::getCentroidErr);
90  cls.def("getX", &CentroidResultKey::getX);
91  cls.def("getY", &CentroidResultKey::getY);
92 }
93 
94 void declareCentroidTransform(py::module &mod) {
95  PyCentroidTransform cls(mod, "CentroidTransform");
96 
97  cls.def(py::init<std::string const &, afw::table::SchemaMapper &>(), "name"_a, "mapper"_a);
98 
99  cls.def("__call__", &CentroidTransform::operator(), "inputCatalog"_a, "outputCatalog"_a, "wcs"_a,
100  "photoCalib"_a);
101 }
102 
103 void declareCentroidChecker(py::module &mod) {
104  PyCentroidChecker cls(mod, "CentroidChecker");
105 
106  cls.def(py::init<afw::table::Schema &, std::string const &, bool, double>(), "schema"_a, "name"_a,
107  "inside"_a = true, "maxDistFromPeak"_a = -1.0);
108 
109  cls.def("__call__", &CentroidChecker::operator(), "record"_a);
110 }
111 
112 void declareUncertaintyEnum(py::module &mod) {
113  py::enum_<UncertaintyEnum> enm(mod, "UncertaintyEnum");
114 
115  enm.value("NO_UNCERTAINTY", UncertaintyEnum::NO_UNCERTAINTY);
116  enm.value("SIGMA_ONLY", UncertaintyEnum::SIGMA_ONLY);
117  enm.value("FULL_COVARIANCE", UncertaintyEnum::FULL_COVARIANCE);
118 }
119 
120 } // namespace
121 
122 PYBIND11_MODULE(centroidUtilities, mod) {
123  py::module::import("lsst.afw.table");
124  py::module::import("lsst.meas.base.transform");
125 
126  declareCentroidResult(mod);
127  declareCentroidResultKey(mod);
128  declareCentroidTransform(mod);
129  declareCentroidChecker(mod);
130  declareUncertaintyEnum(mod);
131 }
132 
133 } // namespace base
134 } // namespace meas
135 } // namespace lsst
y
int y
Definition: SpanSet.cc:49
lsst::meas::base::FULL_COVARIANCE
@ FULL_COVARIANCE
The full covariance matrix is provided.
Definition: constants.h:46
CentroidUtilities.h
lsst::meas::base::NO_UNCERTAINTY
@ NO_UNCERTAINTY
Algorithm provides no uncertainy information at all.
Definition: constants.h:44
base
Definition: __init__.py:1
lsst::meas::base::SIGMA_ONLY
@ SIGMA_ONLY
Only the diagonal elements of the covariance matrix are provided.
Definition: constants.h:45
lsst::meas::base.plugins.BaseTransform
BaseTransform
Definition: plugins.py:98
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
x
double x
Definition: ChebyshevBoundedField.cc:277
lsst::meas::base::PYBIND11_MODULE
PYBIND11_MODULE(centroidUtilities, mod)
Definition: centroidUtilities.cc:122
lsst::meas::base::CentroidCov
Eigen::Matrix< ErrElement, 2, 2, Eigen::DontAlign > CentroidCov
Definition: constants.h:59
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::meas::base::ErrElement
float ErrElement
Definition: constants.h:55
isValid
bool isValid
Definition: fits.cc:399
pybind11
Definition: _GenericMap.cc:40
lsst::utils.tests.init
def init()
Definition: tests.py:58
set
daf::base::PropertySet * set
Definition: fits.cc:912
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42