Provides various tools to work with geos multipolygons. More...

#include <PolygonTools.h>

Collaboration diagram for Isis::PolygonTools:

Public Member Functions
	PolygonTools ()

	~PolygonTools ()

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...

Detailed Description

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.

Author: 2006-08-07 Stuart Sides

Constructor & Destructor Documentation

◆ PolygonTools()

Isis::PolygonTools::PolygonTools ( )

◆ ~PolygonTools()

Isis::PolygonTools::~PolygonTools ( )

Member Function Documentation

◆ CopyMultiPolygon() [1/2]

geos::geom::MultiPolygon * Isis::PolygonTools::CopyMultiPolygon ( const geos::geom::MultiPolygon & mpolygon )

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.

Parameters

mpolygon The multipolygon to be copied.

Returns: Returns a pointer to a multipolygon which is a deep copy of the input multipolygon. This is necessary because at the time of writing the geos package does not create multipolygons when copying. It produdes geometryCollections

References Isis::globalFactory.

◆ CopyMultiPolygon() [2/2]

geos::geom::MultiPolygon * Isis::PolygonTools::CopyMultiPolygon ( const geos::geom::MultiPolygon * mpolygon )

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.

Parameters

mpolygon The multipolygon to be copied.

Returns: Returns a pointer to a multipolygon which is a deep copy of the input multipolygon. This is necessary because at the time of writing the geos package does not create multipolygons when copying. It produdes geometryCollections

References Isis::globalFactory.

Referenced by Isis::InterestOperator::SetClipPolygon(), and Isis::ImageOverlap::SetPolygon().

◆ Despike() [1/3]

geos::geom::MultiPolygon * Isis::PolygonTools::Despike ( const geos::geom::Geometry * geom )

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.

Parameters

geom

Returns: geos::geom::MultiPolygon*

◆ Despike() [2/3]

geos::geom::LinearRing * Isis::PolygonTools::Despike ( const geos::geom::LineString * lineString )

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.

Parameters

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.

Returns: A pointer to a LinearRing. If the despiking causes the number of unique verticies to fall below 3, an empty LinearRing will be returned.

References Isis::globalFactory.

◆ Despike() [3/3]

geos::geom::MultiPolygon * Isis::PolygonTools::Despike ( const geos::geom::MultiPolygon * multiPoly )

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.

Parameters

multiPoly The original geos::geom::MultiPolygon to be despiked.

References _FILEINFO_, and Isis::globalFactory.

◆ Difference()

geos::geom::Geometry * Isis::PolygonTools::Difference	(	const geos::geom::Geometry *	geom1,
		const geos::geom::Geometry *	geom2
	)

static

This method is used to subtract two polygons.

Parameters

geom1
geom2

Returns: geos::geom::Geometry*

References _FILEINFO_.

◆ Equal() [1/5]

bool Isis::PolygonTools::Equal	(	const double	d1,
		const double	d2
	)

static

◆ Equal() [2/5]

bool Isis::PolygonTools::Equal	(	const geos::geom::Coordinate &	coord1,
		const geos::geom::Coordinate &	coord2
	)

static

◆ Equal() [3/5]

bool Isis::PolygonTools::Equal	(	const geos::geom::LineString *	lineString1,
		const geos::geom::LineString *	lineString2
	)

static

◆ Equal() [4/5]

bool Isis::PolygonTools::Equal	(	const geos::geom::MultiPolygon *	poly1,
		const geos::geom::MultiPolygon *	poly2
	)

static

◆ Equal() [5/5]

bool Isis::PolygonTools::Equal	(	const geos::geom::Polygon *	poly1,
		const geos::geom::Polygon *	poly2
	)

static

◆ FixPolePolygon()

static geos::geom::MultiPolygon* Isis::PolygonTools::FixPolePolygon	(	const geos::geom::MultiPolygon *	polePolygon,
		UniversalGroundMap *	ugm
	)

static

◆ FixSeam() [1/2]

geos::geom::MultiPolygon * Isis::PolygonTools::FixSeam ( const geos::geom::MultiPolygon * poly )

static

References Isis::globalFactory.

◆ FixSeam() [2/2]

geos::geom::MultiPolygon * Isis::PolygonTools::FixSeam	(	const geos::geom::Polygon *	polyA,
		const geos::geom::Polygon *	polyB
	)

static

References Isis::globalFactory.

◆ GetGeometryName()

QString Isis::PolygonTools::GetGeometryName ( const geos::geom::Geometry * geom )

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).

Parameters

geom	The geometry to test which type it really is

Returns: QString

◆ GMLSchema()

QString Isis::PolygonTools::GMLSchema ( )

static

Return the gml schema.

Returns: QString Returns the polygon with lon,lat lon,lat format vertices and GML header

◆ Intersect()

geos::geom::Geometry * Isis::PolygonTools::Intersect	(	const geos::geom::Geometry *	geom1,
		const geos::geom::Geometry *	geom2
	)

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.

Parameters

geom1	First geometry to intersect
geom2	Second geometry to intersect

Returns: geos::geom::Geometry* geom1 intersected with geom2

References _FILEINFO_.

Referenced by Isis::InterestOperator::FindOverlapByImageFootPrint().

◆ LatLonToSampleLine()

geos::geom::MultiPolygon * Isis::PolygonTools::LatLonToSampleLine	(	const geos::geom::MultiPolygon &	lonLatPolygon,
		UniversalGroundMap *	ugm
	)

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).

Parameters

lonLatPolygon	A multipolygon in (Lon,Lat order)
ugm	The UniversalGroundMap to be used to convert the Lons and Lat to Samples and Lines

Returns: Returns a multipolygon which is the result of converting the input multipolygon from (Lon,Lat) to (Sample,Line).

References _FILEINFO_, Isis::globalFactory, Isis::UniversalGroundMap::Line(), Isis::UniversalGroundMap::Sample(), and Isis::UniversalGroundMap::SetUniversalGround().

Referenced by Isis::InterestOperator::InterestByPoint().

◆ LatLonToXY()

geos::geom::MultiPolygon * Isis::PolygonTools::LatLonToXY	(	const geos::geom::MultiPolygon &	lonLatPolygon,
		TProjection *	projection
	)

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).

Parameters

lonLatPolygon	A multipolygon in (Lon,Lat) order
projection	The projection to be used to convert the Lons and Lat to X and Y

Returns: Returns a multipolygon which is the result of converting the input multipolygon from (Lon,Lat) to (X,Y).

References _FILEINFO_, Isis::globalFactory, Isis::TProjection::SetGround(), Isis::Projection::XCoord(), and Isis::Projection::YCoord().

◆ MakeMultiPolygon()

geos::geom::MultiPolygon * Isis::PolygonTools::MakeMultiPolygon ( const geos::geom::Geometry * geom )

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.

Parameters

geom	The geometry to be converted into a multipolygon

References Isis::globalFactory.

Referenced by Isis::InterestOperator::FindOverlapByImageFootPrint(), Isis::UniversalGroundMap::GroundRange(), Isis::ImageOverlap::ImageOverlap(), and Isis::ImagePolygon::ImagePolygon().

◆ ReducePrecision() [1/6]

geos::geom::Coordinate * Isis::PolygonTools::ReducePrecision	(	const geos::geom::Coordinate *	coord,
		unsigned int	precision
	)

static

This method reduces the precision of the coordinate to precision significant figures.

Parameters

coord	The coordinate to reduce precision on
precision	The precision to reduce to

Returns: geos::geom::Coordinate* The lower precision coordinate

◆ ReducePrecision() [2/6]

geos::geom::Geometry * Isis::PolygonTools::ReducePrecision	(	const geos::geom::Geometry *	geom,
		unsigned int	precision
	)

static

This method reduces the precision of the geometry to precision significant figures.

Parameters

geom	The geometry to reduce precision on
precision	The precision to reduce to

Returns: geos::geom::Geometry* The lower precision geometry

References _FILEINFO_.

◆ ReducePrecision() [3/6]

geos::geom::LinearRing * Isis::PolygonTools::ReducePrecision	(	const geos::geom::LinearRing *	ring,
		unsigned int	precision
	)

static

This method reduces the precision of the LinearRing to precision significant figures.

Parameters

ring	The linear ring to reduce precision on
precision	The precision to reduce to

Returns: geos::geom::LinearRing* The lower precision linear ring

References _FILEINFO_, and Isis::globalFactory.

◆ ReducePrecision() [4/6]

geos::geom::MultiPolygon * Isis::PolygonTools::ReducePrecision	(	const geos::geom::MultiPolygon *	poly,
		unsigned int	precision
	)

static

This method reduces the precision of the MultiPolygon to precision significant figures.

Parameters

poly	The MultiPolygon to reduce precision on
precision	The precision to reduce to

Returns: geos::geom::MultiPolygon* The lower precision MultiPolygon

References Isis::globalFactory.

◆ ReducePrecision() [5/6]

geos::geom::Polygon * Isis::PolygonTools::ReducePrecision	(	const geos::geom::Polygon *	poly,
		unsigned int	precision
	)

static

This method reduces the precision of the Polygon to precision significant figures.

Parameters

poly	The polygon to reduce precision on
precision	The precision to reduce to

Returns: geos::geom::Polygon* The lower precision polygon

References _FILEINFO_, and Isis::globalFactory.

◆ ReducePrecision() [6/6]

double Isis::PolygonTools::ReducePrecision	(	double	num,
		unsigned int	precision
	)

static

This method will reduce the decimal precision of the inputted num to precision decimal places.

Parameters

num	The original number
precision	The new precision

Returns: double The reduced precision number

◆ SplitPolygonOn360()

geos::geom::MultiPolygon * Isis::PolygonTools::SplitPolygonOn360 ( const geos::geom::Polygon * inPoly )

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.

Parameters

polygon projection The projection to be used to convert the Xs and Ys to Lon and Lats

Returns: Returns a pointer to a multipolygon which is the result of splitting the input parameter polygon every where it crosses the 0/360 longitude boundry. The caller assumes responsibility for deleting the returned multipolygon

References _FILEINFO_, Isis::globalFactory, and Isis::IException::what().

◆ Thickness()

double Isis::PolygonTools::Thickness ( const geos::geom::MultiPolygon * mpolygon )

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.

Parameters

mpolygon The XY polygon to calculate the thickness of

Returns: double The thikness of the provided polygon

◆ To180()

geos::geom::MultiPolygon * Isis::PolygonTools::To180 ( geos::geom::MultiPolygon * poly360 )

static

Convert polygon coordinates from 360 system to 180.

Parameters

[in] poly360 (geos::geom::MultiPolygon)poly split by 360 boundary

Returns: geos::geom::MultiPolygon Returns a 180 multi-polygon

References _FILEINFO_, and Isis::globalFactory.

Referenced by Isis::MosaicSceneItem::reproject().

◆ ToGML()

QString Isis::PolygonTools::ToGML	(	const geos::geom::MultiPolygon *	mpolygon,
		QString	idString = `QString("0")`,
		QString	schema = `QString("")`
	)

static

Return the polygon with gml header.

Parameters

[in]	mpolygon	Polygon with lat/lon vertices
	idString	mpolygon's Id

Returns: QString Returns the polygon with lon,lat lon,lat format vertices and GML header

◆ XYToLatLon()

geos::geom::MultiPolygon * Isis::PolygonTools::XYToLatLon	(	const geos::geom::MultiPolygon &	xYPolygon,
		TProjection *	projection
	)

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).

Parameters

xYPolygon	A multipolygon in (X,Y) order
projection	The projection to be used to convert the Xs and Ys to Lon and Lats

Returns: Returns a multipolygon which is the result of converting the input multipolygon from (X,Y) to (Lon,Lat).

References _FILEINFO_, Isis::globalFactory, Isis::TProjection::Latitude(), Isis::TProjection::Longitude(), and Isis::Projection::SetWorld().

The documentation for this class was generated from the following files:

/home/isis3mgr/repos/ISIS3/isis/src/base/objs/PolygonTools/PolygonTools.h
/home/isis3mgr/repos/ISIS3/isis/src/base/objs/PolygonTools/PolygonTools.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PolygonTools()

◆ ~PolygonTools()

Member Function Documentation

◆ CopyMultiPolygon() [1/2]

◆ CopyMultiPolygon() [2/2]

◆ Despike() [1/3]

◆ Despike() [2/3]

◆ Despike() [3/3]

◆ Difference()

◆ Equal() [1/5]

◆ Equal() [2/5]

◆ Equal() [3/5]

◆ Equal() [4/5]

◆ Equal() [5/5]

◆ FixPolePolygon()

◆ FixSeam() [1/2]

◆ FixSeam() [2/2]

◆ GetGeometryName()

◆ GMLSchema()

◆ Intersect()

◆ LatLonToSampleLine()

◆ LatLonToXY()

◆ MakeMultiPolygon()

◆ ReducePrecision() [1/6]

◆ ReducePrecision() [2/6]

◆ ReducePrecision() [3/6]

◆ ReducePrecision() [4/6]

◆ ReducePrecision() [5/6]

◆ ReducePrecision() [6/6]

◆ SplitPolygonOn360()

◆ Thickness()

◆ To180()

◆ ToGML()

◆ XYToLatLon()