LSSTApplications  20.0.0
LSSTDataManagementBasePackage
_schemaMapper.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 "lsst/utils/python.h"
28 
29 #include "lsst/afw/table/Field.h"
30 #include "lsst/afw/table/Key.h"
31 #include "lsst/afw/table/Schema.h"
34 
35 namespace py = pybind11;
36 using namespace pybind11::literals;
37 
38 namespace lsst {
39 namespace afw {
40 namespace table {
41 
42 using utils::python::WrapperCollection;
43 using PySchemaMapper = py::class_<SchemaMapper, std::shared_ptr<SchemaMapper>>;
44 
45 namespace {
46 
47 template <typename T>
48 void declareSchemaMapperOverloads(PySchemaMapper &cls, std::string const &suffix) {
49  cls.def("getMapping", (Key<T>(SchemaMapper::*)(Key<T> const &) const) & SchemaMapper::getMapping);
50  cls.def("isMapped", (bool (SchemaMapper::*)(Key<T> const &) const) & SchemaMapper::isMapped);
51 };
52 
53 } // namespace
54 
56  wrappers.wrapType(PySchemaMapper(wrappers.module, "SchemaMapper"), [](auto &mod, auto &cls) {
57  cls.def(py::init<>());
58  cls.def(py::init<Schema const &, Schema const &>());
59  cls.def(py::init<Schema const &, bool>(), "input"_a, "shareAliasMap"_a = false);
60 
61  cls.def("getInputSchema", &SchemaMapper::getInputSchema);
62  cls.def("getOutputSchema", &SchemaMapper::getOutputSchema);
63  cls.def("editOutputSchema", &SchemaMapper::editOutputSchema,
64  py::return_value_policy::reference_internal);
65  cls.def("addMinimalSchema", &SchemaMapper::addMinimalSchema, "minimal"_a, "doMap"_a = true);
66  cls.def_static("removeMinimalSchema", &SchemaMapper::removeMinimalSchema);
67  cls.def_static("join", &SchemaMapper::join, "inputs"_a, "prefixes"_a = std::vector<std::string>());
68 
69  declareSchemaMapperOverloads<std::uint8_t>(cls, "B");
70  declareSchemaMapperOverloads<std::uint16_t>(cls, "U");
71  declareSchemaMapperOverloads<std::int32_t>(cls, "I");
72  declareSchemaMapperOverloads<std::int64_t>(cls, "L");
73  declareSchemaMapperOverloads<float>(cls, "F");
74  declareSchemaMapperOverloads<double>(cls, "D");
75  declareSchemaMapperOverloads<std::string>(cls, "String");
76  declareSchemaMapperOverloads<lsst::geom::Angle>(cls, "Angle");
77  declareSchemaMapperOverloads<lsst::afw::table::Flag>(cls, "Flag");
78  declareSchemaMapperOverloads<lsst::afw::table::Array<std::uint8_t>>(cls, "ArrayB");
79  declareSchemaMapperOverloads<lsst::afw::table::Array<std::uint16_t>>(cls, "ArrayU");
80  declareSchemaMapperOverloads<lsst::afw::table::Array<int>>(cls, "ArrayI");
81  declareSchemaMapperOverloads<lsst::afw::table::Array<float>>(cls, "ArrayF");
82  declareSchemaMapperOverloads<lsst::afw::table::Array<double>>(cls, "ArrayD");
83  });
84 }
85 
86 } // namespace table
87 } // namespace afw
88 } // namespace lsst
SchemaMapper.h
Field.h
std::string
STL class.
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::table::PySchemaMapper
py::class_< SchemaMapper, std::shared_ptr< SchemaMapper > > PySchemaMapper
Definition: _schemaMapper.cc:43
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
lsst::afw::table::SchemaMapper
A mapping between the keys of two Schemas, used to copy data between them.
Definition: SchemaMapper.h:21
lsst::afw::table::Key
A class used as a handle to a particular field in a table.
Definition: fwd.h:45
lsst::utils::python::WrapperCollection
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition: python.h:242
lsst::afw::table::wrapSchemaMapper
void wrapSchemaMapper(WrapperCollection &wrappers)
Definition: _schemaMapper.cc:55
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
python.h
Key.h
SchemaImpl.h
pybind11
Definition: _GenericMap.cc:40
Schema.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