lsst.afw  20.0.0-16-gfab17e72e+f119078cbc
sortedCatalog.h
Go to the documentation of this file.
1 #ifndef AFW_TABLE_PYBIND11_SORTEDCATALOG_H_INCLUDED
2 #define AFW_TABLE_PYBIND11_SORTEDCATALOG_H_INCLUDED
3 /*
4  * This file is part of afw.
5  *
6  * Developed for the LSST Data Management System.
7  * This product includes software developed by the LSST Project
8  * (https://www.lsst.org).
9  * See the COPYRIGHT file at the top-level directory of this distribution
10  * for details of code ownership.
11  *
12  * This program is free software: you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation, either version 3 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program. If not, see <https://www.gnu.org/licenses/>.
24  */
25 
26 #include "pybind11/pybind11.h"
27 
28 #include "lsst/utils/python.h"
29 
32 
33 namespace lsst {
34 namespace afw {
35 namespace table {
36 namespace python {
37 
38 template <typename Record>
40  pybind11::class_<SortedCatalogT<Record>, std::shared_ptr<SortedCatalogT<Record>>, CatalogT<Record>>;
41 
56 template <typename Record>
58  std::string const &name, bool isBase = false) {
59  namespace py = pybind11;
60  using namespace pybind11::literals;
61 
63  using Table = typename Record::Table;
64 
65  auto clsBase = declareCatalog<Record>(wrappers, name, true);
66 
67  std::string fullName;
68  if (isBase) {
69  fullName = "_" + name + "SortedCatalogBase";
70  } else {
71  fullName = name + "Catalog";
72  }
73 
74  // We need py::dynamic_attr() in the class definition to support our Python-side caching
75  // of the associated ColumnView.
76  return wrappers.wrapType(
77  PySortedCatalog<Record>(wrappers.module, fullName.c_str(), py::dynamic_attr()),
78  [clsBase](auto &mod, auto &cls) {
79  /* Constructors */
80  cls.def(pybind11::init<Schema const &>());
81  cls.def(pybind11::init<std::shared_ptr<Table> const &>(),
82  "table"_a = std::shared_ptr<Table>());
83  cls.def(pybind11::init<Catalog const &>());
84 
85  /* Overridden and Variant Methods */
86  cls.def_static("readFits", (Catalog(*)(std::string const &, int, int)) & Catalog::readFits,
87  "filename"_a, "hdu"_a = fits::DEFAULT_HDU, "flags"_a = 0);
88  cls.def_static("readFits", (Catalog(*)(fits::MemFileManager &, int, int)) & Catalog::readFits,
89  "manager"_a, "hdu"_a = fits::DEFAULT_HDU, "flags"_a = 0);
90  // readFits taking Fits objects not wrapped, because Fits objects are not wrapped.
91 
92  cls.def("subset",
93  (Catalog(Catalog::*)(ndarray::Array<bool const, 1> const &) const) & Catalog::subset);
94  cls.def("subset",
95  (Catalog(Catalog::*)(std::ptrdiff_t, std::ptrdiff_t, std::ptrdiff_t) const) &
96  Catalog::subset);
97 
98  // The following three methods shadow those in the base class in C++ (unlike the base class
99  // versions, they do not require a key argument because we assume it's the ID key). In
100  // Python, we make that appear as though the key argument is available but has a default
101  // value. If that key is not None, we delegate to the base class.
102  cls.def("isSorted",
103  [clsBase](py::object const &self, py::object key) -> py::object {
104  if (key.is(py::none())) {
105  key = self.attr("table").attr("getIdKey")();
106  }
107  return clsBase.attr("isSorted")(self, key);
108  },
109  "key"_a = py::none());
110  cls.def("sort",
111  [clsBase](py::object const &self, py::object key) -> py::object {
112  if (key.is(py::none())) {
113  key = self.attr("table").attr("getIdKey")();
114  }
115  return clsBase.attr("sort")(self, key);
116  },
117  "key"_a = py::none());
118  cls.def("find",
119  [clsBase](py::object const &self, py::object const &value,
120  py::object key) -> py::object {
121  if (key.is(py::none())) {
122  key = self.attr("table").attr("getIdKey")();
123  }
124  return clsBase.attr("find")(self, value, key);
125  },
126  "value"_a, "key"_a = py::none());
127 
128  });
129 }
130 
131 } // namespace python
132 } // namespace table
133 } // namespace afw
134 } // namespace lsst
135 
136 #endif // !AFW_TABLE_PYBIND11_CATALOG_H_INCLUDED
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::table::python::declareSortedCatalog
PySortedCatalog< Record > declareSortedCatalog(utils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
Wrap an instantiation of lsst::afw::table::SortedCatalogT<Record>.
Definition: sortedCatalog.h:57
lsst::afw::table._base.Catalog
Definition: _base.py:88
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst::utils::python::WrapperCollection::wrapType
PyType wrapType(PyType cls, ClassWrapperCallback function, bool setModuleName=true)
std::string::c_str
T c_str(T... args)
lsst::utils::python::WrapperCollection
catalog.h
SortedCatalog.h
lsst
A base class for image defects.
key
Key< U > key
Definition: Schema.cc:281
pybind11
lsst::afw::table::python::PySortedCatalog
pybind11::class_< SortedCatalogT< Record >, std::shared_ptr< SortedCatalogT< Record > >, CatalogT< Record > > PySortedCatalog
Definition: sortedCatalog.h:40
lsst::utils::python::WrapperCollection::module
pybind11::module module
python.h
lsst::afw::table::CatalogT
A custom container class for records, based on std::vector.
Definition: Catalog.h:97
lsst::afw::table::SortedCatalogT
Custom catalog class for record/table subclasses that are guaranteed to have an ID,...
Definition: fwd.h:63