lsst.afw  22.0.1-41-g501672927+21a6849c81
PixelRegion.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 /*
3  * LSST Data Management System
4  * Copyright 2008, 2009, 2010 LSST Corporation.
5  *
6  * This product includes software developed by the
7  * LSST Project (http://www.lsst.org/).
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the LSST License Statement and
20  * the GNU General Public License along with this program. If not,
21  * see <http://www.lsstcorp.org/LegalNotices/>.
22  */
23 
24 #ifndef LSST_AFW_GEOM_ELLIPSES_PixelRegion_h_INCLUDED
25 #define LSST_AFW_GEOM_ELLIPSES_PixelRegion_h_INCLUDED
26 
27 #include <vector>
28 
29 #include "lsst/geom/Box.h"
30 #include "lsst/afw/geom/Span.h"
32 
33 namespace lsst {
34 namespace afw {
35 namespace geom {
36 namespace ellipses {
37 
47 public:
48 
51 
53  explicit PixelRegion(Ellipse const& ellipse);
54 
56  PixelRegion(PixelRegion const&) = default;
58  PixelRegion(PixelRegion&&) = default;
59  PixelRegion& operator=(PixelRegion const&) = default;
61  ~PixelRegion() = default;
63 
65 
68  Iterator begin() const { return _spans.begin(); }
69  Iterator end() const { return _spans.end(); }
71 
80  lsst::geom::Box2I const& getBBox() const { return _bbox; }
81 
88  Span const getSpanAt(int y) const;
89 
90 private:
91  std::vector<Span> _spans;
92  lsst::geom::Box2I _bbox;
93 };
94 
95 } // namespace ellipses
96 } // namespace geom
97 } // namespace afw
98 } // namespace lsst
99 
100 #endif // !LSST_AFW_GEOM_ELLIPSES_PixelRegion_h_INCLUDED
int y
Definition: SpanSet.cc:48
A range of pixels within one row of an Image.
Definition: Span.h:47
An ellipse defined by an arbitrary BaseCore and a center point.
Definition: Ellipse.h:51
A pixelized region containing all pixels whose centers are within an Ellipse.
Definition: PixelRegion.h:46
PixelRegion(PixelRegion &&)=default
lsst::geom::Box2I const & getBBox() const
Return the bounding box of the pixel region.
Definition: PixelRegion.h:80
Iterator begin() const
Iterator range over Spans whose pixels are within the Ellipse.
Definition: PixelRegion.h:68
PixelRegion & operator=(PixelRegion &&)=default
PixelRegion(Ellipse const &ellipse)
Construct a PixelRegion from an Ellipse.
Definition: PixelRegion.cc:100
std::vector< Span >::const_iterator Iterator
Iterator type used by begin() and end().
Definition: PixelRegion.h:50
PixelRegion & operator=(PixelRegion const &)=default
Span const getSpanAt(int y) const
Return the span at the given y coordinate value.
Definition: PixelRegion.cc:132
class[[deprecated("Removed with no replacement (but see lsst::afw::image::TransmissionCurve). Will be " "removed after v22.")]] FilterProperty final
Describe the properties of a Filter (e.g.
Definition: Filter.h:53
A base class for image defects.