LSSTApplications  17.0+11,17.0+34,17.0+56,17.0+57,17.0+59,17.0+7,17.0-1-g377950a+33,17.0.1-1-g114240f+2,17.0.1-1-g4d4fbc4+28,17.0.1-1-g55520dc+49,17.0.1-1-g5f4ed7e+52,17.0.1-1-g6dd7d69+17,17.0.1-1-g8de6c91+11,17.0.1-1-gb9095d2+7,17.0.1-1-ge9fec5e+5,17.0.1-1-gf4e0155+55,17.0.1-1-gfc65f5f+50,17.0.1-1-gfc6fb1f+20,17.0.1-10-g87f9f3f+1,17.0.1-11-ge9de802+16,17.0.1-16-ga14f7d5c+4,17.0.1-17-gc79d625+1,17.0.1-17-gdae4c4a+8,17.0.1-2-g26618f5+29,17.0.1-2-g54f2ebc+9,17.0.1-2-gf403422+1,17.0.1-20-g2ca2f74+6,17.0.1-23-gf3eadeb7+1,17.0.1-3-g7e86b59+39,17.0.1-3-gb5ca14a,17.0.1-3-gd08d533+40,17.0.1-30-g596af8797,17.0.1-4-g59d126d+4,17.0.1-4-gc69c472+5,17.0.1-6-g5afd9b9+4,17.0.1-7-g35889ee+1,17.0.1-7-gc7c8782+18,17.0.1-9-gc4bbfb2+3,w.2019.22
LSSTDataManagementBasePackage
ConvexPolygon.h
Go to the documentation of this file.
1 /*
2  * LSST Data Management System
3  * Copyright 2014-2015 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 #ifndef LSST_SPHGEOM_CONVEXPOLYGON_H_
24 #define LSST_SPHGEOM_CONVEXPOLYGON_H_
25 
29 
30 #include <iosfwd>
31 #include <vector>
32 
33 #include "Region.h"
34 #include "UnitVector3d.h"
35 
36 
37 namespace lsst {
38 namespace sphgeom {
39 
57 class ConvexPolygon : public Region {
58 public:
59  static constexpr uint8_t TYPE_CODE = 'p';
60 
66  return ConvexPolygon(points);
67  }
68 
71  explicit ConvexPolygon(std::vector<UnitVector3d> const & points);
72 
78  UnitVector3d const & v1,
79  UnitVector3d const & v2) :
80  _vertices{v0, v1, v2}
81  {}
82 
89  UnitVector3d const & v1,
90  UnitVector3d const & v2,
91  UnitVector3d const & v3) :
92  _vertices{v0, v1, v2, v3}
93  {}
94 
96  bool operator==(ConvexPolygon const & p) const;
97  bool operator!=(ConvexPolygon const & p) const { return !(*this == p); }
98 
100  return _vertices;
101  }
102 
105  UnitVector3d getCentroid() const;
106 
107  // Region interface
108  std::unique_ptr<Region> clone() const override {
110  }
111 
112  Box getBoundingBox() const override;
113  Box3d getBoundingBox3d() const override;
114  Circle getBoundingCircle() const override;
115 
119  bool contains(UnitVector3d const & v) const override;
120  bool contains(Region const & r) const;
122 
126  bool isDisjointFrom(Region const & r) const;
128 
132  bool intersects(Region const & r) const;
134 
138  bool isWithin(Region const & r) const;
140 
141  Relationship relate(Region const & r) const override {
142  // Dispatch on the type of r.
143  return invert(r.relate(*this));
144  }
145 
146  Relationship relate(Box const &) const override;
147  Relationship relate(Circle const &) const override;
148  Relationship relate(ConvexPolygon const &) const override;
149  Relationship relate(Ellipse const &) const override;
150 
151  std::vector<uint8_t> encode() const override;
152 
156  return decode(s.data(), s.size());
157  }
158  static std::unique_ptr<ConvexPolygon> decode(uint8_t const * buffer, size_t n);
160 
161 private:
162  typedef std::vector<UnitVector3d>::const_iterator VertexIterator;
163 
164  ConvexPolygon() : _vertices() {}
165 
166  std::vector<UnitVector3d> _vertices;
167 };
168 
170 
171 }} // namespace lsst::sphgeom
172 
173 #endif // LSST_SPHGEOM_CONVEXPOLYGON_H_
bool isDisjointFrom(Region const &r) const
bool operator==(ConvexPolygon const &p) const
Two convex polygons are equal iff they contain the same points.
std::ostream & operator<<(std::ostream &, Angle const &)
Definition: Angle.cc:34
Relationship invert(Relationship r)
Given the relationship between two sets A and B (i.e.
Definition: Relationship.h:55
bool isWithin(Region const &r) const
Box represents a rectangle in spherical coordinate space that contains its boundary.
Definition: Box.h:54
UnitVector3d getCentroid() const
The centroid of a polygon is its center of mass projected onto S², assuming a uniform mass distributi...
Circle getBoundingCircle() const override
getBoundingCircle returns a bounding-circle for this region.
This file declares a class for representing unit vectors in ℝ³.
Ellipse is an elliptical region on the sphere.
Definition: Ellipse.h:169
bool intersects(Region const &r) const
Relationship relate(Region const &r) const override
T data(T... args)
A base class for image defects.
std::vector< UnitVector3d > const & getVertices() const
Definition: ConvexPolygon.h:99
This file defines an interface for spherical regions.
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...
Definition: ConvexPolygon.h:65
Region is a minimal interface for 2-dimensional regions on the unit sphere.
Definition: Region.h:79
std::unique_ptr< Region > clone() const override
clone returns a deep copy of this region.
virtual Relationship relate(Region const &) const =0
solver_t * s
Circle is a circular region on the unit sphere that contains its boundary.
Definition: Circle.h:46
ConvexPolygon is a closed convex polygon on the unit sphere.
Definition: ConvexPolygon.h:57
bool contains(UnitVector3d const &v) const override
T size(T... args)
STL class.
STL class.
Box getBoundingBox() const override
getBoundingBox returns a bounding-box for this region.
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2)
This constructor creates a triangle with the given vertices.
Definition: ConvexPolygon.h:77
bool operator!=(ConvexPolygon const &p) const
Definition: ConvexPolygon.h:97
static constexpr uint8_t TYPE_CODE
Definition: ConvexPolygon.h:59
Box3d represents a box in ℝ³.
Definition: Box3d.h:42
ConvexPolygon(UnitVector3d const &v0, UnitVector3d const &v1, UnitVector3d const &v2, UnitVector3d const &v3)
This constructor creates a quadrilateral with the given vertices.
Definition: ConvexPolygon.h:88
std::vector< uint8_t > encode() const override
encode serializes this region into an opaque byte string.
UnitVector3d is a unit vector in ℝ³ with components stored in double precision.
Definition: UnitVector3d.h:55
STL class.
STL class.
static std::unique_ptr< ConvexPolygon > decode(std::vector< uint8_t > const &s)
Box3d getBoundingBox3d() const override
getBoundingBox3d returns a 3-dimensional bounding-box for this region.