LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
flagHandler.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2017 AURA/LSST.
4  *
5  * This product includes software developed by the
6  * LSST Project (http://www.lsst.org/).
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the LSST License Statement and
19  * the GNU General Public License along with this program. If not,
20  * see <https://www.lsstcorp.org/LegalNotices/>.
21  */
22 
23 #include "pybind11/pybind11.h"
24 #include "pybind11/stl.h"
25 
26 #include <memory>
27 
28 #include "lsst/utils/python.h"
30 
31 namespace py = pybind11;
32 using namespace pybind11::literals;
33 
34 namespace lsst {
35 namespace meas {
36 namespace base {
37 
38 namespace {
39 
40 void declareFlagDefinition(py::module &mod) {
41  py::class_<FlagDefinition, std::shared_ptr<FlagDefinition>> cls(mod, "FlagDefinition");
42 
43  cls.def(py::init<>());
44  cls.def(py::init<std::string, std::string, std::size_t>(), "name"_a, "doc"_a,
45  "number"_a = FlagDefinition::number_undefined);
46 
47  cls.def_readwrite("name", &FlagDefinition::name);
48  cls.def_readwrite("doc", &FlagDefinition::doc);
49  cls.def_readwrite("number", &FlagDefinition::number);
50 
51  cls.def("__eq__", &FlagDefinition::operator==, py::is_operator());
52  cls.def("__ne__", &FlagDefinition::operator!=, py::is_operator());
53 }
54 
55 void declareFlagDefinitionList(py::module &mod) {
56  py::class_<FlagDefinitionList, std::shared_ptr<FlagDefinitionList>> cls(mod, "FlagDefinitionList");
57 
58  cls.def(py::init<>());
60 
61  cls.def("__getitem__", [](FlagDefinitionList const &self, int i) {
62  try {
63  auto cind = utils::python::cppIndex(self.size(), i);
64  return self[cind];
65  } catch (pex::exceptions::OutOfRangeError &err) {
66  // Python needs exception to be IndexError to generate __iter__; see DM-9715
67  PyErr_SetString(PyExc_IndexError, err.what());
68  throw py::error_already_set();
69  }
70  });
71  cls.def("__len__", &FlagDefinitionList::size);
72 
73  cls.def("getEmptyList", &FlagDefinitionList::getEmptyList);
74  cls.def("getDefinition",
75  (FlagDefinition(FlagDefinitionList::*)(std::size_t) const) & FlagDefinitionList::getDefinition,
76  "index"_a);
77  cls.def("getDefinition",
78  (FlagDefinition(FlagDefinitionList::*)(std::string const &) const) &
79  FlagDefinitionList::getDefinition,
80  "name"_a);
81  cls.def("hasDefinition", &FlagDefinitionList::hasDefinition, "name"_a);
82  cls.def("addFailureFlag", &FlagDefinitionList::addFailureFlag, "doc"_a = "General Failure Flag");
83  cls.def("add", &FlagDefinitionList::add, "name"_a, "doc"_a);
84 }
85 
86 void declareFlagHandler(py::module &mod) {
87  py::class_<FlagHandler, std::shared_ptr<FlagHandler>> cls(mod, "FlagHandler");
88 
89  cls.def(py::init<>());
90  cls.def(py::init<afw::table::SubSchema const &, FlagDefinitionList const &, FlagDefinitionList const &>(),
91  "s"_a, "flagDefs"_a, "exclDefs"_a = FlagDefinitionList::getEmptyList());
92 
93  cls.def_static("getFailureFlagName", &FlagHandler::getFailureFlagName);
94  cls.def_static("addFields", &FlagHandler::addFields, "schema"_a, "prefix"_a, "flagDefs"_a,
95  "exclDefs"_a = FlagDefinitionList::getEmptyList());
96 
97  cls.def("getFlagNumber", &FlagHandler::getFlagNumber, "flagName"_a);
98  cls.def("getFlagName", &FlagHandler::getFlagName, "i"_a);
99  cls.def("getValue",
100  (bool (FlagHandler::*)(afw::table::BaseRecord const &, std::size_t) const) &
101  FlagHandler::getValue,
102  "record"_a, "i"_a);
103  cls.def("getValue",
104  (bool (FlagHandler::*)(afw::table::BaseRecord const &, std::string const &) const) &
105  FlagHandler::getValue,
106  "record"_a, "flagName"_a);
107  cls.def("setValue",
108  (void (FlagHandler::*)(afw::table::BaseRecord &, std::size_t, bool) const) &
109  FlagHandler::setValue,
110  "record"_a, "i"_a, "value"_a);
111  cls.def("setValue",
112  (void (FlagHandler::*)(afw::table::BaseRecord &, std::string const &, bool) const) &
113  FlagHandler::setValue,
114  "record"_a, "flagName"_a, "value"_a);
115  cls.def("getFailureFlagNumber", &FlagHandler::getFailureFlagNumber);
116  cls.def("handleFailure", &FlagHandler::handleFailure, "record"_a, "error"_a = nullptr);
117 }
118 
119 } // namespace
120 
121 PYBIND11_MODULE(flagHandler, mod) {
122  py::module::import("lsst.afw.table");
123 
124  declareFlagDefinition(mod);
125  declareFlagDefinitionList(mod);
126  declareFlagHandler(mod);
127 }
128 
129 } // namespace base
130 } // namespace meas
131 } // namespace lsst
std::string
STL class.
python.h
lsst::utils::python::cppIndex
std::size_t cppIndex(std::ptrdiff_t size, std::ptrdiff_t i)
Compute a C++ index from a Python index (negative values count from the end) and range-check.
Definition: python.h:124
lsst::afw::geom.transform.transformContinued.name
string name
Definition: transformContinued.py:32
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
FlagHandler.h
pybind11
Definition: _GenericMap.cc:40
std::size_t
lsst::utils.tests.init
def init()
Definition: tests.py:59
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42
lsst::meas::base::PYBIND11_MODULE
PYBIND11_MODULE(flagHandler, mod)
Definition: flagHandler.cc:121
std::initializer_list