lsst.sphgeom gbd998247f1+585e252eca
Loading...
Searching...
No Matches
Region.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_REGION_H_
31#define LSST_SPHGEOM_REGION_H_
32
35
36#include <memory>
37#include <vector>
38
39#include "Relationship.h"
40
41
42namespace lsst {
43namespace sphgeom {
44
45// Forward declarations
46class Box;
47class Box3d;
48class Circle;
49class ConvexPolygon;
50class Ellipse;
51class UnitVector3d;
52
86class Region {
87public:
88 virtual ~Region() {}
89
91 virtual std::unique_ptr<Region> clone() const = 0;
92
94 virtual Box getBoundingBox() const = 0;
95
97 virtual Box3d getBoundingBox3d() const = 0;
98
100 virtual Circle getBoundingCircle() const = 0;
101
103 virtual bool contains(UnitVector3d const &) const = 0;
104
107 bool contains(double x, double y, double z) const;
108
111 bool contains(double lon, double lat) const;
112
131 virtual Relationship relate(Region const &) const = 0;
132 virtual Relationship relate(Box const &) const = 0;
133 virtual Relationship relate(Circle const &) const = 0;
134 virtual Relationship relate(ConvexPolygon const &) const = 0;
135 virtual Relationship relate(Ellipse const &) const = 0;
137
140 virtual std::vector<uint8_t> encode() const = 0;
141
144 static std::unique_ptr<Region> decode(std::vector<uint8_t> const & s) {
145 return decode(s.data(), s.size());
146 }
147
148 static std::unique_ptr<Region> decode(uint8_t const * buffer, size_t n);
150};
151
152}} // namespace lsst::sphgeom
153
154#endif // LSST_SPHGEOM_REGION_H_
Definition Box3d.h:49
Definition Box.h:61
Definition Circle.h:53
Definition ConvexPolygon.h:64
Definition Ellipse.h:177
Definition Region.h:86
virtual Circle getBoundingCircle() const =0
getBoundingCircle returns a bounding-circle for this region.
virtual Relationship relate(Region const &) const =0
static std::unique_ptr< Region > decode(std::vector< uint8_t > const &s)
Definition Region.h:144
virtual Box getBoundingBox() const =0
getBoundingBox returns a bounding-box for this region.
virtual bool contains(UnitVector3d const &) const =0
contains tests whether the given unit vector is inside this region.
virtual std::unique_ptr< Region > clone() const =0
clone returns a deep copy of this region.
virtual std::vector< uint8_t > encode() const =0
virtual Box3d getBoundingBox3d() const =0
getBoundingBox3d returns a 3-dimensional bounding-box for this region.
Definition UnitVector3d.h:62
std::bitset< 3 > Relationship
Relationship describes how two sets are related.
Definition Relationship.h:42
This file provides a type alias for describing set relationships.