Isis Developer Reference
GisGeometry.h
Go to the documentation of this file.
1#ifndef GisGeometry_h
2#define GisGeometry_h
8/* SPDX-License-Identifier: CC0-1.0 */
9
10// GEOSGeometry, GEOSPreparedGeometry types
11#include <geos_c.h>
12
13// Qt library
14#include <QMetaType>
15#include <QSharedPointer>
16
17class QString;
18
19namespace Isis {
20
21 class Cube;
51
52 public:
63
65 GisGeometry(const double xlongitude, const double ylatitude);
66 GisGeometry(Cube &cube);
67 GisGeometry(const QString &gisSource, const Type t);
68 GisGeometry(const GisGeometry &geom);
69 GisGeometry(GEOSGeometry *geom);
70 GisGeometry &operator=(GisGeometry const &geom);
71 virtual ~GisGeometry();
72
73 void setGeometry(GEOSGeometry *geom);
74
75 bool isDefined() const;
76 bool isValid() const;
77 QString isValidReason() const;
78 bool isEmpty() const;
79 Type type() const;
80 static Type type(const QString &gtype);
81 static QString typeToString(const Type &type);
82
83 const GEOSGeometry *geometry() const;
84 const GEOSPreparedGeometry *preparedGeometry() const;
85
86 GisGeometry *clone() const;
87
88 // Useful operations
89 double area() const;
90 double length() const;
91 double distance(const GisGeometry &target) const;
92 int points() const;
93
94 bool intersects(const GisGeometry &target) const;
95 bool contains(const GisGeometry &target) const;
96 bool disjoint(const GisGeometry &target) const;
97 bool overlaps(const GisGeometry &target) const;
98 bool equals(const GisGeometry &target) const;
99
100 double intersectRatio(const GisGeometry &geom) const;
101
102 GisGeometry *envelope( ) const;
103 GisGeometry *convexHull( ) const;
104 GisGeometry *simplify(const double &tolerance) const;
105
106 GisGeometry *intersection(const GisGeometry &geom) const;
107 GisGeometry *g_union(const GisGeometry &geom) const;
108
109 GisGeometry *centroid() const;
110 bool centroid(double &xlongitude, double &ylatitude) const;
111
112 private:
113 GEOSGeometry *makePoint(const double x, const double y) const;
114 GEOSGeometry *fromCube(Cube &cube) const;
115 GEOSPreparedGeometry const *makePrepared(const GEOSGeometry *geom) const;
116 void destroy();
117
118 Type m_type;
119 GEOSGeometry *m_geom;
120 GEOSPreparedGeometry const *m_preparedGeom;
121
122 };
123
125 typedef QSharedPointer<GisGeometry> SharedGisGeometry;
126
127} // Namespace Isis
128
129// Declaration so this type can be used in Qt's QVariant class
131
132#endif
133
Q_DECLARE_METATYPE(Isis::SharedGisGeometry)
IO Handler for Isis Cubes.
Definition Cube.h:168
Encapsulation class provides support for GEOS-C API.
Definition GisGeometry.h:50
static QString typeToString(const Type &type)
Returns the type of the Geometry as a QString.
Definition GisGeometry.cpp:277
virtual ~GisGeometry()
Destructor.
Definition GisGeometry.cpp:151
double intersectRatio(const GisGeometry &geom) const
Computes intersect ratio between two geometries.
Definition GisGeometry.cpp:582
bool overlaps(const GisGeometry &target) const
Test for overlapping geometries.
Definition GisGeometry.cpp:531
GisGeometry * centroid() const
Computes the centroid of the geometry and returns it as a new geometry.
Definition GisGeometry.cpp:746
bool contains(const GisGeometry &target) const
Test if the target geometry is contained within this geometry.
Definition GisGeometry.cpp:478
double area() const
Computes the area of a geometry.
Definition GisGeometry.cpp:359
Type type() const
Returns the type (origin) of the geometry.
Definition GisGeometry.cpp:244
bool equals(const GisGeometry &target) const
Test if target and this geometry are equal.
Definition GisGeometry.cpp:557
bool disjoint(const GisGeometry &target) const
Tests for disjoint geometries.
Definition GisGeometry.cpp:504
bool intersects(const GisGeometry &target) const
Computes a new geometry from the intersection of the two geomtries.
Definition GisGeometry.cpp:451
GisGeometry * convexHull() const
Computes the convex hull of the geometry.
Definition GisGeometry.cpp:636
GisGeometry * g_union(const GisGeometry &geom) const
Computes the union of two geometries.
Definition GisGeometry.cpp:701
Type
Source type of the geometry.
Definition GisGeometry.h:56
@ IsisCube
An ISIS Cube is used to create the geometry.
Definition GisGeometry.h:60
@ GeosGis
GEOS GIS. A geometry object cannot be created with this geometry type.
Definition GisGeometry.h:61
@ None
No geometry. A geometry object cannot be created with this geometry type.
Definition GisGeometry.h:57
@ WKB
The GEOS library WKB reader is used to create the geometry.
Definition GisGeometry.h:59
@ WKT
The GEOS library WKT reader is used to create the geometry.
Definition GisGeometry.h:58
GisGeometry * clone() const
Clones the contents of this geometry to a new instance.
Definition GisGeometry.cpp:318
const GEOSGeometry * geometry() const
Returns the GEOSGeometry object to extend functionality.
Definition GisGeometry.cpp:291
GisGeometry & operator=(GisGeometry const &geom)
Assignment operator for GISGeomtries.
Definition GisGeometry.cpp:164
double distance(const GisGeometry &target) const
Computes the distance between two geometries.
Definition GisGeometry.cpp:406
double length() const
Computes the length of a geometry.
Definition GisGeometry.cpp:382
bool isValid() const
Determines validity of the geometry contained in this object.
Definition GisGeometry.cpp:213
const GEOSPreparedGeometry * preparedGeometry() const
Returns special GEOS prepared geometry if it exists.
Definition GisGeometry.cpp:305
void setGeometry(GEOSGeometry *geom)
Set the geometry directly taking ownership.
Definition GisGeometry.cpp:187
GisGeometry * envelope() const
Computes the envelope or bounding box of this geometry.
Definition GisGeometry.cpp:619
int points() const
Get number of points in geometry.
Definition GisGeometry.cpp:429
GisGeometry * simplify(const double &tolerance) const
Simplify complex or overdetermined geoemtry.
Definition GisGeometry.cpp:659
bool isDefined() const
Determines if the current geometry is valid.
Definition GisGeometry.cpp:200
bool isEmpty() const
Tests for a defined but empty geometry.
Definition GisGeometry.cpp:338
GisGeometry * intersection(const GisGeometry &geom) const
Computes the intersection of two geometries.
Definition GisGeometry.cpp:681
QString isValidReason() const
Returns a string describing reason for invalid geometry.
Definition GisGeometry.cpp:227
GisGeometry()
Fundamental constructor of an empty object.
Definition GisGeometry.cpp:33
This is free and unencumbered software released into the public domain.
Definition Apollo.h:16
QSharedPointer< GisGeometry > SharedGisGeometry
Definition for a SharedGisGeometry, a shared pointer to a GisGeometry.
Definition GisGeometry.h:125