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
_arrays.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#include "lsst/afw/table/Key.h"
34
35namespace py = pybind11;
36using namespace pybind11::literals;
37
38namespace lsst {
39namespace afw {
40namespace table {
41
42using cpputils::python::WrapperCollection;
43
44namespace {
45
46// We don't expose base classes (e.g. FunctorKey) to Python, since they're just used to
47// define a CRTP interface in C++ and in Python that's just duck-typing.
48
49template <typename T>
50using PyArrayKey = py::classh<ArrayKey<T>>;
51
52template <typename T>
53void declareArrayKey(WrapperCollection &wrappers, std::string const &suffix) {
54 wrappers.wrapType(
55 PyArrayKey<T>(wrappers.module, ("Array" + suffix + "Key").c_str()), [](auto &mod, auto &cls) {
56 cls.def(py::init<>());
57 cls.def(py::init<Key<Array<T>> const &>());
58 cls.def(py::init<SubSchema const &>());
59 cls.def(py::init<std::vector<Key<T>> const &>());
60
61 cls.def_static("addFields",
62 (ArrayKey<T>(*)(Schema &, std::string const &, std::string const &,
63 std::string const &, std::vector<T> const &)) &
64 ArrayKey<T>::addFields,
65 "schema"_a, "name"_a, "doc"_a, "unit"_a, "docData"_a);
66 cls.def_static("addFields",
67 (ArrayKey<T>(*)(Schema &, std::string const &, std::string const &,
68 std::string const &, std::size_t size)) &
69 ArrayKey<T>::addFields,
70 "schema"_a, "name"_a, "doc"_a, "unit"_a, "size"_a);
71 cls.def("get", &ArrayKey<T>::get);
72 cls.def("set", &ArrayKey<T>::set);
73 cls.def("isValid", &ArrayKey<T>::isValid);
74 cls.def("__eq__", &ArrayKey<T>::operator==, py::is_operator());
75 cls.def("__ne__", &ArrayKey<T>::operator!=, py::is_operator());
76 cls.def("__getitem__",
77 // Special implementation of __getitem__ to support ints and slices
78 [](ArrayKey<T> const &self, py::object const &index) -> py::object {
79 if (py::isinstance<py::slice>(index)) {
80 py::slice slice(index);
81 py::size_t start = 0, stop = 0, step = 0, length = 0;
82 bool valid = slice.compute(self.getSize(), &start, &stop, &step, &length);
83 if (!valid) throw py::error_already_set();
84 if (step != 1) {
85 throw py::index_error("Step for ArrayKey must be 1.");
86 }
87 return py::cast(self.slice(start, stop));
88 } else {
89 std::size_t n = cpputils::python::cppIndex(self.getSize(),
90 py::cast<std::ptrdiff_t>(index));
91 return py::cast(self[n]);
92 }
93 });
94 cls.def("getSize", &ArrayKey<T>::getSize);
95 cls.def("slice", &ArrayKey<T>::slice);
96 });
97};
98
99} // namespace
100
102 declareArrayKey<float>(wrappers, "F");
103 declareArrayKey<double>(wrappers, "D");
104}
105
106} // namespace table
107} // namespace afw
108} // 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
std::size_t getSize() const noexcept
Return the number of elements in the array.
Definition arrays.h:108
ArrayKey slice(std::size_t begin, std::size_t end) const
Return a FunctorKey corresponding to a range of elements.
Definition arrays.cc:143
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void wrapArrays(WrapperCollection &wrappers)
Definition _arrays.cc:101