LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
_span.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#include "pybind11/numpy.h"
27#include <lsst/utils/python.h>
28
29#include "lsst/afw/geom/Span.h"
31
32namespace py = pybind11;
33using namespace pybind11::literals;
34
35namespace lsst {
36namespace afw {
37namespace geom {
38namespace {
39
40using PySpan = py::class_<Span, std::shared_ptr<Span>>;
41
42// A thin wrapper around SpanPixelIterator.
43// Unfortunately we cannot use py::make_iterator here, as we normally
44// should, because for some reason the return values then all refer
45// to the last element.
46class SpanIterator {
47public:
48 SpanIterator(const Span &s) : _it{s.begin()}, _end{s.end()} {};
50 if (_it == _end) {
51 throw py::stop_iteration();
52 }
53 return *_it++;
54 };
55
56private:
58 Span::Iterator _end;
59};
60
61static void declareSpanIterator(lsst::utils::python::WrapperCollection &wrappers) {
62 wrappers.wrapType(py::class_<SpanIterator>(wrappers.module, "SpanIterator"), [](auto &mod, auto &cls) {
63 cls.def("__iter__", [](SpanIterator &it) -> SpanIterator & { return it; });
64 cls.def("__next__", &SpanIterator::next);
65 });
66}
67
68void declareSpan(lsst::utils::python::WrapperCollection &wrappers) {
69 wrappers.wrapType(PySpan(wrappers.module, "Span"), [](auto &mod, auto &cls) {
70 cls.def(py::init<int, int, int>());
71 cls.def(py::init<Span::Interval const &, int>());
72 cls.def(py::init<>());
73 cls.def("__eq__", &Span::operator==, py::is_operator());
74 cls.def("__ne__", &Span::operator!=, py::is_operator());
75 cls.def("__lt__", &Span::operator<, py::is_operator());
76 cls.def("__len__", &Span::getWidth);
77 cls.def("__str__", &Span::toString);
78 // unlike most iterators, SpanPixelIterator doesn't actually refer
79 // back to its container (the Span), and there's no need to keep the
80 // Span alive for the lifetime of the iterator.
81 cls.def("__iter__", [](const Span &s) { return SpanIterator(s); });
82 cls.def("getX0", (int (Span::*)() const) & Span::getX0);
83 cls.def("getX1", (int (Span::*)() const) & Span::getX1);
84 cls.def("getX", &Span::getX);
85 cls.def("getY", (int (Span::*)() const) & Span::getY);
86 cls.def("getWidth", &Span::getWidth);
87 cls.def("getMinX", &Span::getMinX);
88 cls.def("getMaxX", &Span::getMaxX);
89 cls.def("getBeginX", &Span::getBeginX);
90 cls.def("getEndX", &Span::getEndX);
91 cls.def("getMin", &Span::getMin);
92 cls.def("getMax", &Span::getMax);
93 cls.def("contains", (bool (Span::*)(int) const) & Span::contains);
94 cls.def("contains", py::vectorize((bool (Span::*)(int, int) const)&Span::contains), "x"_a, "y"_a);
95 cls.def("contains", (bool (Span::*)(lsst::geom::Point2I const &) const) & Span::contains);
96 cls.def("isEmpty", &Span::isEmpty);
97 cls.def("toString", &Span::toString);
98 cls.def("shift", &Span::shift);
99 });
100}
101} // namespace
102void wrapSpan(lsst::utils::python::WrapperCollection &wrappers) {
103 declareSpanIterator(wrappers);
104 declareSpan(wrappers);
105}
106} // namespace geom
107} // namespace afw
108} // namespace lsst
int end
T begin(T... args)
bool isEmpty() const noexcept
Return true if the span contains no pixels.
Definition Span.h:102
int getBeginX() const noexcept
Begin (inclusive) x-value.
Definition Span.h:86
int getMinX() const noexcept
Minimum x-value.
Definition Span.h:84
int getMaxX() const noexcept
Maximum x-value.
Definition Span.h:85
SpanPixelIterator Iterator
An iterator over points in the Span.
Definition Span.h:50
lsst::geom::Point2I const getMax() const noexcept
Point corresponding to maximum x.
Definition Span.h:91
lsst::geom::Point2I const getMin() const noexcept
Point corresponding to minimum x.
Definition Span.h:88
int getEndX() const noexcept
End (exclusive) x-value.
Definition Span.h:87
Interval getX() const noexcept
Definition Span.h:80
std::string toString() const
Return a string-representation of a Span.
Definition Span.cc:43
int getWidth() const noexcept
Return the number of pixels.
Definition Span.h:83
void shift(int dx, int dy) noexcept
Definition Span.h:107
void wrapSpan(lsst::utils::python::WrapperCollection &)
Definition _span.cc:102
Point< int, 2 > Point2I
Definition Point.h:321
T next(T... args)