LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
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
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 cpputils::python::WrapperCollection;
42
43namespace {
44
45using PyBaseColumnView = py::classh<BaseColumnView>;
46
47using PyBitsColumn = py::classh<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
129 declareBaseColumnView(wrappers);
130 declareBitsColumn(wrappers);
131}
132
133} // namespace table
134} // namespace afw
135} // namespace lsst
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition python.h:391
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
Column-wise view into a sequence of records that have been allocated contiguously.
A class used as a handle to a particular field in a table.
Definition Key.h:53
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void wrapBaseColumnView(WrapperCollection &wrappers)