LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
ConvexPolygon.h
Go to the documentation of this file.
1/*
2 * This file is part of sphgeom.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (http://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 software is dual licensed under the GNU General Public License and also
11 * under a 3-clause BSD license. Recipients may choose which of these licenses
12 * to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
13 * respectively. If you choose the GPL option then the following text applies
14 * (but note that there is still no warranty even if you opt for BSD instead):
15 *
16 * This program is free software: you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation, either version 3 of the License, or
19 * (at your option) any later version.
20 *
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with this program. If not, see <http://www.gnu.org/licenses/>.
28 */
29
30#ifndef LSST_SPHGEOM_CONVEXPOLYGON_H_
31#define LSST_SPHGEOM_CONVEXPOLYGON_H_
32
36
37#include <iosfwd>
38#include <vector>
39#include <cstdint>
40
41#include "Region.h"
42#include "UnitVector3d.h"
43
44
45namespace lsst {
46namespace sphgeom {
47
65class ConvexPolygon : public Region {
66public:
67 static constexpr std::uint8_t TYPE_CODE = 'p';
68
74 return ConvexPolygon(points);
75 }
76
79 explicit ConvexPolygon(std::vector<UnitVector3d> const & points);
80
86 UnitVector3d const & v1,
87 UnitVector3d const & v2) :
88 _vertices{v0, v1, v2}
89 {}
90
97 UnitVector3d const & v1,
98 UnitVector3d const & v2,
99 UnitVector3d const & v3) :
100 _vertices{v0, v1, v2, v3}
101 {}
102
104 bool operator==(ConvexPolygon const & p) const;
105 bool operator!=(ConvexPolygon const & p) const { return !(*this == p); }
106
108 return _vertices;
109 }
110
114
115 // Region interface
118 }
119
120 bool isEmpty() const override;
121
122 Box getBoundingBox() const override;
123 Box3d getBoundingBox3d() const override;
124 Circle getBoundingCircle() const override;
125
129 bool contains(UnitVector3d const & v) const override;
130 bool contains(Region const & r) const;
132
133 using Region::contains;
134
138 bool isDisjointFrom(Region const & r) const;
140
144 bool intersects(Region const & r) const;
146
150 bool isWithin(Region const & r) const;
152
153 Relationship relate(Region const & r) const override {
154 // Dispatch on the type of r.
155 return invert(r.relate(*this));
156 }
157
158 Relationship relate(Box const &) const override;
159 Relationship relate(Circle const &) const override;
160 Relationship relate(ConvexPolygon const &) const override;
161 Relationship relate(Ellipse const &) const override;
162
163 TriState overlaps(Region const& other) const override {
164 return other.overlaps(*this);
165 }
166 TriState overlaps(Box const &) const override;
167 TriState overlaps(Circle const &) const override;
168 TriState overlaps(ConvexPolygon const &) const override;
169 TriState overlaps(Ellipse const &) const override;
170
171 std::vector<std::uint8_t> encode() const override;
172
176 return decode(s.data(), s.size());
177 }
178 static std::unique_ptr<ConvexPolygon> decode(std::uint8_t const * buffer, size_t n);
180
181private:
182 typedef std::vector<UnitVector3d>::const_iterator VertexIterator;
183
184 ConvexPolygon() : _vertices() {}
185
187};
188
189std::ostream & operator<<(std::ostream &, ConvexPolygon const &);
190
191}} // namespace lsst::sphgeom
192
193#endif // LSST_SPHGEOM_CONVEXPOLYGON_H_
This file defines an interface for spherical regions.
This file declares a class for representing unit vectors in ℝ³.
Box3d represents a box in ℝ³.
Definition Box3d.h:49
Box represents a rectangle in spherical coordinate space that contains its boundary.
Definition Box.h:62
Circle is a circular region on the unit sphere that contains its boundary.
Definition Circle.h:54
ConvexPolygon is a closed convex polygon on the unit sphere.
bool operator!=(ConvexPolygon const &p) const
static constexpr std::uint8_t TYPE_CODE
static std::unique_ptr< ConvexPolygon > decode(std::vector< std::uint8_t > const &s)
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2, UnitVector3d const &v3)
This constructor creates a quadrilateral with the given vertices.
Box3d getBoundingBox3d() const override
getBoundingBox3d returns a 3-dimensional bounding-box for this region.
std::vector< std::uint8_t > encode() const override
encode serializes this region into an opaque byte string.
bool intersects(Region const &r) const
UnitVector3d getCentroid() const
The centroid of a polygon is its center of mass projected onto S², assuming a uniform mass distributi...
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2)
This constructor creates a triangle with the given vertices.
bool contains(UnitVector3d const &v) const override
TriState overlaps(Region const &other) const override
bool isDisjointFrom(Region const &r) const
static ConvexPolygon convexHull(std::vector< UnitVector3d > const &points)
convexHull returns the convex hull of the given set of points if it exists and throws an exception ot...
Relationship relate(Region const &r) const override
Circle getBoundingCircle() const override
getBoundingCircle returns a bounding-circle for this region.
ConvexPolygon(std::vector< UnitVector3d > const &points)
This constructor creates a convex polygon that is the convex hull of the given set of points.
Box getBoundingBox() const override
getBoundingBox returns a bounding-box for this region.
std::unique_ptr< Region > clone() const override
clone returns a deep copy of this region.
bool isEmpty() const override
isEmpty returns true when a region does not contain any points.
bool operator==(ConvexPolygon const &p) const
Two convex polygons are equal iff they contain the same points.
std::vector< UnitVector3d > const & getVertices() const
bool isWithin(Region const &r) const
Ellipse is an elliptical region on the sphere.
Definition Ellipse.h:177
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition Region.h:89
virtual bool contains(UnitVector3d const &) const =0
contains tests whether the given unit vector is inside this region.
virtual TriState overlaps(Region const &other) const =0
Definition Region.cc:59
TriState represents a boolean value with additional unknown state.
Definition TriState.h:46
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
std::ostream & operator<<(std::ostream &, Angle const &)
Definition Angle.cc:41
Relationship invert(Relationship r)
Given the relationship between two sets A and B (i.e.
std::bitset< 3 > Relationship
Relationship describes how two sets are related.