Package osgeo :: Module ogr :: Class Geometry |
[hide private]
[frames] | no frames]

# Class Geometry

source code

Proxy of C++ OGRGeometryShadow class

Instance Methods | [hide private]
__repr__(self) | source code
__init__(self, *args, **kwargs) __init__(self, OGRwkbGeometryType type = wkbUnknown, char wkt = None, ... | source code
OGRErr |
ExportToWkt(self) OGRErr OGR_G_ExportToWkt(OGRGeometryH hGeom, char **ppszSrcText) | source code
OGRErr |
ExportToIsoWkt(self) OGRErr OGR_G_ExportToIsoWkt(OGRGeometryH hGeom, char **ppszSrcText) | source code
ExportToWkb(self, *args, **kwargs) ExportToWkb(self, OGRwkbByteOrder byte_order = wkbXDR) -> OGRErr | source code
ExportToIsoWkb(self, *args, **kwargs) ExportToIsoWkb(self, OGRwkbByteOrder byte_order = wkbXDR) -> OGRErr | source code
ExportToGML(self, *args, **kwargs) ExportToGML(self, char options = None) -> retStringAndCPLFree | source code
ExportToKML(self, *args) ExportToKML(self, char altitude_mode = None) -> retStringAndCPLFree | source code
ExportToJson(self, *args, **kwargs) ExportToJson(self, char options = None) -> retStringAndCPLFree | source code
AddPoint(self, *args, **kwargs) AddPoint(self, double x, double y, double z = 0) | source code
AddPointM(self, *args, **kwargs) AddPointM(self, double x, double y, double m) | source code
AddPointZM(self, *args, **kwargs) AddPointZM(self, double x, double y, double z, double m) | source code
AddPoint_2D(self, *args) AddPoint_2D(self, double x, double y) | source code
AddGeometryDirectly(self, *args) AddGeometryDirectly(self, Geometry other_disown) -> OGRErr | source code
AddGeometry(self, *args) AddGeometry(self, Geometry other) -> OGRErr | source code
Geometry |
Clone(self) OGRGeometryH OGR_G_Clone(OGRGeometryH hGeom) | source code
OGRwkbGeometryType |
GetGeometryType(self) OGRwkbGeometryType OGR_G_GetGeometryType(OGRGeometryH hGeom) | source code
char |
GetGeometryName(self) const char* OGR_G_GetGeometryName(OGRGeometryH hGeom) | source code
double |
Length(self) | source code
double |
Area(self) | source code
double |
GetArea(self) | source code
int |
GetPointCount(self) | source code
GetPoints(self, *args, **kwargs) GetPoints(self, int nCoordDimension = 0) | source code
GetX(self, *args, **kwargs) GetX(self, int point = 0) -> double | source code
GetY(self, *args, **kwargs) GetY(self, int point = 0) -> double | source code
GetZ(self, *args, **kwargs) GetZ(self, int point = 0) -> double | source code
GetM(self, *args, **kwargs) GetM(self, int point = 0) -> double | source code
GetPoint(self, *args) GetPoint(self, int iPoint = 0) | source code
GetPointZM(self, *args) GetPointZM(self, int iPoint = 0) | source code
GetPoint_2D(self, *args) GetPoint_2D(self, int iPoint = 0) | source code
int |
GetGeometryCount(self) | source code
SetPoint(self, *args, **kwargs) SetPoint(self, int point, double x, double y, double z = 0) | source code
SetPointM(self, *args, **kwargs) SetPointM(self, int point, double x, double y, double m) | source code
SetPointZM(self, *args, **kwargs) SetPointZM(self, int point, double x, double y, double z, double m) | source code
SetPoint_2D(self, *args, **kwargs) SetPoint_2D(self, int point, double x, double y) | source code
GetGeometryRef(self, *args) GetGeometryRef(self, int geom) -> Geometry | source code
Simplify(self, *args) Simplify(self, double tolerance) -> Geometry | source code
SimplifyPreserveTopology(self, *args) SimplifyPreserveTopology(self, double tolerance) -> Geometry | source code
DelaunayTriangulation(self, *args, **kwargs) DelaunayTriangulation(self, double dfTolerance = 0.0, int bOnlyEdges = True) -> Geometry | source code
Geometry |
Boundary(self) OGRGeometryH OGR_G_Boundary(OGRGeometryH hTarget) | source code
Geometry |
GetBoundary(self) OGRGeometryH OGR_G_GetBoundary(OGRGeometryH hTarget) | source code
Geometry |
ConvexHull(self) OGRGeometryH OGR_G_ConvexHull(OGRGeometryH hTarget) | source code
Buffer(self, *args, **kwargs) Buffer(self, double distance, int quadsecs = 30) -> Geometry | source code
Intersection(self, *args) Intersection(self, Geometry other) -> Geometry | source code
Union(self, *args) Union(self, Geometry other) -> Geometry | source code
Geometry |
UnionCascaded(self) OGRGeometryH OGR_G_UnionCascaded(OGRGeometryH hThis) | source code
Difference(self, *args) Difference(self, Geometry other) -> Geometry | source code
SymDifference(self, *args) SymDifference(self, Geometry other) -> Geometry | source code
SymmetricDifference(self, *args) SymmetricDifference(self, Geometry other) -> Geometry | source code
Distance(self, *args) Distance(self, Geometry other) -> double | source code
Empty(self) void OGR_G_Empty(OGRGeometryH hGeom) | source code
bool |
IsEmpty(self) int OGR_G_IsEmpty(OGRGeometryH hGeom) | source code
bool |
IsValid(self) int OGR_G_IsValid(OGRGeometryH hGeom) | source code
bool |
IsSimple(self) int OGR_G_IsSimple(OGRGeometryH hGeom) | source code
bool |
IsRing(self) int OGR_G_IsRing(OGRGeometryH hGeom) | source code
Intersects(self, *args) Intersects(self, Geometry other) -> bool | source code
Intersect(self, *args) Intersect(self, Geometry other) -> bool | source code
Equals(self, *args) Equals(self, Geometry other) -> bool | source code
Equal(self, *args) Equal(self, Geometry other) -> bool | source code
Disjoint(self, *args) Disjoint(self, Geometry other) -> bool | source code
Touches(self, *args) Touches(self, Geometry other) -> bool | source code
Crosses(self, *args) Crosses(self, Geometry other) -> bool | source code
Within(self, *args) Within(self, Geometry other) -> bool | source code
Contains(self, *args) Contains(self, Geometry other) -> bool | source code
Overlaps(self, *args) Overlaps(self, Geometry other) -> bool | source code
TransformTo(self, *args) TransformTo(self, SpatialReference reference) -> OGRErr | source code
Transform(self, *args) Transform(self, CoordinateTransformation trans) -> OGRErr | source code
SpatialReference |
GetSpatialReference(self) OGRSpatialReferenceH OGR_G_GetSpatialReference(OGRGeometryH hGeom) | source code
AssignSpatialReference(self, *args) AssignSpatialReference(self, SpatialReference reference) | source code
CloseRings(self) void OGR_G_CloseRings(OGRGeometryH hGeom) | source code
FlattenTo2D(self) void OGR_G_FlattenTo2D(OGRGeometryH hGeom) | source code
Segmentize(self, *args) Segmentize(self, double dfMaxLength) | source code
GetEnvelope(self) void OGR_G_GetEnvelope(OGRGeometryH hGeom, OGREnvelope *psEnvelope) | source code
GetEnvelope3D(self) void OGR_G_GetEnvelope3D(OGRGeometryH hGeom, OGREnvelope3D *psEnvelope) | source code
Geometry |
Centroid(self) int OGR_G_Centroid(OGRGeometryH hGeom, OGRGeometryH hCentroidPoint) | source code
Geometry |
PointOnSurface(self) OGRGeometryH OGR_G_PointOnSurface(OGRGeometryH hGeom) | source code
int |
WkbSize(self) int OGR_G_WkbSize(OGRGeometryH hGeom) | source code
int |
GetCoordinateDimension(self) int OGR_G_GetCoordinateDimension(OGRGeometryH hGeom) | source code
int |
CoordinateDimension(self) int OGR_G_CoordinateDimension(OGRGeometryH hGeom) | source code
int |
Is3D(self) int OGR_G_Is3D(OGRGeometryH hGeom) | source code
int |
IsMeasured(self) int OGR_G_IsMeasured(OGRGeometryH hGeom) | source code
SetCoordinateDimension(self, *args) SetCoordinateDimension(self, int dimension) | source code
Set3D(self, *args) Set3D(self, int b3D) | source code
SetMeasured(self, *args) SetMeasured(self, int bMeasured) | source code
int |
GetDimension(self) int OGR_G_GetDimension(OGRGeometryH hGeom) | source code
HasCurveGeometry(self, *args) HasCurveGeometry(self, int bLookForCircular = True) -> int | source code
GetLinearGeometry(self, *args, **kwargs) GetLinearGeometry(self, double dfMaxAngleStepSizeDegrees = 0.0, char options = None) -> Geometry | source code
GetCurveGeometry(self, *args, **kwargs) GetCurveGeometry(self, char options = None) -> Geometry | source code
Value(self, *args) Value(self, double dfDistance) -> Geometry | source code
Destroy(self) | source code
__str__(self) | source code
__reduce__(self) | source code
__setstate__(self, state) | source code
__iter__(self) | source code
next(self) | source code

Class Variables | [hide private]
| __swig_setmethods__ = `{}`
| __setattr__ = `lambda self, name, value:`
| __swig_getmethods__ = `{}`
| __getattr__ = `lambda self, name:`
| __swig_destroy__ = `_ogr.delete_Geometry`
| __del__ = `lambda self:`

Method Details | [hide private]

### __init__(self, *args, **kwargs) (Constructor) | source code
    __init__(self, OGRwkbGeometryType type = wkbUnknown, char wkt = None,
        int wkb = 0, char gml = None) -> Geometry

### ExportToWkt(self) | source code
    OGRErr
    OGR_G_ExportToWkt(OGRGeometryH hGeom, char **ppszSrcText)

    Convert a geometry into well known text format.

    This function relates to the SFCOM IWks::ExportToWKT() method.

    For backward compatibility purposes, it exports the Old-style 99-402
    extended dimension (Z) WKB types for types Point, LineString, Polygon,
    MultiPoint, MultiLineString, MultiPolygon and GeometryCollection. For
    other geometry types, it is equivalent to OGR_G_ExportToIsoWkt().

    This function is the same as the CPP method
    OGRGeometry::exportToWkt().

    Parameters:
    -----------

    hGeom:  handle on the geometry to convert to a text format from.

    ppszSrcText:  a text buffer is allocated by the program, and assigned
    to the passed pointer. After use, *ppszDstText should be freed with
    OGRFree().

    Currently OGRERR_NONE is always returned.
Returns: OGRErr

### ExportToIsoWkt(self) | source code
    OGRErr
    OGR_G_ExportToIsoWkt(OGRGeometryH hGeom, char **ppszSrcText)

    Convert a geometry into SFSQL 1.2 / ISO SQL/MM Part 3 well known text
    format.

    This function relates to the SFCOM IWks::ExportToWKT() method. It
    exports the SFSQL 1.2 and ISO SQL/MM Part 3 extended dimension (Z&M)
    WKB types

    This function is the same as the CPP method
    OGRGeometry::exportToWkt(,wkbVariantIso).

    Parameters:
    -----------

    hGeom:  handle on the geometry to convert to a text format from.

    ppszSrcText:  a text buffer is allocated by the program, and assigned
    to the passed pointer. After use, *ppszDstText should be freed with
    OGRFree().

    Currently OGRERR_NONE is always returned.

    GDAL 2.0
Returns: OGRErr

### ExportToWkb(self, *args, **kwargs) | source code
    ExportToWkb(self, OGRwkbByteOrder byte_order = wkbXDR) -> OGRErr

    OGRErr
    OGR_G_ExportToWkb(OGRGeometryH hGeom, OGRwkbByteOrder eOrder, unsigned
    char *pabyDstBuffer)

    Convert a geometry well known binary format.

    This function relates to the SFCOM IWks::ExportToWKB() method.

    For backward compatibility purposes, it exports the Old-style 99-402
    extended dimension (Z) WKB types for types Point, LineString, Polygon,
    MultiPoint, MultiLineString, MultiPolygon and GeometryCollection. For
    other geometry types, it is equivalent to OGR_G_ExportToIsoWkb().

    This function is the same as the CPP method
    OGRGeometry::exportToWkb(OGRwkbByteOrder, unsigned char *,
    OGRwkbVariant) with eWkbVariant = wkbVariantOldOgc.

    Parameters:
    -----------

    hGeom:  handle on the geometry to convert to a well know binary data
    from.

    eOrder:  One of wkbXDR or wkbNDR indicating MSB or LSB byte order
    respectively.

    pabyDstBuffer:  a buffer into which the binary representation is
    written. This buffer must be at least OGR_G_WkbSize() byte in size.

    Currently OGRERR_NONE is always returned.

### ExportToIsoWkb(self, *args, **kwargs) | source code
    ExportToIsoWkb(self, OGRwkbByteOrder byte_order = wkbXDR) -> OGRErr

    OGRErr
    OGR_G_ExportToIsoWkb(OGRGeometryH hGeom, OGRwkbByteOrder eOrder,
    unsigned char *pabyDstBuffer)

    Convert a geometry into SFSQL 1.2 / ISO SQL/MM Part 3 well known
    binary format.

    This function relates to the SFCOM IWks::ExportToWKB() method. It
    exports the SFSQL 1.2 and ISO SQL/MM Part 3 extended dimension (Z&M)
    WKB types

    This function is the same as the CPP method
    OGRGeometry::exportToWkb(OGRwkbByteOrder, unsigned char *,
    OGRwkbVariant) with eWkbVariant = wkbVariantIso.

    Parameters:
    -----------

    hGeom:  handle on the geometry to convert to a well know binary data
    from.

    eOrder:  One of wkbXDR or wkbNDR indicating MSB or LSB byte order
    respectively.

    pabyDstBuffer:  a buffer into which the binary representation is
    written. This buffer must be at least OGR_G_WkbSize() byte in size.

    Currently OGRERR_NONE is always returned.

    GDAL 2.0

### Clone(self) | source code
    OGRGeometryH OGR_G_Clone(OGRGeometryH
    hGeom)

    Make a copy of this object.

    This function relates to the SFCOM IGeometry::clone() method.

    This function is the same as the CPP method OGRGeometry::clone().

    Parameters:
    -----------

    hGeom:  handle on the geometry to clone from.

    an handle on the copy of the geometry with the spatial reference
    system as the original.
Returns: Geometry

### GetGeometryType(self) | source code
    OGRwkbGeometryType
    OGR_G_GetGeometryType(OGRGeometryH hGeom)

    Fetch geometry type.

    Note that the geometry type may include the 2.5D flag. To get a 2D
    flattened version of the geometry type apply the wkbFlatten() macro to
    the return result.

    This function is the same as the CPP method
    OGRGeometry::getGeometryType().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get type from.

    the geometry type code.
Returns: OGRwkbGeometryType

### GetGeometryName(self) | source code
    const char*
    OGR_G_GetGeometryName(OGRGeometryH hGeom)

    Fetch WKT name for geometry type.

    There is no SFCOM analog to this function.

    This function is the same as the CPP method
    OGRGeometry::getGeometryName().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get name from.

    name used for this geometry type in well known text format.
Returns: char

### Simplify(self, *args) | source code
    Simplify(self, double tolerance) -> Geometry

    OGRGeometryH
    OGR_G_Simplify(OGRGeometryH hThis, double dTolerance)

    Compute a simplified geometry.

    This function is the same as the C++ method OGRGeometry::Simplify().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    dTolerance:  the distance tolerance for the simplification.

    the simplified geometry or NULL if an error occurs.

    OGR 1.8.0

### SimplifyPreserveTopology(self, *args) | source code
    SimplifyPreserveTopology(self, double tolerance) -> Geometry

    OGRGeometryH
    OGR_G_SimplifyPreserveTopology(OGRGeometryH hThis, double dTolerance)

    Simplify the geometry while preserving topology.

    This function is the same as the C++ method
    OGRGeometry::SimplifyPreserveTopology().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    dTolerance:  the distance tolerance for the simplification.

    the simplified geometry or NULL if an error occurs.

    OGR 1.9.0

### DelaunayTriangulation(self, *args, **kwargs) | source code
    DelaunayTriangulation(self, double dfTolerance = 0.0, int bOnlyEdges = True) -> Geometry

    OGRGeometryH
    OGR_G_DelaunayTriangulation(OGRGeometryH hThis, double dfTolerance,
    int bOnlyEdges)

    Return a Delaunay triangulation of the vertices of the geometry.

    This function is the same as the C++ method
    OGRGeometry::DelaunayTriangulation().

    This function is built on the GEOS library, v3.4 or above. If OGR is
    built without the GEOS library, this function will always fail,
    issuing a CPLE_NotSupported error.

    Parameters:
    -----------

    hThis:  the geometry.

    dfTolerance:  optional snapping tolerance to use for improved
    robustness

    bOnlyEdges:  if TRUE, will return a MULTILINESTRING, otherwise it will
    return a GEOMETRYCOLLECTION containing triangular POLYGONs.

    the geometry resulting from the Delaunay triangulation or NULL if an
    error occurs.

    OGR 2.1

### Boundary(self) | source code
    OGRGeometryH
    OGR_G_Boundary(OGRGeometryH hTarget)

    Compute boundary.

    A new geometry object is created and returned containing the boundary
    of the geometry on which the method is invoked.

    This function is the same as the C++ method OGR_G_Boundary().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hTarget:  The Geometry to calculate the boundary of.

    a handle to a newly allocated geometry now owned by the caller, or
    NULL on failure.

    OGR 1.8.0
Returns: Geometry

### GetBoundary(self) | source code
OGRGeometryH OGR_G_GetBoundary(OGRGeometryH hTarget) Compute boundary (deprecated). Deprecated See: OGR_G_Boundary() Returns: Geometry

### ConvexHull(self) | source code
    OGRGeometryH
    OGR_G_ConvexHull(OGRGeometryH hTarget)

    Compute convex hull.

    A new geometry object is created and returned containing the convex
    hull of the geometry on which the method is invoked.

    This function is the same as the C++ method OGRGeometry::ConvexHull().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hTarget:  The Geometry to calculate the convex hull of.

    a handle to a newly allocated geometry now owned by the caller, or
    NULL on failure.
Returns: Geometry

### Buffer(self, *args, **kwargs) | source code
    Buffer(self, double distance, int quadsecs = 30) -> Geometry

    OGRGeometryH OGR_G_Buffer(OGRGeometryH
    hTarget, double dfDist, int nQuadSegs)

    Compute buffer of geometry.

    Builds a new geometry containing the buffer region around the geometry
    on which it is invoked. The buffer is a polygon containing the region
    within the buffer distance of the original geometry.

    Some buffer sections are properly described as curves, but are
    converted to approximate polygons. The nQuadSegs parameter can be used
    to control how many segments should be used to define a 90 degree
    curve - a quadrant of a circle. A value of 30 is a reasonable default.
    Large values result in large numbers of vertices in the resulting
    buffer geometry while small numbers reduce the accuracy of the result.

    This function is the same as the C++ method OGRGeometry::Buffer().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hTarget:  the geometry.

    dfDist:  the buffer distance to be applied. Should be expressed into
    the same unit as the coordinates of the geometry.

    nQuadSegs:  the number of segments used to approximate a 90 degree
    (quadrant) of curvature.

    the newly created geometry, or NULL if an error occurs.

### Intersection(self, *args) | source code
    Intersection(self, Geometry other) -> Geometry

    OGRGeometryH
    OGR_G_Intersection(OGRGeometryH hThis, OGRGeometryH hOther)

    Compute intersection.

    Generates a new geometry which is the region of intersection of the
    two geometries operated on. The OGR_G_Intersects() function can be
    used to test if two geometries intersect.

    This function is the same as the C++ method
    OGRGeometry::Intersection().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    hOther:  the other geometry.

    a new geometry representing the intersection or NULL if there is no
    intersection or an error occurs.

### Union(self, *args) | source code
    Union(self, Geometry other) -> Geometry

    OGRGeometryH OGR_G_Union(OGRGeometryH
    hThis, OGRGeometryH hOther)

    Compute union.

    Generates a new geometry which is the region of union of the two
    geometries operated on.

    This function is the same as the C++ method OGRGeometry::Union().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    hOther:  the other geometry.

    a new geometry representing the union or NULL if an error occurs.

### UnionCascaded(self) | source code
    OGRGeometryH
    OGR_G_UnionCascaded(OGRGeometryH hThis)

    Compute union using cascading.

    This function is the same as the C++ method
    OGRGeometry::UnionCascaded().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    a new geometry representing the union or NULL if an error occurs.
Returns: Geometry

### Difference(self, *args) | source code
    Difference(self, Geometry other) -> Geometry

    OGRGeometryH
    OGR_G_Difference(OGRGeometryH hThis, OGRGeometryH hOther)

    Compute difference.

    Generates a new geometry which is the region of this geometry with the
    region of the other geometry removed.

    This function is the same as the C++ method OGRGeometry::Difference().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    hOther:  the other geometry.

    a new geometry representing the difference or NULL if the difference
    is empty or an error occurs.

### SymDifference(self, *args) | source code
    SymDifference(self, Geometry other) -> Geometry

    OGRGeometryH
    OGR_G_SymDifference(OGRGeometryH hThis, OGRGeometryH hOther)

    Compute symmetric difference.

    Generates a new geometry which is the symmetric difference of this
    geometry and the other geometry.

    This function is the same as the C++ method
    OGRGeometry::SymmetricDifference().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry.

    hOther:  the other geometry.

    a new geometry representing the symmetric difference or NULL if the
    difference is empty or an error occurs.

    OGR 1.8.0

### SymmetricDifference(self, *args) | source code
SymmetricDifference(self, Geometry other) -> Geometry OGRGeometryH OGR_G_SymmetricDifference(OGRGeometryH hThis, OGRGeometryH hOther) Compute symmetric difference (deprecated). Deprecated See: OGR_G_SymmetricDifference()

### Distance(self, *args) | source code
    Distance(self, Geometry other) -> double

    double OGR_G_Distance(OGRGeometryH
    hFirst, OGRGeometryH hOther)

    Compute distance between two geometries.

    Returns the shortest distance between the two geometries. The distance
    is expressed into the same unit as the coordinates of the geometries.

    This function is the same as the C++ method OGRGeometry::Distance().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hFirst:  the first geometry to compare against.

    hOther:  the other geometry to compare against.

    the distance between the geometries or -1 if an error occurs.

### Empty(self) | source code
    void OGR_G_Empty(OGRGeometryH hGeom)

    Clear geometry information.

    This restores the geometry to it's initial state after construction,
    and before assignment of actual geometry.

    This function relates to the SFCOM IGeometry::Empty() method.

    This function is the same as the CPP method OGRGeometry::empty().

    Parameters:
    -----------

    hGeom:  handle on the geometry to empty.

### IsEmpty(self) | source code
    int OGR_G_IsEmpty(OGRGeometryH hGeom)

    Test if the geometry is empty.

    This method is the same as the CPP method OGRGeometry::IsEmpty().

    Parameters:
    -----------

    hGeom:  The Geometry to test.

    TRUE if the geometry has no points, otherwise FALSE.
Returns: bool

### IsValid(self) | source code
    int OGR_G_IsValid(OGRGeometryH hGeom)

    Test if the geometry is valid.

    This function is the same as the C++ method OGRGeometry::IsValid().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always return FALSE.

    Parameters:
    -----------

    hGeom:  The Geometry to test.

    TRUE if the geometry has no points, otherwise FALSE.
Returns: bool

### IsSimple(self) | source code
    int OGR_G_IsSimple(OGRGeometryH
    hGeom)

    Returns TRUE if the geometry is simple.

    Returns TRUE if the geometry has no anomalous geometric points, such
    as self intersection or self tangency. The description of each
    instantiable geometric class will include the specific conditions that
    cause an instance of that class to be classified as not simple.

    This function is the same as the c++ method OGRGeometry::IsSimple()
    method.

    If OGR is built without the GEOS library, this function will always
    return FALSE.

    Parameters:
    -----------

    hGeom:  The Geometry to test.

    TRUE if object is simple, otherwise FALSE.
Returns: bool

### IsRing(self) | source code
    int OGR_G_IsRing(OGRGeometryH hGeom)

    Test if the geometry is a ring.

    This function is the same as the C++ method OGRGeometry::IsRing().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always return FALSE.

    Parameters:
    -----------

    hGeom:  The Geometry to test.

    TRUE if the geometry has no points, otherwise FALSE.
Returns: bool

### Intersects(self, *args) | source code
    Intersects(self, Geometry other) -> bool

    int OGR_G_Intersects(OGRGeometryH
    hGeom, OGRGeometryH hOtherGeom)

    Do these features intersect?

    Determines whether two geometries intersect. If GEOS is enabled, then
    this is done in rigorous fashion otherwise TRUE is returned if the
    envelopes (bounding boxes) of the two geometries overlap.

    This function is the same as the CPP method OGRGeometry::Intersects.

    Parameters:
    -----------

    hGeom:  handle on the first geometry.

    hOtherGeom:  handle on the other geometry to test against.

    TRUE if the geometries intersect, otherwise FALSE.

### Intersect(self, *args) | source code
Intersect(self, Geometry other) -> bool int OGR_G_Intersect(OGRGeometryH hGeom, OGRGeometryH hOtherGeom)

### Equals(self, *args) | source code
    Equals(self, Geometry other) -> bool

    int OGR_G_Equals(OGRGeometryH hGeom,
    OGRGeometryH hOther)

    Returns TRUE if two geometries are equivalent.

    This function is the same as the CPP method OGRGeometry::Equals()
    method.

    Parameters:
    -----------

    hGeom:  handle on the first geometry.

    hOther:  handle on the other geometry to test against.

    TRUE if equivalent or FALSE otherwise.

### Equal(self, *args) | source code
Equal(self, Geometry other) -> bool int OGR_G_Equal(OGRGeometryH hGeom, OGRGeometryH hOther)

### Disjoint(self, *args) | source code
    Disjoint(self, Geometry other) -> bool

    int OGR_G_Disjoint(OGRGeometryH
    hThis, OGRGeometryH hOther)

    Test for disjointness.

    Tests if this geometry and the other geometry are disjoint.

    This function is the same as the C++ method OGRGeometry::Disjoint().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry to compare.

    hOther:  the other geometry to compare.

    TRUE if they are disjoint, otherwise FALSE.

### Touches(self, *args) | source code
    Touches(self, Geometry other) -> bool

    int OGR_G_Touches(OGRGeometryH hThis,
    OGRGeometryH hOther)

    Test for touching.

    Tests if this geometry and the other geometry are touching.

    This function is the same as the C++ method OGRGeometry::Touches().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry to compare.

    hOther:  the other geometry to compare.

    TRUE if they are touching, otherwise FALSE.

### Crosses(self, *args) | source code
    Crosses(self, Geometry other) -> bool

    int OGR_G_Crosses(OGRGeometryH hThis,
    OGRGeometryH hOther)

    Test for crossing.

    Tests if this geometry and the other geometry are crossing.

    This function is the same as the C++ method OGRGeometry::Crosses().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry to compare.

    hOther:  the other geometry to compare.

    TRUE if they are crossing, otherwise FALSE.

### Within(self, *args) | source code
    Within(self, Geometry other) -> bool

    int OGR_G_Within(OGRGeometryH hThis,
    OGRGeometryH hOther)

    Test for containment.

    Tests if this geometry is within the other geometry.

    This function is the same as the C++ method OGRGeometry::Within().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry to compare.

    hOther:  the other geometry to compare.

    TRUE if hThis is within hOther, otherwise FALSE.

### Contains(self, *args) | source code
    Contains(self, Geometry other) -> bool

    int OGR_G_Contains(OGRGeometryH
    hThis, OGRGeometryH hOther)

    Test for containment.

    Tests if this geometry contains the other geometry.

    This function is the same as the C++ method OGRGeometry::Contains().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry to compare.

    hOther:  the other geometry to compare.

    TRUE if hThis contains hOther geometry, otherwise FALSE.

### Overlaps(self, *args) | source code
    Overlaps(self, Geometry other) -> bool

    int OGR_G_Overlaps(OGRGeometryH
    hThis, OGRGeometryH hOther)

    Test for overlap.

    Tests if this geometry and the other geometry overlap, that is their
    intersection has a non-zero area.

    This function is the same as the C++ method OGRGeometry::Overlaps().

    This function is built on the GEOS library, check it for the
    definition of the geometry operation. If OGR is built without the GEOS
    library, this function will always fail, issuing a CPLE_NotSupported
    error.

    Parameters:
    -----------

    hThis:  the geometry to compare.

    hOther:  the other geometry to compare.

    TRUE if they are overlapping, otherwise FALSE.

### TransformTo(self, *args) | source code
    TransformTo(self, SpatialReference reference) -> OGRErr

    OGRErr
    OGR_G_TransformTo(OGRGeometryH hGeom, OGRSpatialReferenceH hSRS)

    Transform geometry to new spatial reference system.

    This function will transform the coordinates of a geometry from their
    current spatial reference system to a new target spatial reference
    system. Normally this means reprojecting the vectors, but it could
    include datum shifts, and changes of units.

    This function will only work if the geometry already has an assigned
    spatial reference system, and if it is transformable to the target
    coordinate system.

    Because this function requires internal creation and initialization of
    an OGRCoordinateTransformation object it is significantly more
    expensive to use this function to transform many geometries than it is
    to create the OGRCoordinateTransformation in advance, and call
    transform() with that transformation. This function exists primarily
    for convenience when only transforming a single geometry.

    This function is the same as the CPP method OGRGeometry::transformTo.

    Parameters:
    -----------

    hGeom:  handle on the geometry to apply the transform to.

    hSRS:  handle on the spatial reference system to apply.

    OGRERR_NONE on success, or an error code.

### Transform(self, *args) | source code
    Transform(self, CoordinateTransformation trans) -> OGRErr

    OGRErr OGR_G_Transform(OGRGeometryH
    hGeom, OGRCoordinateTransformationH hTransform)

    Apply arbitrary coordinate transformation to geometry.

    This function will transform the coordinates of a geometry from their
    current spatial reference system to a new target spatial reference
    system. Normally this means reprojecting the vectors, but it could
    include datum shifts, and changes of units.

    Note that this function does not require that the geometry already
    have a spatial reference system. It will be assumed that they can be
    treated as having the source spatial reference system of the
    OGRCoordinateTransformation object, and the actual SRS of the geometry
    will be ignored. On successful completion the output
    OGRSpatialReference of the OGRCoordinateTransformation will be
    assigned to the geometry.

    This function is the same as the CPP method OGRGeometry::transform.

    Parameters:
    -----------

    hGeom:  handle on the geometry to apply the transform to.

    hTransform:  handle on the transformation to apply.

    OGRERR_NONE on success or an error code.

### GetSpatialReference(self) | source code
    OGRSpatialReferenceH
    OGR_G_GetSpatialReference(OGRGeometryH hGeom)

    Returns spatial reference system for geometry.

    This function relates to the SFCOM IGeometry::get_SpatialReference()
    method.

    This function is the same as the CPP method
    OGRGeometry::getSpatialReference().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get spatial reference from.

    a reference to the spatial reference geometry.
Returns: SpatialReference

### AssignSpatialReference(self, *args) | source code
    AssignSpatialReference(self, SpatialReference reference)

    void
    OGR_G_AssignSpatialReference(OGRGeometryH hGeom, OGRSpatialReferenceH
    hSRS)

    Assign spatial reference to this object.

    Any existing spatial reference is replaced, but under no circumstances
    does this result in the object being reprojected. It is just changing
    the interpretation of the existing geometry. Note that assigning a
    spatial reference increments the reference count on the
    OGRSpatialReference, but does not copy it.

    This is similar to the SFCOM IGeometry::put_SpatialReference() method.

    This function is the same as the CPP method
    OGRGeometry::assignSpatialReference.

    Parameters:
    -----------

    hGeom:  handle on the geometry to apply the new spatial reference
    system.

    hSRS:  handle on the new spatial reference system to apply.

### CloseRings(self) | source code
    void OGR_G_CloseRings(OGRGeometryH
    hGeom)

    Force rings to be closed.

    If this geometry, or any contained geometries has polygon rings that
    are not closed, they will be closed by adding the starting point at
    the end.

    Parameters:
    -----------

    hGeom:  handle to the geometry.

### FlattenTo2D(self) | source code
    void
    OGR_G_FlattenTo2D(OGRGeometryH hGeom)

    Convert geometry to strictly 2D.

    In a sense this converts all Z coordinates to 0.0.

    This function is the same as the CPP method
    OGRGeometry::flattenTo2D().

    Parameters:
    -----------

    hGeom:  handle on the geometry to convert.

### Segmentize(self, *args) | source code
    Segmentize(self, double dfMaxLength)

    void OGR_G_Segmentize(OGRGeometryH
    hGeom, double dfMaxLength)

    Modify the geometry such it has no segment longer then the given
    distance.

    Interpolated points will have Z and M values (if needed) set to 0.
    Distance computation is performed in 2d only

    This function is the same as the CPP method OGRGeometry::segmentize().

    Parameters:
    -----------

    hGeom:  handle on the geometry to segmentize

    dfMaxLength:  the maximum distance between 2 points after
    segmentization

### GetEnvelope(self) | source code
    void
    OGR_G_GetEnvelope(OGRGeometryH hGeom, OGREnvelope *psEnvelope)

    Computes and returns the bounding envelope for this geometry in the
    passed psEnvelope structure.

    This function is the same as the CPP method
    OGRGeometry::getEnvelope().

    Parameters:
    -----------

    hGeom:  handle of the geometry to get envelope from.

    psEnvelope:  the structure in which to place the results.

### GetEnvelope3D(self) | source code
    void
    OGR_G_GetEnvelope3D(OGRGeometryH hGeom, OGREnvelope3D *psEnvelope)

    Computes and returns the bounding envelope (3D) for this geometry in
    the passed psEnvelope structure.

    This function is the same as the CPP method
    OGRGeometry::getEnvelope().

    Parameters:
    -----------

    hGeom:  handle of the geometry to get envelope from.

    psEnvelope:  the structure in which to place the results.

    OGR 1.9.0

### Centroid(self) | source code
int OGR_G_Centroid(OGRGeometryH hGeom, OGRGeometryH hCentroidPoint) Compute the geometry centroid. The centroid location is applied to the passed in OGRPoint object. The centroid is not necessarily within the geometry. This method relates to the SFCOM ISurface::get_Centroid() method however the current implementation based on GEOS can operate on other geometry types such as multipoint, linestring, geometrycollection such as multipolygons. OGC SF SQL 1.1 defines the operation for surfaces (polygons). SQL/MM-Part 3 defines the operation for surfaces and multisurfaces (multipolygons). This function is the same as the C++ method OGRGeometry::Centroid(). This function is built on the GEOS library, check it for the definition of the geometry operation. If OGR is built without the GEOS library, this function will always fail, issuing a CPLE_NotSupported error. OGRERR_NONE on success or OGRERR_FAILURE on error. Returns: Geometry

### PointOnSurface(self) | source code
    OGRGeometryH
    OGR_G_PointOnSurface(OGRGeometryH hGeom)

    Returns a point guaranteed to lie on the surface.

    This method relates to the SFCOM ISurface::get_PointOnSurface() method
    however the current implementation based on GEOS can operate on other
    geometry types than the types that are supported by SQL/MM-Part 3 :
    surfaces (polygons) and multisurfaces (multipolygons).

    This method is built on the GEOS library, check it for the definition
    of the geometry operation. If OGR is built without the GEOS library,
    this method will always fail, issuing a CPLE_NotSupported error.

    Parameters:
    -----------

    hGeom:  the geometry to operate on.

    a point guaranteed to lie on the surface or NULL if an error occurred.

    OGR 1.10
Returns: Geometry

### WkbSize(self) | source code
    int OGR_G_WkbSize(OGRGeometryH hGeom)

    Returns size of related binary representation.

    This function returns the exact number of bytes required to hold the
    well known binary representation of this geometry object. Its
    computation may be slightly expensive for complex geometries.

    This function relates to the SFCOM IWks::WkbSize() method.

    This function is the same as the CPP method OGRGeometry::WkbSize().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get the binary size from.

    size of binary representation in bytes.
Returns: int

### GetCoordinateDimension(self) | source code
    int
    OGR_G_GetCoordinateDimension(OGRGeometryH hGeom)

    Get the dimension of the coordinates in this geometry.

    This function is the same as the CPP method
    OGRGeometry::getCoordinateDimension().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get the dimension of the coordinates
    from.

    Deprecated use OGR_G_CoordinateDimension(), OGR_G_Is3D(), or
    OGR_G_IsMeasured().

    this will return 2 or 3.
Returns: int

### CoordinateDimension(self) | source code
    int
    OGR_G_CoordinateDimension(OGRGeometryH hGeom)

    Get the dimension of the coordinates in this geometry.

    This function is the same as the CPP method
    OGRGeometry::CoordinateDimension().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get the dimension of the coordinates
    from.

    this will return 2 for XY, 3 for XYZ and XYM, and 4 for XYZM data.
Returns: int

### Is3D(self) | source code
    int OGR_G_Is3D(OGRGeometryH hGeom)

    See whether this geometry has Z coordinates.

    This function is the same as the CPP method OGRGeometry::Is3D().

    Parameters:
    -----------

    hGeom:  handle on the geometry to check whether it has Z coordinates.

    TRUE if the geometry has Z coordinates.

    GDAL 2.1
Returns: int

### IsMeasured(self) | source code
    int OGR_G_IsMeasured(OGRGeometryH
    hGeom)

    See whether this geometry is measured.

    This function is the same as the CPP method OGRGeometry::IsMeasured().

    Parameters:
    -----------

    hGeom:  handle on the geometry to check whether it is measured.

    TRUE if the geometry has M coordinates.

    GDAL 2.1
Returns: int

### SetCoordinateDimension(self, *args) | source code
    SetCoordinateDimension(self, int dimension)

    void
    OGR_G_SetCoordinateDimension(OGRGeometryH hGeom, int nNewDimension)

    Set the coordinate dimension.

    This method sets the explicit coordinate dimension. Setting the
    coordinate dimension of a geometry to 2 should zero out any existing Z
    values. Setting the dimension of a geometry collection, a compound
    curve, a polygon, etc. will affect the children geometries. This will
    also remove the M dimension if present before this call.

    Deprecated use OGR_G_Set3D() or OGR_G_SetMeasured().

    Parameters:
    -----------

    hGeom:  handle on the geometry to set the dimension of the
    coordinates.

    nNewDimension:  New coordinate dimension value, either 2 or 3.

### Set3D(self, *args) | source code
    Set3D(self, int b3D)

    void OGR_G_Set3D(OGRGeometryH hGeom,
    int bIs3D)

    Add or remove the Z coordinate dimension.

    This method adds or removes the explicit Z coordinate dimension.
    Removing the Z coordinate dimension of a geometry will remove any
    existing Z values. Adding the Z dimension to a geometry collection, a
    compound curve, a polygon, etc. will affect the children geometries.

    Parameters:
    -----------

    hGeom:  handle on the geometry to set or unset the Z dimension.

    bIs3D:  Should the geometry have a Z dimension, either TRUE or FALSE.

    GDAL 2.1

### SetMeasured(self, *args) | source code
    SetMeasured(self, int bMeasured)

    void
    OGR_G_SetMeasured(OGRGeometryH hGeom, int bIsMeasured)

    Set the coordinate dimension.

    Add or remove the M coordinate dimension. This method adds or removes
    the explicit M coordinate dimension. Removing the M coordinate
    dimension of a geometry will remove any existing M values. Adding the
    M dimension to a geometry collection, a compound curve, a polygon,
    etc. will affect the children geometries.

    Parameters:
    -----------

    hGeom:  handle on the geometry to set or unset the M dimension.

    bIsMeasured:  Should the geometry have a M dimension, either TRUE or
    FALSE.

    GDAL 2.1

### GetDimension(self) | source code
    int
    OGR_G_GetDimension(OGRGeometryH hGeom)

    Get the dimension of this geometry.

    This function corresponds to the SFCOM IGeometry::GetDimension()
    method. It indicates the dimension of the geometry, but does not
    indicate the dimension of the underlying space (as indicated by
    OGR_G_GetCoordinateDimension() function).

    This function is the same as the CPP method
    OGRGeometry::getDimension().

    Parameters:
    -----------

    hGeom:  handle on the geometry to get the dimension from.

    0 for points, 1 for lines and 2 for surfaces.
Returns: int