LSSTApplications  18.1.0
LSSTDataManagementBasePackage
star.cc
Go to the documentation of this file.
1 // -*- LSST-C++ -*-
2 /*
3  * This file is part of jointcal.
4  *
5  * Developed for the LSST Data Management System.
6  * This product includes software developed by the LSST Project
7  * (https://www.lsst.org).
8  * See the COPYRIGHT file at the top-level directory of this distribution
9  * for details of code ownership.
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program. If not, see <https://www.gnu.org/licenses/>.
23  */
24 
25 #include "pybind11/pybind11.h"
26 #include "pybind11/stl.h"
27 
28 #include <list>
29 
30 #include "lsst/utils/python.h"
31 
32 #include "lsst/jointcal/Point.h"
33 #include "lsst/jointcal/FatPoint.h"
34 #include "lsst/jointcal/BaseStar.h"
37 #include "lsst/jointcal/RefStar.h"
38 
39 namespace py = pybind11;
40 using namespace pybind11::literals;
41 
42 namespace lsst {
43 namespace jointcal {
44 namespace {
45 
46 void declarePoint(py::module &mod) {
47  py::class_<Point, std::shared_ptr<Point>> cls(mod, "Point");
48 
49  cls.def(py::init<double, double>(), "x"_a, "y"_a);
50 
51  cls.def_readwrite("x", &Point::x);
52  cls.def_readwrite("y", &Point::y);
53 
54  utils::python::addOutputOp(cls, "__str__");
55 }
56 
57 void declareFatPoint(py::module &mod) {
58  py::class_<FatPoint, std::shared_ptr<FatPoint>, Point> cls(mod, "FatPoint");
59 
60  cls.def(py::init());
61 }
62 
63 void declareBaseStar(py::module &mod) {
64  py::class_<BaseStar, std::shared_ptr<BaseStar>, FatPoint> cls(mod, "BaseStar");
65 
66  cls.def(py::init<double, double, double, double>(), "x"_a, "y"_a, "flux"_a, "fluxErr"_a);
67 
68  // these three are actually declared in FatPoint, but we didn't want that in Python.
69  // NOTE: see DM-9814 about the necessity of the pointer cast below.
70  cls.def_readonly("vx", (double BaseStar::*)&BaseStar::vx);
71  cls.def_readonly("vy", (double BaseStar::*)&BaseStar::vy);
72  cls.def_readonly("vxy", (double BaseStar::*)&BaseStar::vxy);
73 
74  // cls.def("getFlux", &BaseStar::getFlux);
75  cls.def_property_readonly("flux", (double (BaseStar::*)() const) & BaseStar::getFlux);
76  cls.def_property_readonly("fluxErr", (double (BaseStar::*)() const) & BaseStar::getFluxErr);
77  cls.def_property_readonly("mag", (double (BaseStar::*)() const) & BaseStar::getMag);
78  cls.def_property_readonly("magErr", (double (BaseStar::*)() const) & BaseStar::getMagErr);
79 }
80 
81 void declareRefStar(py::module &mod) {
82  py::class_<RefStar, std::shared_ptr<RefStar>, BaseStar> cls(mod, "RefStar");
83 
84  cls.def(py::init<double, double, double, double>(), "xx"_a, "yy"_a, "flux"_a, "fluxErr"_a);
85 }
86 
87 void declareFittedStar(py::module &mod) {
88  py::class_<FittedStar, std::shared_ptr<FittedStar>, BaseStar> cls(mod, "FittedStar");
89 
90  cls.def(py::init<>());
91  cls.def(py::init<BaseStar const &>(), "baseStar"_a);
92 }
93 
94 void declareMeasuredStar(py::module &mod) {
95  py::class_<MeasuredStar, std::shared_ptr<MeasuredStar>, BaseStar> cls(mod, "MeasuredStar");
96 
97  cls.def(py::init<>());
98  cls.def(py::init<BaseStar const &>(), "baseStar"_a);
99 
100  cls.def("getFittedStar", &MeasuredStar::getFittedStar);
101  cls.def("setFittedStar", &MeasuredStar::setFittedStar);
102 
103  cls.def("getInstFlux", &MeasuredStar::getInstFlux);
104  cls.def("setInstFluxAndErr", &MeasuredStar::setInstFluxAndErr);
105  cls.def("getInstFluxErr", &MeasuredStar::getInstFluxErr);
106  cls.def("getInstMag", &MeasuredStar::getInstMag);
107  cls.def("getInstMagErr", &MeasuredStar::getInstMagErr);
108  cls.def("setXFocal", &MeasuredStar::setXFocal);
109  cls.def("setYFocal", &MeasuredStar::setYFocal);
110  cls.def("getXFocal", &MeasuredStar::getXFocal);
111  cls.def("getYFocal", &MeasuredStar::getYFocal);
112 }
113 
114 PYBIND11_MODULE(star, mod) {
115  declarePoint(mod);
116  declareFatPoint(mod);
117  declareBaseStar(mod);
118  declareRefStar(mod);
119  declareFittedStar(mod);
120  declareMeasuredStar(mod);
121 }
122 } // namespace
123 } // namespace jointcal
124 } // namespace lsst
void addOutputOp(PyClass &cls, std::string const &method)
Add __str__ or __repr__ method implemented by operator<<.
Definition: python.h:87
def init()
Definition: tests.py:75
PYBIND11_MODULE(camera, mod)
Definition: camera.cc:34
def getMag(record, fluxType='cmodel')
Definition: compareModel.py:33
int y
Definition: SpanSet.cc:49
A base class for image defects.
double x