LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
_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
34namespace py = pybind11;
35using namespace py::literals;
36
37namespace lsst {
38namespace afw {
39namespace table {
40
41using utils::python::WrapperCollection;
42
43namespace {
44
45using PyBaseColumnView = py::class_<BaseColumnView, std::shared_ptr<BaseColumnView>>;
46
47using PyBitsColumn = py::class_<BitsColumn, std::shared_ptr<BitsColumn>>;
48
49template <typename T, typename PyClass>
50static 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
56template <typename U, typename PyClass>
57static 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// TODO: remove this method and any calls to it on DM-32980.
64template <typename PyClass>
65static void declareBaseColumnViewFlagOverloads(PyClass &cls) {
66 cls.def("_basicget",
67 [](BaseColumnView &self, Key<Flag> const &key) -> ndarray::Array<bool const, 1, 1> const {
68 PyErr_WarnEx(
69 PyExc_FutureWarning,
70 "Flag/bool access via ColumnView objects is deprecated in favor of more complete support "
71 "on Catalog. Will be removed after v26.",
72 2 // stack level
73 );
74 return ndarray::copy(self[key]);
75 });
76};
77
78static void declareBaseColumnView(WrapperCollection &wrappers) {
79 // We can't call this "BaseColumnView" because that's the typedef for "ColumnViewT<BaseRecord>".
80 // This is just a mostly-invisible implementation base class, so we use the same naming convention
81 // we use for those.
82 wrappers.wrapType(PyBaseColumnView(wrappers.module, "_BaseColumnViewBase"), [](auto &mod, auto &cls) {
83 cls.def("getTable", &BaseColumnView::getTable);
84 cls.def_property_readonly("table", &BaseColumnView::getTable);
85 cls.def("getSchema", &BaseColumnView::getSchema);
86 cls.def_property_readonly("schema", &BaseColumnView::getSchema);
87 // _getBits supports a Python version of getBits that accepts None and field names as keys
88 cls.def("_getBits", &BaseColumnView::getBits);
89 cls.def("getAllBits", &BaseColumnView::getAllBits);
90 declareBaseColumnViewOverloads<std::uint8_t>(cls);
91 declareBaseColumnViewOverloads<std::uint16_t>(cls);
92 declareBaseColumnViewOverloads<std::int32_t>(cls);
93 declareBaseColumnViewOverloads<std::int64_t>(cls);
94 declareBaseColumnViewOverloads<float>(cls);
95 declareBaseColumnViewOverloads<double>(cls);
96 declareBaseColumnViewFlagOverloads(cls);
97 // std::string columns are not supported, because numpy string arrays
98 // do not have the same memory model as ours.
99 declareBaseColumnViewArrayOverloads<std::uint8_t>(cls);
100 declareBaseColumnViewArrayOverloads<std::uint16_t>(cls);
101 declareBaseColumnViewArrayOverloads<int>(cls);
102 declareBaseColumnViewArrayOverloads<float>(cls);
103 declareBaseColumnViewArrayOverloads<double>(cls);
104 // lsst::geom::Angle requires custom wrappers, because ndarray doesn't
105 // recognize it natively; we just return a double view
106 // (e.g. radians).
107 cls.def("_basicget", &BaseColumnView::get_radians_array);
108 });
109}
110
111static 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::SizeT(BitsColumn::*)(Key<Flag> const &) const) & BitsColumn::getBit,
116 "key"_a);
117 cls.def("getBit", (BitsColumn::SizeT(BitsColumn::*)(std::string const &) const) & BitsColumn::getBit,
118 "name"_a);
119 cls.def("getMask", (BitsColumn::SizeT(BitsColumn::*)(Key<Flag> const &) const) & BitsColumn::getMask,
120 "key"_a);
121 cls.def("getMask", (BitsColumn::SizeT(BitsColumn::*)(std::string const &) const) & BitsColumn::getMask,
122 "name"_a);
123 });
124}
125
126} // namespace
127
128void wrapBaseColumnView(WrapperCollection &wrappers) {
129 declareBaseColumnView(wrappers);
130 declareBitsColumn(wrappers);
131}
132
133} // namespace table
134} // namespace afw
135} // namespace lsst
Tag types used to declare specialized field types.
Definition misc.h:31
void wrapBaseColumnView(WrapperCollection &wrappers)