Isis 3 Programmer Reference
|
Provides various tools to work with geos multipolygons. More...
#include <PolygonTools.h>
Static Public Member Functions | |
static geos::geom::MultiPolygon * | LatLonToXY (const geos::geom::MultiPolygon &lonLatPoly, TProjection *proj) |
This method will return a geos::geom::MultiPolygon which contains the X/Y coordinates of the LonLat polygon. More... | |
static geos::geom::MultiPolygon * | XYToLatLon (const geos::geom::MultiPolygon &xYPoly, TProjection *proj) |
This method will return a geos::geom::MultiPolygon which contains the (Lon,Lat) coordinates of the XY polygon. More... | |
static geos::geom::MultiPolygon * | LatLonToSampleLine (const geos::geom::MultiPolygon &lonLatPoly, UniversalGroundMap *ugm) |
This method will return a geos::geom::MultiPolygon which contains the sample/line coordinates of the Lat/Lon polygon. More... | |
static geos::geom::MultiPolygon * | CopyMultiPolygon (const geos::geom::MultiPolygon *mpolygon) |
This static method will create a deep copy of a geos::geom::MultiPolygon. More... | |
static geos::geom::MultiPolygon * | CopyMultiPolygon (const geos::geom::MultiPolygon &mpolygon) |
This static method will create a deep copy of a geos::geom::MultiPolygon. More... | |
static geos::geom::MultiPolygon * | Despike (const geos::geom::Geometry *geom) |
This method attempts to convert the geom to a MultiPolygon and then despike it. More... | |
static geos::geom::MultiPolygon * | Despike (const geos::geom::MultiPolygon *multiPoly) |
Create a new multipolygon without the spikes associated with some versions of the geos package. More... | |
static geos::geom::LinearRing * | Despike (const geos::geom::LineString *linearRing) |
Create a new LinearRing from a LineString without the spikes associated with some versions of the geos package. More... | |
static geos::geom::MultiPolygon * | To180 (geos::geom::MultiPolygon *poly360) |
Convert polygon coordinates from 360 system to 180. More... | |
static QString | ToGML (const geos::geom::MultiPolygon *mpolygon, QString idString=QString("0"), QString schema=QString("")) |
Return the polygon with gml header. More... | |
static QString | GMLSchema () |
Return the gml schema. More... | |
static double | Thickness (const geos::geom::MultiPolygon *mpolygon) |
Calculates the thickness of a polygon using: thickness = area / max(Xextent,Yextent)**2 The provided polygon SHOULD be an XY polygon, not a lat/lon polygon, but this is not enforced. More... | |
static geos::geom::Geometry * | Intersect (const geos::geom::Geometry *geom1, const geos::geom::Geometry *geom2) |
This applies the geos Intersect operator. More... | |
static geos::geom::Geometry * | Difference (const geos::geom::Geometry *geom1, const geos::geom::Geometry *geom2) |
This method is used to subtract two polygons. More... | |
static geos::geom::MultiPolygon * | MakeMultiPolygon (const geos::geom::Geometry *geom) |
Make a geos::geom::MultiPolygon out of the components of the argument. More... | |
static QString | GetGeometryName (const geos::geom::Geometry *geom) |
This method returns the name of the type of geometry passed in. More... | |
static bool | Equal (const geos::geom::MultiPolygon *poly1, const geos::geom::MultiPolygon *poly2) |
static bool | Equal (const geos::geom::Polygon *poly1, const geos::geom::Polygon *poly2) |
static bool | Equal (const geos::geom::LineString *lineString1, const geos::geom::LineString *lineString2) |
static bool | Equal (const geos::geom::Coordinate &coord1, const geos::geom::Coordinate &coord2) |
static bool | Equal (const double d1, const double d2) |
static geos::geom::MultiPolygon * | FixSeam (const geos::geom::MultiPolygon *poly) |
static geos::geom::MultiPolygon * | FixSeam (const geos::geom::Polygon *polyA, const geos::geom::Polygon *polyB) |
static geos::geom::Geometry * | ReducePrecision (const geos::geom::Geometry *geom, unsigned int precision) |
This method reduces the precision of the geometry to precision significant figures. More... | |
static geos::geom::MultiPolygon * | ReducePrecision (const geos::geom::MultiPolygon *poly, unsigned int precision) |
This method reduces the precision of the MultiPolygon to precision significant figures. More... | |
static geos::geom::Polygon * | ReducePrecision (const geos::geom::Polygon *poly, unsigned int precision) |
This method reduces the precision of the Polygon to precision significant figures. More... | |
static geos::geom::LinearRing * | ReducePrecision (const geos::geom::LinearRing *ring, unsigned int precision) |
This method reduces the precision of the LinearRing to precision significant figures. More... | |
static geos::geom::Coordinate * | ReducePrecision (const geos::geom::Coordinate *coord, unsigned int precision) |
This method reduces the precision of the coordinate to precision significant figures. More... | |
static double | ReducePrecision (double num, unsigned int precision) |
This method will reduce the decimal precision of the inputted num to precision decimal places. More... | |
static geos::geom::MultiPolygon * | FixPolePolygon (const geos::geom::MultiPolygon *polePolygon, UniversalGroundMap *ugm) |
static geos::geom::MultiPolygon * | SplitPolygonOn360 (const geos::geom::Polygon *inPoly) |
If the cube crosses the 0/360 boundary and does not include a pole, this will divide the polygon into multiple polygons (one for each time the polygon crosses the boundry and back). More... | |
Static Private Member Functions | |
static bool | IsSpiked (geos::geom::Coordinate first, geos::geom::Coordinate middle, geos::geom::Coordinate last) |
Returns true if the middle point is spiked. More... | |
static bool | TestSpiked (geos::geom::Coordinate first, geos::geom::Coordinate middle, geos::geom::Coordinate last) |
Used by IsSpiked to directionally test (first/last matter) the spike. More... | |
static geos::geom::Geometry * | FixGeometry (const geos::geom::Geometry *geom) |
This method attempts to seek out known problems with geometries and repair them. More... | |
static geos::geom::MultiPolygon * | FixGeometry (const geos::geom::MultiPolygon *poly) |
This applies the LinearRing FixGeometry method to all of the interior and exterior rings in the multipolygon. More... | |
static geos::geom::Polygon * | FixGeometry (const geos::geom::Polygon *poly) |
static geos::geom::LinearRing * | FixGeometry (const geos::geom::LinearRing *ring) |
One problem we know of seems to happen when two points are right on top of each other. More... | |
static geos::geom::Geometry * | Operate (const geos::geom::Geometry *geom1, const geos::geom::Geometry *geom2, unsigned int opcode) |
static int | DecimalPlace (double) |
This returns the location of the decimal place in the number. More... | |
Private Attributes | |
geos::geom::MultiPolygon * | p_polygons |
Provides various tools to work with geos multipolygons.
This class provides methods to that work with geos multipolygons. This includes functions to convert from one coordinate system to another and to copy multipolygons.
2006-08-07 Stuart Sides - Original version
2007-05-04 Robert Sucharski - Moved the method to output WKT from ImagePlygon class to this class. Also added method to output GML format.
2007-11-09 Tracie Sucharski - Remove ToWKT method, geos now has a method (toString) to return a WKT string. Added To180 method which converts polygon coordinates from 0/360 system to -180/180 system. If polygon was split because it crossed the 0/360 seam, the two polys coordinates are converted then merged.
2008-06-18 Steven Koechle - Fixed Documentation Errors
2008-08-18 Steven Lambright - Updated to work with geos3.0.0 instead of geos2. Mostly namespace changes.
2008-11-10 Christopher Austin - Added Thickness()
2008-11-25 Steven Koechle - Moved Despike Methods from ImageOverlapSet to PolygonTools
2008-12-01 Steven Lambright - Changed the Despike algorithm to be in more methods to clean it up, added the middle point to beginning/end of line tests to keep more data. Added "IsSpiked" and "TestSpiked."
2008-12-10 Steven Koechle - Moved MakeMultiPolygon Method from ImageOverlapSet to PolygonTools
2008-12-12 Steven Lambright - Bug fixes, cleaned up Despike/MakeMultiPolygon
2008-12-12 Steven Lambright - Renamed methods, polygon conversion methods now throw an iException if they fail, updated Despike(...)'s algorithm
2008-12-19 Steven Lambright - updated Despike(...)'s algorithm
2008-12-19 Steven Lambright - Added error to Despike (empty or invalid result).
2009-01-16 Steven Koechle - Fixed Memory Leak in LatLonToSampleLine method
2009-01-23 Steven Lambright - Added precision reduction algorithms and made the Difference and Intersect operators work in a more generic way by calling the new method Operate(...).
2009-01-28 Steven Lambright - Fixed memory leaks
2009-02-02 Stacy Alley - updated the To180 method to handle 360 multi polys that cross the -180/180 boundry. We need to return >1 polygon for these type of cases.
2009-01-28 Steven Lambright - Fixed bug in Operate(...) method when reducing precision
2009-06-09 Steven Lambright - Added a check to Equal(double,double). This never caused a problem but could have.
2011-05-31 Steven Lambright - Improved To180 (not finished). The remaining work is to remove the 0 seam from the polygons.
2013-02-26 Stuart Sides - Modified the output of GML and GML schema
2013-08-12 Stuart Sides - Added SplitPolygonOn360 and FixPolePolygon methods. Code was extracted from the ImagePolygon class. References #1604.
2017-08-18 Tyler Wilson, Summer Stapleton, Ian Humphrey - Changed auto_ptr references to unique_ptr so that this class compiles with no warnings for C++14. References #4809.
Definition at line 135 of file PolygonTools.h.
|
static |
This static method will create a deep copy of a geos::geom::MultiPolygon.
The caller assumes responsibility for the memory associated with the new polygon.
mpolygon | The multipolygon to be copied. |
Definition at line 370 of file PolygonTools.cpp.
Referenced by Isis::InterestOperator::SetClipPolygon(), and Isis::ImageOverlap::SetPolygon().
|
static |
This static method will create a deep copy of a geos::geom::MultiPolygon.
The caller assumes responsibility for the memory associated with the new polygon.
mpolygon | The multipolygon to be copied. |
Definition at line 392 of file PolygonTools.cpp.
|
staticprivate |
This returns the location of the decimal place in the number.
This method is used as a helper method for FixGeometry(...), to help figure out how close two numbers are in significant figures.
1.0 = decimal place 1, .1 = decimal place 0, 10.0 = decimal place 2
num | The number to find the decimal place in |
Definition at line 1322 of file PolygonTools.cpp.
|
static |
This method attempts to convert the geom to a MultiPolygon and then despike it.
This method does not take ownership of the argument geom. The ownership of the return value is given to the caller.
geom |
Definition at line 662 of file PolygonTools.cpp.
|
static |
Create a new multipolygon without the spikes associated with some versions of the geos package.
This method does not take ownership of the argument multiPoly. The ownership of the return value is given to the caller.
multiPoly | The original geos::geom::MultiPolygon to be despiked. |
Definition at line 683 of file PolygonTools.cpp.
References _FILEINFO_.
|
static |
Create a new LinearRing from a LineString without the spikes associated with some versions of the geos package.
These "spikes" are created when intersections and differences are calculated.
lineString | The original geos::geom::lineString to be despiked. This can be the lineString associated with the outside of a polygon or one of its holes. |
Definition at line 788 of file PolygonTools.cpp.
|
static |
This method is used to subtract two polygons.
geom1 | |
geom2 |
Definition at line 1350 of file PolygonTools.cpp.
References _FILEINFO_.
|
staticprivate |
This method attempts to seek out known problems with geometries and repair them.
Currently the only known problem is when two points lie on top of each other, which is a result of various operations. Currently only LinearRings and MultiPolygons are supported.
geom | The geometry to be fixed |
Definition at line 1109 of file PolygonTools.cpp.
References _FILEINFO_.
|
staticprivate |
This applies the LinearRing FixGeometry method to all of the interior and exterior rings in the multipolygon.
See FixGeometry(LinearRing) for more explanation.
poly | An invalid multipolygon |
Definition at line 1137 of file PolygonTools.cpp.
|
staticprivate |
One problem we know of seems to happen when two points are right on top of each other.
We're going to look for those points and remove them, then see if the linear ring is valid. Assumes input fails its isValid() test.
Point end up on top of each other for two (2) known reasons. First, Despike removes a spike that simply went back and forth. Second, the geos Intersect operator can return invalid polygons because of this problem. Every geometry thus far is being broken down into LinearRings and this method cleans those up.
ring | An invalid linear ring |
Definition at line 1222 of file PolygonTools.cpp.
|
static |
This method returns the name of the type of geometry passed in.
This is useful for error reporting (i.e. Geometry Type [...] not supported).
geom | The geometry to test which type it really is |
Definition at line 1827 of file PolygonTools.cpp.
|
static |
Return the gml schema.
Definition at line 477 of file PolygonTools.cpp.
|
static |
This applies the geos Intersect operator.
Due to "BinaryOp.h" having implementations in it, only one Isis object may perform these operations. If that file is included anywhere else in Isis, the library will not build! Please use this method to intersect two geometries. If the geometry is a linear ring or multi polygon, corrections may be applied if the geos intersection operator fails.
geom1 | First geometry to intersect |
geom2 | Second geometry to intersect |
Definition at line 980 of file PolygonTools.cpp.
References _FILEINFO_.
Referenced by Isis::InterestOperator::FindOverlapByImageFootPrint(), and Isis::ImagePolygon::Fix360Poly().
|
staticprivate |
Returns true if the middle point is spiked.
first | |
middle | |
last |
Definition at line 864 of file PolygonTools.cpp.
|
static |
This method will return a geos::geom::MultiPolygon which contains the sample/line coordinates of the Lat/Lon polygon.
The Lat/Lon polygon must have coordinates (x direction, y direction) or (Lon,Lat).
lonLatPolygon | A multipolygon in (Lon,Lat order) |
ugm | The UniversalGroundMap to be used to convert the Lons and Lat to Samples and Lines |
Definition at line 261 of file PolygonTools.cpp.
References _FILEINFO_.
Referenced by Isis::InterestOperator::InterestByPoint().
|
static |
This method will return a geos::geom::MultiPolygon which contains the X/Y coordinates of the LonLat polygon.
The Lat/Lon polygon must have coordinates (x direction, y direction) or (Lon,Lat).
lonLatPolygon | A multipolygon in (Lon,Lat) order |
projection | The projection to be used to convert the Lons and Lat to X and Y |
Definition at line 63 of file PolygonTools.cpp.
References _FILEINFO_.
|
static |
Make a geos::geom::MultiPolygon out of the components of the argument.
Create a new geos::geom::MultiPolygon out of the general geometry that is passed in. This can be useful after an intersection or some other operator on two MultiPolygons. The result of the operator is often a collection of different geometries such as points, lines, polygons... This member extracts all polygons and multipolygons into a new multipolygon. The original geometry is deleted. The resulting multipolygon is not necessarily valid.
geom | The geometry to be converted into a multipolygon |
Definition at line 1385 of file PolygonTools.cpp.
Referenced by Isis::Shape::createFootprint(), Isis::Image::createFootprint(), Isis::Image::XmlHandler::endElement(), Isis::InterestOperator::FindOverlapByImageFootPrint(), Isis::ImagePolygon::Fix360Poly(), Isis::UniversalGroundMap::GroundRange(), Isis::ImageOverlap::ImageOverlap(), Isis::Image::initQuickFootprint(), and Isis::ImagePolygon::ReadData().
|
static |
This method reduces the precision of the geometry to precision significant figures.
geom | The geometry to reduce precision on |
precision | The precision to reduce to |
Definition at line 1580 of file PolygonTools.cpp.
References _FILEINFO_.
|
static |
This method reduces the precision of the MultiPolygon to precision significant figures.
poly | The MultiPolygon to reduce precision on |
precision | The precision to reduce to |
Definition at line 1614 of file PolygonTools.cpp.
|
static |
This method reduces the precision of the Polygon to precision significant figures.
poly | The polygon to reduce precision on |
precision | The precision to reduce to |
Definition at line 1648 of file PolygonTools.cpp.
References _FILEINFO_.
|
static |
This method reduces the precision of the LinearRing to precision significant figures.
ring | The linear ring to reduce precision on |
precision | The precision to reduce to |
Definition at line 1712 of file PolygonTools.cpp.
|
static |
This method reduces the precision of the coordinate to precision significant figures.
coord | The coordinate to reduce precision on |
precision | The precision to reduce to |
Definition at line 1777 of file PolygonTools.cpp.
|
static |
This method will reduce the decimal precision of the inputted num to precision decimal places.
num | The original number |
precision | The new precision |
Definition at line 1796 of file PolygonTools.cpp.
|
static |
If the cube crosses the 0/360 boundary and does not include a pole, this will divide the polygon into multiple polygons (one for each time the polygon crosses the boundry and back).
These polygons are put into a geos Multipolygon. If the cube does not cross the 0/360 boundary then the returned Multipolygon will contain a single Polygon.
polygon | projection The projection to be used to convert the Xs and Ys to Lon and Lats |
Definition at line 2012 of file PolygonTools.cpp.
|
staticprivate |
Used by IsSpiked to directionally test (first/last matter) the spike.
This method tests for spikes.
The first/last coordinate matter. If the line between the first point and middle point are the base of a triangle, with the last point as the tip, then if the base of this triangle is substantially larger than the height we have a spike (fig A). If the middle point is near the edges of the triangle, however, this is valid data (fig B/C).
(A) (B) (C) 1 1 1-2 | | | | | | 3-| | | | | | | | | 2 2-3 3
*1 is start, 2 is middle, 3 is end
Spikes are a problem because when we convert from lat/lons to meters the points get shifted relative to each other (lower points might be shifted more right then higher points, for example).
first | |
middle | |
last |
Definition at line 898 of file PolygonTools.cpp.
|
static |
Calculates the thickness of a polygon using: thickness = area / max(Xextent,Yextent)**2 The provided polygon SHOULD be an XY polygon, not a lat/lon polygon, but this is not enforced.
mpolygon | The XY polygon to calculate the thickness of |
Definition at line 640 of file PolygonTools.cpp.
|
static |
Convert polygon coordinates from 360 system to 180.
[in] | poly360 | (geos::geom::MultiPolygon)poly split by 360 boundary |
Definition at line 543 of file PolygonTools.cpp.
Referenced by Isis::MosaicSceneItem::reproject().
|
static |
Return the polygon with gml header.
[in] | mpolygon | Polygon with lat/lon vertices |
idString | mpolygon's Id |
Definition at line 410 of file PolygonTools.cpp.
|
static |
This method will return a geos::geom::MultiPolygon which contains the (Lon,Lat) coordinates of the XY polygon.
The Lat/Lon polygon will have coordinates (x direction, y direction) or (Lon,Lat).
xYPolygon | A multipolygon in (X,Y) order |
projection | The projection to be used to convert the Xs and Ys to Lon and Lats |
Definition at line 169 of file PolygonTools.cpp.
References _FILEINFO_.