LSST Applications g0b6bd0c080+a72a5dd7e6,g1182afd7b4+2a019aa3bb,g17e5ecfddb+2b8207f7de,g1d67935e3f+06cf436103,g38293774b4+ac198e9f13,g396055baef+6a2097e274,g3b44f30a73+6611e0205b,g480783c3b1+98f8679e14,g48ccf36440+89c08d0516,g4b93dc025c+98f8679e14,g5c4744a4d9+a302e8c7f0,g613e996a0d+e1c447f2e0,g6c8d09e9e7+25247a063c,g7271f0639c+98f8679e14,g7a9cd813b8+124095ede6,g9d27549199+a302e8c7f0,ga1cf026fa3+ac198e9f13,ga32aa97882+7403ac30ac,ga786bb30fb+7a139211af,gaa63f70f4e+9994eb9896,gabf319e997+ade567573c,gba47b54d5d+94dc90c3ea,gbec6a3398f+06cf436103,gc6308e37c7+07dd123edb,gc655b1545f+ade567573c,gcc9029db3c+ab229f5caf,gd01420fc67+06cf436103,gd877ba84e5+06cf436103,gdb4cecd868+6f279b5b48,ge2d134c3d5+cc4dbb2e3f,ge448b5faa6+86d1ceac1d,gecc7e12556+98f8679e14,gf3ee170dca+25247a063c,gf4ac96e456+ade567573c,gf9f5ea5b4d+ac198e9f13,gff490e6085+8c2580be5c,w.2022.27
LSST Data Management Base Package
Span.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_Span_h_INCLUDED
25#define LSST_AFW_GEOM_Span_h_INCLUDED
26
27#include <string>
28#include <iostream>
29
30#include "lsst/base.h"
32#include "lsst/geom.h"
34
35namespace lsst {
36namespace afw {
37
38namespace detection {
39class Footprint;
40} // namespace detection
41
42namespace geom {
43
47class Span final {
48public:
51
53
54 Span(int y,
55 int x0,
56 int x1)
57 : _y(y), _x0(x0), _x1(x1) {}
58
59 Span(Interval const & x, int y) : _y(y), _x0(x.getMin()), _x1(x.getMax()) {}
60
62 Span() noexcept : _y(0), _x0(0), _x1(-1) {}
63
64 Span(Span const&) noexcept = default;
65 Span(Span&&) noexcept = default;
66 Span& operator=(Span const&) noexcept = default;
67 Span& operator=(Span&&) noexcept = default;
68 ~Span() noexcept = default;
69
71 Iterator begin() const noexcept { return Iterator(lsst::geom::Point2I(_x0, _y)); }
72
74 Iterator end() const noexcept { return Iterator(lsst::geom::Point2I(_x1 + 1, _y)); }
75
76 int getX0() const noexcept { return _x0; }
77 int& getX0() noexcept { return _x0; }
78 int getX1() const noexcept { return _x1; }
79 int& getX1() noexcept { return _x1; }
80 Interval getX() const noexcept { return Interval::fromMinMax(_x0, _x1); }
81 int getY() const noexcept { return _y; }
82 int& getY() noexcept { return _y; }
83 int getWidth() const noexcept { return _x1 - _x0 + 1; }
84 int getMinX() const noexcept { return _x0; }
85 int getMaxX() const noexcept { return _x1; }
86 int getBeginX() const noexcept { return _x0; }
87 int getEndX() const noexcept { return _x1 + 1; }
88 lsst::geom::Point2I const getMin() const noexcept {
89 return lsst::geom::Point2I(_x0, _y);
90 }
91 lsst::geom::Point2I const getMax() const noexcept {
92 return lsst::geom::Point2I(_x1, _y);
93 }
94
95 bool contains(int x) const noexcept { return (x >= _x0) && (x <= _x1); }
96 bool contains(int x, int y) const noexcept { return (x >= _x0) && (x <= _x1) && (y == _y); }
97 bool contains(lsst::geom::Point2I const& point) const noexcept {
98 return contains(point.getX(), point.getY());
99 }
100
102 bool isEmpty() const noexcept { return _x1 < _x0; }
103
105 std::string toString() const;
106
107 void shift(int dx, int dy) noexcept {
108 _x0 += dx;
109 _x1 += dx;
110 _y += dy;
111 }
112
114 friend std::ostream& operator<<(std::ostream& os, Span const& span) { return os << span.toString(); }
115
116 bool operator==(Span const& other) const noexcept {
117 return other.getY() == getY() && other.getMinX() == getMinX() && other.getMaxX() == getMaxX();
118 }
119 bool operator!=(Span const& other) const noexcept { return !(*this == other); }
120
122 std::size_t hash_value() const noexcept {
123 // Completely arbitrary seed
124 return utils::hashCombine(42, getY(), getMinX(), getMaxX());
125 }
126
127 /* Required to make Span "LessThanComparable" so they can be used
128 * in sorting, binary search, etc.
129 * http://www.sgi.com/tech/stl/LessThanComparable.html
130 */
131 bool operator<(const Span& b) const noexcept;
132
134
135private:
136 int _y;
137 int _x0;
138 int _x1;
139};
140} // namespace geom
141} // namespace afw
142} // namespace lsst
143
144namespace std {
145template <>
146struct hash<lsst::afw::geom::Span> {
149 result_type operator()(argument_type const& obj) const noexcept { return obj.hash_value(); }
150};
151} // namespace std
152
153#endif // LSST_AFW_GEOM_Span_h_INCLUDED
double x
std::ostream * os
Definition: Schema.cc:557
int y
Definition: SpanSet.cc:48
table::Key< int > b
Basic LSST definitions.
Class to describe the properties of a detected object from an image.
Definition: Footprint.h:63
A range of pixels within one row of an Image.
Definition: Span.h:47
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
bool operator==(Span const &other) const noexcept
Definition: Span.h:116
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
Span() noexcept
Construct an empty Span with zero width at the origin.
Definition: Span.h:62
int & getX0() noexcept
Return the starting x-value.
Definition: Span.h:77
Span(Span &&) noexcept=default
bool operator!=(Span const &other) const noexcept
Definition: Span.h:119
int getEndX() const noexcept
End (exclusive) x-value.
Definition: Span.h:87
int & getY() noexcept
Return the y-value.
Definition: Span.h:82
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition: Span.h:122
Span(int y, int x0, int x1)
Definition: Span.h:54
Iterator begin() const noexcept
Return an iterator to the first pixel in the Span.
Definition: Span.h:71
Interval getX() const noexcept
Definition: Span.h:80
bool contains(int x) const noexcept
Definition: Span.h:95
bool operator<(const Span &b) const noexcept
Definition: Span.cc:32
std::string toString() const
Return a string-representation of a Span.
Definition: Span.cc:43
int getY() const noexcept
Return the y-value.
Definition: Span.h:81
int getX0() const noexcept
Return the starting x-value.
Definition: Span.h:76
bool contains(int x, int y) const noexcept
Definition: Span.h:96
bool contains(lsst::geom::Point2I const &point) const noexcept
Definition: Span.h:97
Iterator end() const noexcept
Return an iterator to one past the last pixel in the Span.
Definition: Span.h:74
int getWidth() const noexcept
Return the number of pixels.
Definition: Span.h:83
Span(Span const &) noexcept=default
void shift(int dx, int dy) noexcept
Definition: Span.h:107
Span(Interval const &x, int y)
Definition: Span.h:59
int getX1() const noexcept
Return the ending x-value.
Definition: Span.h:78
int & getX1() noexcept
Return the ending x-value.
Definition: Span.h:79
friend std::ostream & operator<<(std::ostream &os, Span const &span)
Stream output; delegates to toString().
Definition: Span.h:114
An iterator that yields lsst::geom::Point2I and increases in the x direction.
A 1-d integer coordinate range.
Definition: Interval.h:50
static IntervalI fromMinMax(Element min, Element max)
Construct an interval from its lower and upper bounds.
Definition: Interval.cc:53
lsst::afw::detection::Footprint Footprint
Definition: Source.h:57
std::size_t hashCombine(std::size_t seed) noexcept
Combine hashes.
Definition: hashCombine.h:35
Point< int, 2 > Point2I
Definition: Point.h:321
A base class for image defects.
STL namespace.
result_type operator()(argument_type const &obj) const noexcept
Definition: Span.h:149