Loading [MathJax]/extensions/tex2jax.js
LSST Applications 28.0.0,g1653933729+a8ce1bb630,g1a997c3884+a8ce1bb630,g28da252d5a+5bd70b7e6d,g2bbee38e9b+638fca75ac,g2bc492864f+638fca75ac,g3156d2b45e+07302053f8,g347aa1857d+638fca75ac,g35bb328faa+a8ce1bb630,g3a166c0a6a+638fca75ac,g3e281a1b8c+7bbb0b2507,g4005a62e65+17cd334064,g414038480c+5b5cd4fff3,g41af890bb2+4ffae9de63,g4e1a3235cc+0f1912dca3,g6249c6f860+3c3976f90c,g80478fca09+46aba80bd6,g82479be7b0+77990446f6,g858d7b2824+78ba4d1ce1,g89c8672015+f667a5183b,g9125e01d80+a8ce1bb630,ga5288a1d22+2a6264e9ca,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc22bb204ba+78ba4d1ce1,gc28159a63d+638fca75ac,gcf0d15dbbd+32ddb6096f,gd6b7c0dfd1+3e339405e9,gda3e153d99+78ba4d1ce1,gda6a2b7d83+32ddb6096f,gdaeeff99f8+1711a396fd,gdd5a9049c5+b18c39e5e3,ge2409df99d+a5e4577cdc,ge33fd446bb+78ba4d1ce1,ge79ae78c31+638fca75ac,gf0baf85859+64e8883e75,gf5289d68f6+e1b046a8d7,gfa443fc69c+91d9ed1ecf,gfda6b12a05+8419469a56
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
_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::class_<ArrayKey<T>, std::shared_ptr<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
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