LSSTApplications  20.0.0
LSSTDataManagementBasePackage
span.cc
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2008-2016 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 "lsst/afw/geom/Span.h"
28 
29 namespace py = pybind11;
30 
31 namespace lsst {
32 namespace afw {
33 namespace geom {
34 namespace {
35 
36 using PySpan = py::class_<Span, std::shared_ptr<Span>>;
37 
38 // A thin wrapper around SpanPixelIterator.
39 // Unfortunately we cannot use py::make_iterator here, as we normally
40 // should, because for some reason the return values then all refer
41 // to the last element.
42 class SpanIterator {
43 public:
44  SpanIterator(const Span &s) : _it{s.begin()}, _end{s.end()} {};
46  if (_it == _end) {
47  throw py::stop_iteration();
48  }
49  return *_it++;
50  };
51 
52 private:
53  Span::Iterator _it;
54  Span::Iterator _end;
55 };
56 
57 static void declareSpanIterator(py::module &mod) {
58  py::class_<SpanIterator> cls(mod, "SpanIterator");
59  cls.def("__iter__", [](SpanIterator &it) -> SpanIterator & { return it; });
60  cls.def("__next__", &SpanIterator::next);
61 }
62 
63 PYBIND11_MODULE(span, mod) {
64  py::module::import("lsst.geom");
65 
66  declareSpanIterator(mod);
67 
68  PySpan cls(mod, "Span");
69  cls.def(py::init<int, int, int>());
70  cls.def(py::init<>());
71  cls.def("__eq__", &Span::operator==, py::is_operator());
72  cls.def("__ne__", &Span::operator!=, py::is_operator());
73  cls.def("__lt__", &Span::operator<, py::is_operator());
74  cls.def("__len__", &Span::getWidth);
75  cls.def("__str__", &Span::toString);
76  // unlike most iterators, SpanPixelIterator doesn't actually refer
77  // back to its container (the Span), and there's no need to keep the
78  // Span alive for the lifetime of the iterator.
79  cls.def("__iter__", [](const Span &s) { return SpanIterator(s); });
80  cls.def("getX0", (int (Span::*)() const) & Span::getX0);
81  cls.def("getX1", (int (Span::*)() const) & Span::getX1);
82  cls.def("getY", (int (Span::*)() const) & Span::getY);
83  cls.def("getWidth", &Span::getWidth);
84  cls.def("getMinX", &Span::getMinX);
85  cls.def("getMaxX", &Span::getMaxX);
86  cls.def("getBeginX", &Span::getBeginX);
87  cls.def("getEndX", &Span::getEndX);
88  cls.def("getMin", &Span::getMin);
89  cls.def("getMax", &Span::getMax);
90  cls.def("contains", (bool (Span::*)(int) const) & Span::contains);
91  cls.def("contains", (bool (Span::*)(int, int) const) & Span::contains);
92  cls.def("contains", (bool (Span::*)(lsst::geom::Point2I const &) const) & Span::contains);
93  cls.def("isEmpty", &Span::isEmpty);
94  cls.def("toString", &Span::toString);
95  cls.def("shift", &Span::shift);
96 }
97 }
98 }
99 }
100 } // namespace lsst::afw::geom::<anonymous>
lsst::afw::geom::Span::Iterator
SpanPixelIterator Iterator
An iterator over points in the Span.
Definition: Span.h:50
astshim.fitsChanContinued.next
def next(self)
Definition: fitsChanContinued.py:105
lsst::afw::geom::Span::getX1
int getX1() const noexcept
Return the ending x-value.
Definition: Span.h:74
lsst::afw::geom::PYBIND11_MODULE
PYBIND11_MODULE(spanSet, mod)
Definition: spanSet.cc:195
lsst::afw
Definition: imageAlgorithm.dox:1
lsst::afw::geom::Span::getWidth
int getWidth() const noexcept
Return the number of pixels.
Definition: Span.h:78
lsst::afw::geom.transform.transformContinued.cls
cls
Definition: transformContinued.py:33
SpanPixelIterator.h
lsst::afw::geom::Span::toString
std::string toString() const
Return a string-representation of a Span.
Definition: Span.cc:43
lsst::afw::geom::Span::getY
int getY() const noexcept
Return the y-value.
Definition: Span.h:76
lsst::afw::geom::Span::getEndX
int getEndX() const noexcept
End (exclusive) x-value.
Definition: Span.h:82
Span.h
lsst::afw::geom::Span::contains
bool contains(int x) const noexcept
Definition: Span.h:90
lsst::afw::geom::Span::isEmpty
bool isEmpty() const noexcept
Return true if the span contains no pixels.
Definition: Span.h:97
lsst::afw::geom::Span::getMinX
int getMinX() const noexcept
Minimum x-value.
Definition: Span.h:79
lsst::afw::geom::Span::getMax
lsst::geom::Point2I const getMax() const noexcept
Point corresponding to maximum x.
Definition: Span.h:86
lsst::afw::geom::Span::getMaxX
int getMaxX() const noexcept
Maximum x-value.
Definition: Span.h:80
lsst
A base class for image defects.
Definition: imageAlgorithm.dox:1
lsst::afw::geom::Span::getX0
int getX0() const noexcept
Return the starting x-value.
Definition: Span.h:72
lsst::geom
Definition: geomOperators.dox:4
lsst::geom::Point< int, 2 >
lsst::afw::geom::Span::getBeginX
int getBeginX() const noexcept
Begin (inclusive) x-value.
Definition: Span.h:81
lsst::afw::geom::Span::shift
void shift(int dx, int dy) noexcept
Definition: Span.h:102
pybind11
Definition: _GenericMap.cc:40
lsst::afw::geom::Span::getMin
lsst::geom::Point2I const getMin() const noexcept
Point corresponding to minimum x.
Definition: Span.h:83
lsst::meas::modelfit.psf.psfContinued.module
module
Definition: psfContinued.py:42