LSSTApplications  20.0.0
LSSTDataManagementBasePackage
columnView.h
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 #ifndef AFW_TABLE_PYBIND11_COLUMNVIEW_H_INCLUDED
24 #define AFW_TABLE_PYBIND11_COLUMNVIEW_H_INCLUDED
25 
26 #include "pybind11/pybind11.h"
27 
28 #include "lsst/utils/python.h"
29 
31 
32 namespace lsst {
33 namespace afw {
34 namespace table {
35 namespace python {
36 
37 template <typename Record>
38 using PyColumnView =
39  pybind11::class_<ColumnViewT<Record>, std::shared_ptr<ColumnViewT<Record>>, BaseColumnView>;
40 
51 template <typename Record>
53  bool isBase = false) {
54  std::string fullName;
55  if (isBase) {
56  fullName = "_" + name + "ColumnViewBase";
57  } else {
58  fullName = name + "ColumnView";
59  }
60  return wrappers.wrapType(PyColumnView<Record>(wrappers.module, fullName.c_str()),
61  [](auto& mod, auto& cls) {
62  cls.def("getTable", &ColumnViewT<Record>::getTable);
63  cls.def_property_readonly("table", &ColumnViewT<Record>::getTable);
64  });
65 };
66 } // namespace python
67 } // namespace table
68 } // namespace afw
69 } // namespace lsst
70 #endif
std::string
STL class.
std::shared_ptr
STL class.
lsst::afw::table::python::declareColumnView
PyColumnView< Record > declareColumnView(utils::python::WrapperCollection &wrappers, std::string const &name, bool isBase=false)
Declare member and static functions for a given instantiation of lsst::afw::table::ColumnViewT<Record...
Definition: columnView.h:52
lsst::afw
Definition: imageAlgorithm.dox:1
BaseColumnView.h
lsst::afw::table::BaseColumnView
Column-wise view into a sequence of records that have been allocated contiguously.
Definition: BaseColumnView.h:83
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::table::python::PyColumnView
pybind11::class_< ColumnViewT< Record >, std::shared_ptr< ColumnViewT< Record > >, BaseColumnView > PyColumnView
Definition: columnView.h:39
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)
Add a type (class or enum) wrapper, deferring method and other attribute definitions until finish() i...
Definition: python.h:391
std::string::c_str
T c_str(T... args)
lsst::utils::python::WrapperCollection
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
lsst::utils::python::WrapperCollection::module
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition: python.h:448