LSST Applications g05325017a3+be04ab5bc8,g2079a07aa2+3e9fd84d81,g20cdd03214+600de29eb2,g2305ad1205+5e1b0c67c7,g2bbee38e9b+69e041a28d,g337abbeb29+69e041a28d,g3a166c0a6a+69e041a28d,g4322eb9e3a+9670871960,g4e26c3aaff+9125fe5495,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+608c162c81,g5c3423f6d4+600de29eb2,g607f77f49a+600de29eb2,g69c4c69b53+69e041a28d,g858d7b2824+600de29eb2,g99cad8db69+a7f8c65a2d,g9ddcbc5298+9a081db1e4,ga1e77700b3+2cbb763275,ga8d6e2f9c9+7a336fa28a,gae0086650b+585e252eca,gb0e22166c9+0e73c8378f,gb7c702c636+aec2f3b930,gbb8dafda3b+7d1409958d,gc120e1dc64+acd995d0d8,gc28159a63d+69e041a28d,gcdd4ae20e8+5ef4c697da,gcf0d15dbbd+5ef4c697da,gd1535ee943+1ef0950dc9,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+69e041a28d,gf905fbdb4b+471d9f2c03,gf907d663e3+01e3c6626b,gfbcc870c63+b310236976,w.2024.25
LSST Data Management Base Package
Loading...
Searching...
No Matches
Interval.h
Go to the documentation of this file.
1/*
2 * Developed for the LSST Data Management System.
3 * This product includes software developed by the LSST Project
4 * (https://www.lsst.org).
5 * See the COPYRIGHT file at the top-level directory of this distribution
6 * for details of code ownership.
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 GNU General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
20 */
21
22#ifndef LSST_GEOM_INTERVAL_H
23#define LSST_GEOM_INTERVAL_H
24
25#include <vector>
26
27#include "ndarray.h"
28
29#include "lsst/geom/Point.h"
30#include "lsst/geom/Extent.h"
31
32namespace lsst {
33namespace geom {
34
35class IntervalD;
36
50class IntervalI final {
51public:
52 using Element = int;
53
64 enum class EdgeHandlingEnum {
68 EXPAND,
73 SHRINK
74 };
75
77 IntervalI() noexcept : _min(0), _size(0) {}
78
91 template <typename Iter>
92 static IntervalI fromSpannedPoints(Iter first, Iter last) {
94 for (auto i = first; i != last; ++i) {
96 }
97 return result;
98 }
99
101
113 return fromSpannedPoints(elements.begin(), elements.end());
114 }
115 static IntervalI fromSpannedPoints(ndarray::Array<Element const, 1> const& elements) {
116 return fromSpannedPoints(elements.begin(), elements.end());
117 }
119
132
144
156
175 static IntervalI fromCenterSize(double center, Element size);
176
199 explicit IntervalI(IntervalD const& other, EdgeHandlingEnum edgeHandling = EdgeHandlingEnum::EXPAND);
200
202 IntervalI(IntervalI const&) noexcept = default;
203
205 IntervalI(IntervalI&&) noexcept = default;
206
207 ~IntervalI() noexcept = default;
208
209 void swap(IntervalI& other) noexcept {
210 using std::swap;
211 swap(_size, other._size);
212 swap(_min, other._min);
213 }
214
216 IntervalI& operator=(IntervalI const&) noexcept = default;
217
219 IntervalI& operator=(IntervalI&&) noexcept = default;
220
227 Element getMin() const noexcept { return _min; }
228 Element getMax() const noexcept { return _min + _size - 1; }
230
238 Element getBegin() const noexcept { return _min; }
239 Element getEnd() const noexcept { return _min + _size; }
241
247 Element getSize() const noexcept { return _size; }
248
259 ndarray::View<boost::fusion::vector1<ndarray::index::Range> > getSlice() const;
260
262 bool isEmpty() const noexcept { return _size == 0; }
263
265 bool contains(Element point) const noexcept;
266
274 bool contains(IntervalI const& other) const noexcept;
275
277
282 bool overlaps(IntervalI const& other) const noexcept;
283 bool intersects(IntervalI const& other) const noexcept { return overlaps(other); }
285
289 bool isDisjointFrom(IntervalI const& other) const noexcept;
290
302 IntervalI dilatedBy(Element buffer) const;
303
315 IntervalI erodedBy(Element buffer) const { return dilatedBy(-buffer); }
316
323 IntervalI shiftedBy(Element offset) const;
324
330 IntervalI reflectedAbout(Element point) const;
331
333
341 IntervalI expandedTo(Element other) const;
342 IntervalI expandedTo(IntervalI const& other) const;
344
352 IntervalI clippedTo(IntervalI const& other) const noexcept;
353
359 bool operator==(IntervalI const& other) const noexcept;
360
366 bool operator!=(IntervalI const& other) const noexcept;
367
369 std::size_t hash_value() const noexcept;
370
371 std::string toString() const;
372
373private:
374 template <typename T>
375 static IntervalI _fromMinMaxChecked(T min, T max);
376
378
379 /*
380 * IntervalI internally stores its minimum point and size, because we
381 * expect these will be the most commonly accessed quantities.
382 *
383 * We set the minimum point to the origin for an empty interval, and
384 * use -1 for the maximum point in that case, but this is an internal
385 * detail - all the API guarantees is that for an empty interval,
386 * size == 0.
387 */
388
389 Element _min;
390 Element _size;
391};
392
413class IntervalD final {
414public:
415 using Element = double;
416
418 IntervalD() noexcept;
419
433 template <typename Iter>
434 static IntervalD fromSpannedPoints(Iter first, Iter last) {
436 for (auto i = first; i != last; ++i) {
438 }
439 return result;
440 }
441
443
455 return fromSpannedPoints(elements.begin(), elements.end());
456 }
457 static IntervalD fromSpannedPoints(ndarray::Array<Element const, 1> const& elements) {
458 return fromSpannedPoints(elements.begin(), elements.end());
459 }
461
479
493
507
520 static IntervalD fromCenterSize(double center, Element size);
521
531 explicit IntervalD(IntervalI const& other) noexcept;
532
534 IntervalD(IntervalD const&) noexcept = default;
535
537 IntervalD(IntervalD&&) noexcept = default;
538
539 ~IntervalD() noexcept = default;
540
541 void swap(IntervalD& other) noexcept {
542 std::swap(_min, other._min);
543 std::swap(_max, other._max);
544 }
545
547 IntervalD& operator=(IntervalD const&) noexcept = default;
548
550 IntervalD& operator=(IntervalD&&) noexcept = default;
551
559 Element getMin() const noexcept { return _min; }
560 Element getMax() const noexcept { return _max; }
562
569 Element getSize() const noexcept;
570
576 Element getCenter() const noexcept;
577
579 bool isEmpty() const noexcept { return std::isnan(_min); }
580
582 bool isFinite() const noexcept { return std::isfinite(getSize()); }
583
590 bool contains(Element point) const;
591
599 bool contains(IntervalD const& other) const noexcept;
600
602
607 bool overlaps(IntervalD const& other) const noexcept;
608 bool intersects(IntervalD const& other) const noexcept { return overlaps(other); }
610
614 bool isDisjointFrom(IntervalD const& other) const noexcept;
615
631 IntervalD dilatedBy(Element buffer) const;
632
648 IntervalD erodedBy(Element buffer) const { return dilatedBy(-buffer); }
649
660 IntervalD shiftedBy(Element offset) const;
661
672 IntervalD reflectedAbout(Element point) const;
673
683 IntervalD expandedTo(Element other) const;
684
693 IntervalD expandedTo(IntervalD const& other) const noexcept;
694
702 IntervalD clippedTo(IntervalD const& other) const noexcept;
703
709 bool operator==(IntervalD const& other) const noexcept;
710
716 bool operator!=(IntervalD const& other) const noexcept;
717
719 std::size_t hash_value() const noexcept;
720
721 std::string toString() const;
722
723private:
725
726 Element _min;
727 Element _max;
728};
729
730std::ostream& operator<<(std::ostream& os, IntervalI const& interval);
731
732std::ostream& operator<<(std::ostream& os, IntervalD const& interval);
733
734inline void swap(IntervalI& a, IntervalI& b) noexcept { a.swap(b); }
735
736inline void swap(IntervalD& a, IntervalD& b) noexcept { a.swap(b); }
737
738} // namespace geom
739} // namespace lsst
740
741namespace std {
742
743template <>
744inline void swap<lsst::geom::IntervalI>(lsst::geom::IntervalI& a, lsst::geom::IntervalI& b) noexcept {
745 a.swap(b);
746}
747
748template <>
749inline void swap<lsst::geom::IntervalD>(lsst::geom::IntervalD& a, lsst::geom::IntervalD& b) noexcept {
750 a.swap(b);
751}
752
753template <>
757 size_t operator()(argument_type const& x) const noexcept { return x.hash_value(); }
758};
759
760template <>
764 size_t operator()(argument_type const& x) const noexcept { return x.hash_value(); }
765};
766
767} // namespace std
768
769#endif
py::object result
Definition _schema.cc:429
int min
int max
table::Key< int > b
T begin(T... args)
A floating-point coordinate rectangle geometry.
Definition Interval.h:413
bool isFinite() const noexcept
Return true if the interval's size is finite.
Definition Interval.h:582
IntervalD(IntervalD &&) noexcept=default
Standard move constructor.
IntervalD erodedBy(Element buffer) const
Decrease the size of the interval by the given amount in both directions (returning a new object).
Definition Interval.h:648
Element getMax() const noexcept
Return the size of the interval.
Definition Interval.h:560
bool intersects(IntervalD const &other) const noexcept
Return the size of the interval.
Definition Interval.h:608
IntervalD(IntervalD const &) noexcept=default
Standard copy constructor.
IntervalD & operator=(IntervalD const &) noexcept=default
Standard copy assignment operator.
static IntervalD fromSpannedPoints(std::vector< Element > const &elements)
Construct an interval that contains all of the given points.
Definition Interval.h:454
IntervalD & operator=(IntervalD &&) noexcept=default
Standard move assignment operator.
IntervalD expandedTo(Element other) const
Expand an interval to ensure that contains(other) is true.
Definition Interval.cc:314
static IntervalD fromSpannedPoints(ndarray::Array< Element const, 1 > const &elements)
Definition Interval.h:457
A 1-d integer coordinate range.
Definition Interval.h:50
bool contains(Element point) const noexcept
Return true if the interval contains the point.
Definition Interval.cc:116
static IntervalI fromMinSize(Element min, Element size)
Construct an interval from its lower bound and size.
Definition Interval.cc:57
IntervalI & operator=(IntervalI const &) noexcept=default
Standard copy assignment operator.
static IntervalI fromSpannedPoints(ndarray::Array< Element const, 1 > const &elements)
Definition Interval.h:115
bool overlaps(IntervalI const &other) const noexcept
Return true if there are any points in both this and other.
Definition Interval.cc:128
static IntervalI fromSpannedPoints(std::vector< Element > const &elements)
Construct an interval that contains all of the given points.
Definition Interval.h:112
ndarray::View< boost::fusion::vector1< ndarray::index::Range > > getSlice() const
Return slice to extract the interval's region from an ndarray::Array.
Definition Interval.cc:112
void swap(IntervalI &other) noexcept
Definition Interval.h:209
static IntervalI fromSpannedPoints(Iter first, Iter last)
Construct an interval that contains all of the given points.
Definition Interval.h:92
IntervalI() noexcept
Construct an empty interval.
Definition Interval.h:77
IntervalI clippedTo(IntervalI const &other) const noexcept
Shrink an interval to ensure that it is contained by other (returning a new)
Definition Interval.cc:186
IntervalI erodedBy(Element buffer) const
Decrease the size of the interval by the given amount in both directions (returning a new object).
Definition Interval.h:315
IntervalI dilatedBy(Element buffer) const
Increase the size of the interval by the given amount in both directions (returning a new object).
Definition Interval.cc:137
bool isEmpty() const noexcept
Return true if the interval contains no points.
Definition Interval.h:262
IntervalI & operator=(IntervalI &&) noexcept=default
Standard move assignment operatior.
bool intersects(IntervalI const &other) const noexcept
Return slice to extract the interval's region from an ndarray::Array.
Definition Interval.h:283
IntervalI(IntervalI &&) noexcept=default
Standard move constructor.
bool isDisjointFrom(IntervalI const &other) const noexcept
Return true if there are no points in both this and other.
Definition Interval.cc:130
Element getMax() const noexcept
Definition Interval.h:228
IntervalI(IntervalI const &) noexcept=default
Standard copy constructor.
bool operator!=(IntervalI const &other) const noexcept
Compare two intervals for equality.
Definition Interval.cc:197
EdgeHandlingEnum
Enum used to indicate how to handle conversions from floating-point to integer intervals.
Definition Interval.h:64
@ SHRINK
Include only pixels that are wholly contained by the floating-point interval.
@ EXPAND
Include all pixels that overlap the floating-point interval at all.
bool operator==(IntervalI const &other) const noexcept
Compare two intervals for equality.
Definition Interval.cc:193
Element getSize() const noexcept
Return slice to extract the interval's region from an ndarray::Array.
Definition Interval.h:247
std::size_t hash_value() const noexcept
Return a hash of this object.
Definition Interval.cc:199
static IntervalI fromMaxSize(Element max, Element size)
Construct an interval from its upper bound and size.
Definition Interval.cc:66
Element getEnd() const noexcept
Definition Interval.h:239
std::string toString() const
Return slice to extract the interval's region from an ndarray::Array.
Definition Interval.cc:204
static IntervalI fromCenterSize(double center, Element size)
Create an interval centered as closely as possible on a particular point.
Definition Interval.cc:75
static IntervalI fromMinMax(Element min, Element max)
Construct an interval from its lower and upper bounds.
Definition Interval.cc:53
IntervalI shiftedBy(Element offset) const
Shift the position of the interval by the given offset (returning a new object).)
Definition Interval.cc:146
Element getBegin() const noexcept
Definition Interval.h:238
IntervalI expandedTo(Element other) const
Expand an interval to ensure that contains(other) is true (returning a new object).
Definition Interval.cc:166
Element getMin() const noexcept
Definition Interval.h:227
IntervalI reflectedAbout(Element point) const
Reflect an interval about a point (returning a new object).
Definition Interval.cc:157
T end(T... args)
T isfinite(T... args)
T isnan(T... args)
STL namespace.
size_t operator()(argument_type const &x) const noexcept
Definition Interval.h:764
size_t operator()(argument_type const &x) const noexcept
Definition Interval.h:757
T swap(T... args)