LSST Applications g044012fb7c+304891ab8a,g04a91732dc+4e1b87f259,g07dc498a13+f701f15b83,g114c6a66ad+c7887c1284,g1409bbee79+f701f15b83,g1a7e361dbc+f701f15b83,g1fd858c14a+6ebd102b59,g35bb328faa+0eb18584fe,g3bd4b5ce2c+e83bf4edc8,g4e0f332c67+976ceb6bc8,g53246c7159+0eb18584fe,g5477a8d5ce+51234355ef,g60b5630c4e+c7887c1284,g623d845a50+c7887c1284,g6f0c2978f1+98123c34b6,g71fabbc107+c7887c1284,g75b6c65c88+ce466f4385,g78460c75b0+85633614c8,g786e29fd12+02b9b86fc9,g8852436030+cfe5cf5b7b,g89139ef638+f701f15b83,g9125e01d80+0eb18584fe,g95236ca021+d4f98599f0,g974caa22f6+0eb18584fe,g989de1cb63+f701f15b83,g9f33ca652e+b4908f5dcd,gaaedd4e678+f701f15b83,gabe3b4be73+543c3c03c9,gace736f484+07e57cea59,gb1101e3267+487fd1b06d,gb58c049af0+492386d360,gc99c83e5f0+a513197d39,gcf25f946ba+cfe5cf5b7b,gd0fa69b896+babbe6e5fe,gd6cbbdb0b4+3fef02d88a,gde0f65d7ad+e8379653a2,ge278dab8ac+ae64226a64,gfba249425e+0eb18584fe,w.2025.07
LSST Data Management Base Package
Loading...
Searching...
No Matches
_filterLabel.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
26#include <exception>
27
29
33
34using namespace std::string_literals;
35
36namespace py = pybind11;
37using namespace pybind11::literals;
38
39namespace lsst {
40namespace afw {
41namespace image {
42namespace {
43
44using PyFilterLabel = py::class_<FilterLabel, std::shared_ptr<FilterLabel>, typehandling::Storable>;
45
46// Macro to convert an exception without defining a global handler for it
47#define _DELEGATE_EXCEPTION(call, cpp_ex, py_ex) \
48 try { \
49 return call; \
50 } catch (cpp_ex const &e) { \
51 std::throw_with_nested(py_ex(e.what())); \
52 }
53
54void declareFilterLabel(lsst::cpputils::python::WrapperCollection &wrappers) {
55 // Include Python-only constructor in class doc, since it's what people should use
56 auto initDoc = R"delim(
57 Attributes
58 ----------
59 band : str, optional
60 The band associated with this label.
61 physical : str, optional
62 The physical filter associated with this label.
63 )delim";
64 wrappers.wrapType(PyFilterLabel(wrappers.module, "FilterLabel", initDoc), [](auto &mod, auto &cls) {
65 table::io::python::addPersistableMethods(cls);
66
67 cls.def_static("fromBandPhysical", &FilterLabel::fromBandPhysical, "band"_a, "physical"_a);
68 cls.def_static("fromBand", &FilterLabel::fromBand, "band"_a);
69 cls.def_static("fromPhysical", &FilterLabel::fromPhysical, "physical"_a);
70
71 // Keyword constructor
72 /* This is messy in C++, but it's hard to write a Python __init__ that delegates to a factory,
73 * and the pybind11 docs imply that this way is less prone to multiple-definition errors.
74 * In C++17, we should be able to replace py::object with std::optional<string>.
75 */
76 cls.def(py::init([](py::object band, py::object physical) {
77 try {
78 // Expand as we get more combinations of keywords
79 if (!band.is_none() && !physical.is_none()) {
80 return FilterLabel::fromBandPhysical(py::cast<std::string>(band),
81 py::cast<std::string>(physical));
82 } else if (!band.is_none()) {
83 return FilterLabel::fromBand(py::cast<std::string>(band));
84 } else if (!physical.is_none()) {
85 return FilterLabel::fromPhysical(py::cast<std::string>(physical));
86 } else {
87 throw py::value_error("Need at least one of band, physical");
88 }
89 } catch (py::cast_error const &e) {
90 // By default cast_error is wrapped as RuntimeError
91 std::throw_with_nested(py::type_error(e.what()));
92 }
93 }),
94 // TODO: use py::kw_only() in pybind11 2.6 or later (DM-27247)
95 "band"_a = py::none(), "physical"_a = py::none());
96
97 cls.def("hasBandLabel", &FilterLabel::hasBandLabel);
98 cls.def_property_readonly("bandLabel", [](FilterLabel const &label) {
99 _DELEGATE_EXCEPTION(label.getBandLabel(), pex::exceptions::LogicError, std::runtime_error);
100 });
101 cls.def("hasPhysicalLabel", &FilterLabel::hasPhysicalLabel);
102 cls.def_property_readonly("physicalLabel", [](FilterLabel const &label) {
103 _DELEGATE_EXCEPTION(label.getPhysicalLabel(), pex::exceptions::LogicError, std::runtime_error);
104 });
105 cls.def("__eq__", &FilterLabel::operator==, py::is_operator());
107 cls.def("__ne__", &FilterLabel::operator!=, py::is_operator());
108
109 cls.def("__repr__", &FilterLabel::toString);
110 // Neither __copy__ nor __deepcopy__ default to each other
111 cls.def("__copy__", [](const FilterLabel &obj) { return obj.cloneStorable(); });
112 cls.def("__deepcopy__", [](const FilterLabel &obj, py::dict &memo) { return obj.cloneStorable(); });
113 });
114}
115} // namespace
117 // import inheritance dependencies
118 wrappers.addInheritanceDependency("lsst.afw.typehandling");
119 declareFilterLabel(wrappers);
120 wrappers.wrap(
121 [](auto &mod) { mod.def("getDatabaseFilterLabel", &getDatabaseFilterLabel, "filterLabel"_a); });
122}
123} // namespace image
124} // namespace afw
125} // namespace lsst
#define _DELEGATE_EXCEPTION(call, cpp_ex, py_ex)
bool hasBandLabel() const noexcept
Return whether the filter label names a band.
bool hasPhysicalLabel() const noexcept
Return whether the filter label names a physical filter.
std::string toString() const override
Return a string representation of this object.
A helper class for subdividing pybind11 module across multiple translation units (i....
Definition python.h:242
void wrap(WrapperCallback function)
Add a set of wrappers without defining a class.
Definition python.h:369
void addInheritanceDependency(std::string const &name)
Indicate an external module that provides a base class for a subsequent addType call.
Definition python.h:343
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
pybind11::module module
The module object passed to the PYBIND11_MODULE block that contains this WrapperCollection.
Definition python.h:448
std::string getDatabaseFilterLabel(std::string const &filterLabel)
Remap special characters, etc.
void wrapFilterLabel(lsst::cpputils::python::WrapperCollection &wrappers)
void addHash(PyClass &cls)
Add __hash__ method implemented by std::hash.
Definition python.h:104