LSSTApplications  20.0.0
LSSTDataManagementBasePackage
_baseColumnView.cc
Go to the documentation of this file.
1 /*
2  * This file is part of afw.
3  *
4  * Developed for the LSST Data Management System.
5  * This product includes software developed by the LSST Project
6  * (https://www.lsst.org).
7  * See the COPYRIGHT file at the top-level directory of this distribution
8  * for details of code ownership.
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <https://www.gnu.org/licenses/>.
22  */
23 
24 #include "pybind11/pybind11.h"
25 #include "pybind11/stl.h"
26 
27 #include "ndarray/pybind11.h"
28 
29 #include "lsst/utils/python.h"
30 
31 #include "lsst/afw/table/Key.h"
33 
34 namespace py = pybind11;
35 using namespace py::literals;
36 
37 namespace lsst {
38 namespace afw {
39 namespace table {
40 
41 using utils::python::WrapperCollection;
42 
43 namespace {
44 
45 using PyBaseColumnView = py::class_<BaseColumnView, std::shared_ptr<BaseColumnView>>;
46 
47 using PyBitsColumn = py::class_<BitsColumn, std::shared_ptr<BitsColumn>>;
48 
49 template <typename T, typename PyClass>
50 static void declareBaseColumnViewOverloads(PyClass &cls) {
51  cls.def("_basicget", [](BaseColumnView & self, Key<T> const &key) -> typename ndarray::Array<T, 1> const {
52  return self[key];
53  });
54 };
55 
56 template <typename U, typename PyClass>
57 static void declareBaseColumnViewArrayOverloads(PyClass &cls) {
58  cls.def("_basicget",
59  [](BaseColumnView & self, Key<lsst::afw::table::Array<U>> const &key) ->
60  typename ndarray::Array<U, 2, 1> const { return self[key]; });
61 };
62 
63 template <typename PyClass>
64 static void declareBaseColumnViewFlagOverloads(PyClass &cls) {
65  cls.def("_basicget",
66  [](BaseColumnView &self, Key<Flag> const &key) -> ndarray::Array<bool const, 1, 1> const {
67  return ndarray::copy(self[key]);
68  });
69 };
70 
71 static void declareBaseColumnView(WrapperCollection &wrappers) {
72  // We can't call this "BaseColumnView" because that's the typedef for "ColumnViewT<BaseRecord>".
73  // This is just a mostly-invisible implementation base class, so we use the same naming convention
74  // we use for those.
75  wrappers.wrapType(PyBaseColumnView(wrappers.module, "_BaseColumnViewBase"), [](auto &mod, auto &cls) {
76  cls.def("getTable", &BaseColumnView::getTable);
77  cls.def_property_readonly("table", &BaseColumnView::getTable);
78  cls.def("getSchema", &BaseColumnView::getSchema);
79  cls.def_property_readonly("schema", &BaseColumnView::getSchema);
80  // _getBits supports a Python version of getBits that accepts None and field names as keys
81  cls.def("_getBits", &BaseColumnView::getBits);
82  cls.def("getAllBits", &BaseColumnView::getAllBits);
83  declareBaseColumnViewOverloads<std::uint8_t>(cls);
84  declareBaseColumnViewOverloads<std::uint16_t>(cls);
85  declareBaseColumnViewOverloads<std::int32_t>(cls);
86  declareBaseColumnViewOverloads<std::int64_t>(cls);
87  declareBaseColumnViewOverloads<float>(cls);
88  declareBaseColumnViewOverloads<double>(cls);
89  declareBaseColumnViewFlagOverloads(cls);
90  // std::string columns are not supported, because numpy string arrays
91  // do not have the same memory model as ours.
92  declareBaseColumnViewArrayOverloads<std::uint8_t>(cls);
93  declareBaseColumnViewArrayOverloads<std::uint16_t>(cls);
94  declareBaseColumnViewArrayOverloads<int>(cls);
95  declareBaseColumnViewArrayOverloads<float>(cls);
96  declareBaseColumnViewArrayOverloads<double>(cls);
97  // lsst::geom::Angle requires custom wrappers, because ndarray doesn't
98  // recognize it natively; we just return a double view
99  // (e.g. radians).
100  using AngleArray = ndarray::Array<lsst::geom::Angle, 1>;
101  using DoubleArray = ndarray::Array<double, 1>;
102  cls.def("_basicget", [](BaseColumnView &self, Key<lsst::geom::Angle> const &key) -> DoubleArray {
103  ndarray::Array<lsst::geom::Angle, 1, 0> a = self[key];
104  return ndarray::detail::ArrayAccess<DoubleArray>::construct(
105  reinterpret_cast<double *>(a.getData()),
106  ndarray::detail::ArrayAccess<AngleArray>::getCore(a));
107  });
108  });
109 }
110 
111 static void declareBitsColumn(WrapperCollection &wrappers) {
112  wrappers.wrapType(PyBitsColumn(wrappers.module, "BitsColumn"), [](auto &mod, auto &cls) {
113  cls.def("getArray", &BitsColumn::getArray);
114  cls.def_property_readonly("array", &BitsColumn::getArray);
115  cls.def("getBit", (BitsColumn::IntT(BitsColumn::*)(Key<Flag> const &) const) & BitsColumn::getBit,
116  "key"_a);
117  cls.def("getBit", (BitsColumn::IntT(BitsColumn::*)(std::string const &) const) & BitsColumn::getBit,
118  "name"_a);
119  cls.def("getMask", (BitsColumn::IntT(BitsColumn::*)(Key<Flag> const &) const) & BitsColumn::getMask,
120  "key"_a);
121  cls.def("getMask", (BitsColumn::IntT(BitsColumn::*)(std::string const &) const) & BitsColumn::getMask,
122  "name"_a);
123  });
124 }
125 
126 } // namespace
127 
129  declareBaseColumnView(wrappers);
130  declareBitsColumn(wrappers);
131 }
132 
133 } // namespace table
134 } // namespace afw
135 } // namespace lsst
lsst::afw::table::wrapBaseColumnView
void wrapBaseColumnView(WrapperCollection &wrappers)
Definition: _baseColumnView.cc:128
lsst::afw
Definition: imageAlgorithm.dox:1
BaseColumnView.h
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
PyClass
py::class_< ProductBoundedField, std::shared_ptr< ProductBoundedField >, BoundedField > PyClass
Definition: productBoundedField.cc:32
lsst::utils::python::WrapperCollection
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
lsst::afw::table::Array
Tag types used to declare specialized field types.
Definition: misc.h:32
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
Key.h
key
Key< U > key
Definition: Schema.cc:281
pybind11
Definition: _GenericMap.cc:40