nmelone/aws-lambda-container
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit

Browse Source
This commit is contained in:
Nico Melone
2023-08-24 17:49:47 -05:00
parent 23b7279c0f
commit 72d3f2c348
5422 changed files with 890638 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

886
billinglayer/python/shapely/_geometry.py Normal file
View File

@@ -0,0 +1,886 @@
import warnings
from enum import IntEnum
import numpy as np
from . import _geometry_helpers, geos_version, lib
from ._enum import ParamEnum
from .decorators import multithreading_enabled, requires_geos
__all__ = [
"GeometryType",
"get_type_id",
"get_dimensions",
"get_coordinate_dimension",
"get_num_coordinates",
"get_srid",
"set_srid",
"get_x",
"get_y",
"get_z",
"get_exterior_ring",
"get_num_points",
"get_num_interior_rings",
"get_num_geometries",
"get_point",
"get_interior_ring",
"get_geometry",
"get_parts",
"get_rings",
"get_precision",
"set_precision",
"force_2d",
"force_3d",
]
class GeometryType(IntEnum):
"""The enumeration of GEOS geometry types"""
MISSING = -1
POINT = 0
LINESTRING = 1
LINEARRING = 2
POLYGON = 3
MULTIPOINT = 4
MULTILINESTRING = 5
MULTIPOLYGON = 6
GEOMETRYCOLLECTION = 7
# generic
@multithreading_enabled
def get_type_id(geometry, **kwargs):
"""Returns the type ID of a geometry.
- None (missing) is -1
- POINT is 0
- LINESTRING is 1
- LINEARRING is 2
- POLYGON is 3
- MULTIPOINT is 4
- MULTILINESTRING is 5
- MULTIPOLYGON is 6
- GEOMETRYCOLLECTION is 7
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
GeometryType
Examples
--------
>>> from shapely import LineString, Point
>>> get_type_id(LineString([(0, 0), (1, 1), (2, 2), (3, 3)]))
1
>>> get_type_id([Point(1, 2), Point(2, 3)]).tolist()
[0, 0]
"""
return lib.get_type_id(geometry, **kwargs)
@multithreading_enabled
def get_dimensions(geometry, **kwargs):
"""Returns the inherent dimensionality of a geometry.
The inherent dimension is 0 for points, 1 for linestrings and linearrings,
and 2 for polygons. For geometrycollections it is the max of the containing
elements. Empty collections and None values return -1.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
Examples
--------
>>> from shapely import GeometryCollection, Point, Polygon
>>> point = Point(0, 0)
>>> get_dimensions(point)
0
>>> polygon = Polygon([(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)])
>>> get_dimensions(polygon)
2
>>> get_dimensions(GeometryCollection([point, polygon]))
2
>>> get_dimensions(GeometryCollection([]))
-1
>>> get_dimensions(None)
-1
"""
return lib.get_dimensions(geometry, **kwargs)
@multithreading_enabled
def get_coordinate_dimension(geometry, **kwargs):
"""Returns the dimensionality of the coordinates in a geometry (2 or 3).
Returns -1 for missing geometries (``None`` values). Note that if the first Z
coordinate equals ``nan``, this function will return ``2``.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
Examples
--------
>>> from shapely import Point
>>> get_coordinate_dimension(Point(0, 0))
2
>>> get_coordinate_dimension(Point(0, 0, 1))
3
>>> get_coordinate_dimension(None)
-1
>>> get_coordinate_dimension(Point(0, 0, float("nan")))
2
"""
return lib.get_coordinate_dimension(geometry, **kwargs)
@multithreading_enabled
def get_num_coordinates(geometry, **kwargs):
"""Returns the total number of coordinates in a geometry.
Returns 0 for not-a-geometry values.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
Examples
--------
>>> from shapely import GeometryCollection, LineString, Point
>>> point = Point(0, 0)
>>> get_num_coordinates(point)
1
>>> get_num_coordinates(Point(0, 0, 0))
1
>>> line = LineString([(0, 0), (1, 1)])
>>> get_num_coordinates(line)
2
>>> get_num_coordinates(GeometryCollection([point, line]))
3
>>> get_num_coordinates(None)
0
"""
return lib.get_num_coordinates(geometry, **kwargs)
@multithreading_enabled
def get_srid(geometry, **kwargs):
"""Returns the SRID of a geometry.
Returns -1 for not-a-geometry values.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
set_srid
Examples
--------
>>> from shapely import Point
>>> point = Point(0, 0)
>>> get_srid(point)
0
>>> with_srid = set_srid(point, 4326)
>>> get_srid(with_srid)
4326
"""
return lib.get_srid(geometry, **kwargs)
@multithreading_enabled
def set_srid(geometry, srid, **kwargs):
"""Returns a geometry with its SRID set.
Parameters
----------
geometry : Geometry or array_like
srid : int
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_srid
Examples
--------
>>> from shapely import Point
>>> point = Point(0, 0)
>>> get_srid(point)
0
>>> with_srid = set_srid(point, 4326)
>>> get_srid(with_srid)
4326
"""
return lib.set_srid(geometry, np.intc(srid), **kwargs)
# points
@multithreading_enabled
def get_x(point, **kwargs):
"""Returns the x-coordinate of a point
Parameters
----------
point : Geometry or array_like
Non-point geometries will result in NaN being returned.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_y, get_z
Examples
--------
>>> from shapely import MultiPoint, Point
>>> get_x(Point(1, 2))
1.0
>>> get_x(MultiPoint([(1, 1), (1, 2)]))
nan
"""
return lib.get_x(point, **kwargs)
@multithreading_enabled
def get_y(point, **kwargs):
"""Returns the y-coordinate of a point
Parameters
----------
point : Geometry or array_like
Non-point geometries will result in NaN being returned.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_x, get_z
Examples
--------
>>> from shapely import MultiPoint, Point
>>> get_y(Point(1, 2))
2.0
>>> get_y(MultiPoint([(1, 1), (1, 2)]))
nan
"""
return lib.get_y(point, **kwargs)
@requires_geos("3.7.0")
@multithreading_enabled
def get_z(point, **kwargs):
"""Returns the z-coordinate of a point.
Parameters
----------
point : Geometry or array_like
Non-point geometries or geometries without 3rd dimension will result
in NaN being returned.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_x, get_y
Examples
--------
>>> from shapely import MultiPoint, Point
>>> get_z(Point(1, 2, 3))
3.0
>>> get_z(Point(1, 2))
nan
>>> get_z(MultiPoint([(1, 1, 1), (2, 2, 2)]))
nan
"""
return lib.get_z(point, **kwargs)
# linestrings
@multithreading_enabled
def get_point(geometry, index, **kwargs):
"""Returns the nth point of a linestring or linearring.
Parameters
----------
geometry : Geometry or array_like
index : int or array_like
Negative values count from the end of the linestring backwards.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_num_points
Examples
--------
>>> from shapely import LinearRing, LineString, MultiPoint, Point
>>> line = LineString([(0, 0), (1, 1), (2, 2), (3, 3)])
>>> get_point(line, 1)
<POINT (1 1)>
>>> get_point(line, -2)
<POINT (2 2)>
>>> get_point(line, [0, 3]).tolist()
[<POINT (0 0)>, <POINT (3 3)>]
The functcion works the same for LinearRing input:
>>> get_point(LinearRing([(0, 0), (1, 1), (2, 2), (0, 0)]), 1)
<POINT (1 1)>
For non-linear geometries it returns None:
>>> get_point(MultiPoint([(0, 0), (1, 1), (2, 2), (3, 3)]), 1) is None
True
>>> get_point(Point(1, 1), 0) is None
True
"""
return lib.get_point(geometry, np.intc(index), **kwargs)
@multithreading_enabled
def get_num_points(geometry, **kwargs):
"""Returns number of points in a linestring or linearring.
Returns 0 for not-a-geometry values.
Parameters
----------
geometry : Geometry or array_like
The number of points in geometries other than linestring or linearring
equals zero.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_point
get_num_geometries
Examples
--------
>>> from shapely import LineString, MultiPoint
>>> get_num_points(LineString([(0, 0), (1, 1), (2, 2), (3, 3)]))
4
>>> get_num_points(MultiPoint([(0, 0), (1, 1), (2, 2), (3, 3)]))
0
>>> get_num_points(None)
0
"""
return lib.get_num_points(geometry, **kwargs)
# polygons
@multithreading_enabled
def get_exterior_ring(geometry, **kwargs):
"""Returns the exterior ring of a polygon.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_interior_ring
Examples
--------
>>> from shapely import Point, Polygon
>>> get_exterior_ring(Polygon([(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)]))
<LINEARRING (0 0, 0 10, 10 10, 10 0, 0 0)>
>>> get_exterior_ring(Point(1, 1)) is None
True
"""
return lib.get_exterior_ring(geometry, **kwargs)
@multithreading_enabled
def get_interior_ring(geometry, index, **kwargs):
"""Returns the nth interior ring of a polygon.
Parameters
----------
geometry : Geometry or array_like
index : int or array_like
Negative values count from the end of the interior rings backwards.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_exterior_ring
get_num_interior_rings
Examples
--------
>>> from shapely import Point, Polygon
>>> polygon_with_hole = Polygon(
... [(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)],
... holes=[[(2, 2), (2, 4), (4, 4), (4, 2), (2, 2)]]
... )
>>> get_interior_ring(polygon_with_hole, 0)
<LINEARRING (2 2, 2 4, 4 4, 4 2, 2 2)>
>>> get_interior_ring(polygon_with_hole, 1) is None
True
>>> polygon = Polygon([(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)])
>>> get_interior_ring(polygon, 0) is None
True
>>> get_interior_ring(Point(0, 0), 0) is None
True
"""
return lib.get_interior_ring(geometry, np.intc(index), **kwargs)
@multithreading_enabled
def get_num_interior_rings(geometry, **kwargs):
"""Returns number of internal rings in a polygon
Returns 0 for not-a-geometry values.
Parameters
----------
geometry : Geometry or array_like
The number of interior rings in non-polygons equals zero.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_exterior_ring
get_interior_ring
Examples
--------
>>> from shapely import Point, Polygon
>>> polygon = Polygon([(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)])
>>> get_num_interior_rings(polygon)
0
>>> polygon_with_hole = Polygon(
... [(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)],
... holes=[[(2, 2), (2, 4), (4, 4), (4, 2), (2, 2)]]
... )
>>> get_num_interior_rings(polygon_with_hole)
1
>>> get_num_interior_rings(Point(0, 0))
0
>>> get_num_interior_rings(None)
0
"""
return lib.get_num_interior_rings(geometry, **kwargs)
# collections
@multithreading_enabled
def get_geometry(geometry, index, **kwargs):
"""Returns the nth geometry from a collection of geometries.
Parameters
----------
geometry : Geometry or array_like
index : int or array_like
Negative values count from the end of the collection backwards.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
Notes
-----
- simple geometries act as length-1 collections
- out-of-range values return None
See also
--------
get_num_geometries, get_parts
Examples
--------
>>> from shapely import Point, MultiPoint
>>> multipoint = MultiPoint([(0, 0), (1, 1), (2, 2), (3, 3)])
>>> get_geometry(multipoint, 1)
<POINT (1 1)>
>>> get_geometry(multipoint, -1)
<POINT (3 3)>
>>> get_geometry(multipoint, 5) is None
True
>>> get_geometry(Point(1, 1), 0)
<POINT (1 1)>
>>> get_geometry(Point(1, 1), 1) is None
True
"""
return lib.get_geometry(geometry, np.intc(index), **kwargs)
def get_parts(geometry, return_index=False):
"""Gets parts of each GeometryCollection or Multi* geometry object; returns
a copy of each geometry in the GeometryCollection or Multi* geometry object.
Note: This does not return the individual parts of Multi* geometry objects in
a GeometryCollection. You may need to call this function multiple times to
return individual parts of Multi* geometry objects in a GeometryCollection.
Parameters
----------
geometry : Geometry or array_like
return_index : bool, default False
If True, will return a tuple of ndarrays of (parts, indexes), where indexes
are the indexes of the original geometries in the source array.
Returns
-------
ndarray of parts or tuple of (parts, indexes)
See also
--------
get_geometry, get_rings
Examples
--------
>>> from shapely import MultiPoint
>>> get_parts(MultiPoint([(0, 1), (2, 3)])).tolist()
[<POINT (0 1)>, <POINT (2 3)>]
>>> parts, index = get_parts([MultiPoint([(0, 1)]), MultiPoint([(4, 5), (6, 7)])], \
return_index=True)
>>> parts.tolist()
[<POINT (0 1)>, <POINT (4 5)>, <POINT (6 7)>]
>>> index.tolist()
[0, 1, 1]
"""
geometry = np.asarray(geometry, dtype=np.object_)
geometry = np.atleast_1d(geometry)
if geometry.ndim != 1:
raise ValueError("Array should be one dimensional")
if return_index:
return _geometry_helpers.get_parts(geometry)
return _geometry_helpers.get_parts(geometry)[0]
def get_rings(geometry, return_index=False):
"""Gets rings of Polygon geometry object.
For each Polygon, the first returned ring is always the exterior ring
and potential subsequent rings are interior rings.
If the geometry is not a Polygon, nothing is returned (empty array for
scalar geometry input or no element in output array for array input).
Parameters
----------
geometry : Geometry or array_like
return_index : bool, default False
If True, will return a tuple of ndarrays of (rings, indexes), where
indexes are the indexes of the original geometries in the source array.
Returns
-------
ndarray of rings or tuple of (rings, indexes)
See also
--------
get_exterior_ring, get_interior_ring, get_parts
Examples
--------
>>> from shapely import Polygon
>>> polygon_with_hole = Polygon(
... [(0, 0), (0, 10), (10, 10), (10, 0), (0, 0)],
... holes=[[(2, 2), (2, 4), (4, 4), (4, 2), (2, 2)]]
... )
>>> get_rings(polygon_with_hole).tolist()
[<LINEARRING (0 0, 0 10, 10 10, 10 0, 0 0)>,
<LINEARRING (2 2, 2 4, 4 4, 4 2, 2 2)>]
With ``return_index=True``:
>>> polygon = Polygon([(0, 0), (2, 0), (2, 2), (0, 2), (0, 0)])
>>> rings, index = get_rings([polygon, polygon_with_hole], return_index=True)
>>> rings.tolist()
[<LINEARRING (0 0, 2 0, 2 2, 0 2, 0 0)>,
<LINEARRING (0 0, 0 10, 10 10, 10 0, 0 0)>,
<LINEARRING (2 2, 2 4, 4 4, 4 2, 2 2)>]
>>> index.tolist()
[0, 1, 1]
"""
geometry = np.asarray(geometry, dtype=np.object_)
geometry = np.atleast_1d(geometry)
if geometry.ndim != 1:
raise ValueError("Array should be one dimensional")
if return_index:
return _geometry_helpers.get_parts(geometry, extract_rings=True)
return _geometry_helpers.get_parts(geometry, extract_rings=True)[0]
@multithreading_enabled
def get_num_geometries(geometry, **kwargs):
"""Returns number of geometries in a collection.
Returns 0 for not-a-geometry values.
Parameters
----------
geometry : Geometry or array_like
The number of geometries in points, linestrings, linearrings and
polygons equals one.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_num_points
get_geometry
Examples
--------
>>> from shapely import MultiPoint, Point
>>> get_num_geometries(MultiPoint([(0, 0), (1, 1), (2, 2), (3, 3)]))
4
>>> get_num_geometries(Point(1, 1))
1
>>> get_num_geometries(None)
0
"""
return lib.get_num_geometries(geometry, **kwargs)
@requires_geos("3.6.0")
@multithreading_enabled
def get_precision(geometry, **kwargs):
"""Get the precision of a geometry.
If a precision has not been previously set, it will be 0 (double
precision). Otherwise, it will return the precision grid size that was
set on a geometry.
Returns NaN for not-a-geometry values.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
set_precision
Examples
--------
>>> from shapely import Point
>>> point = Point(1, 1)
>>> get_precision(point)
0.0
>>> geometry = set_precision(point, 1.0)
>>> get_precision(geometry)
1.0
>>> get_precision(None)
nan
"""
return lib.get_precision(geometry, **kwargs)
class SetPrecisionMode(ParamEnum):
valid_output = 0
pointwise = 1
keep_collapsed = 2
@requires_geos("3.6.0")
@multithreading_enabled
def set_precision(geometry, grid_size, mode="valid_output", **kwargs):
"""Returns geometry with the precision set to a precision grid size.
By default, geometries use double precision coordinates (grid_size = 0).
Coordinates will be rounded if a precision grid is less precise than the
input geometry. Duplicated vertices will be dropped from lines and
polygons for grid sizes greater than 0. Line and polygon geometries may
collapse to empty geometries if all vertices are closer together than
grid_size. Z values, if present, will not be modified.
Note: subsequent operations will always be performed in the precision of
the geometry with higher precision (smaller "grid_size"). That same
precision will be attached to the operation outputs.
Also note: input geometries should be geometrically valid; unexpected
results may occur if input geometries are not.
Returns None if geometry is None.
Parameters
----------
geometry : Geometry or array_like
grid_size : float
Precision grid size. If 0, will use double precision (will not modify
geometry if precision grid size was not previously set). If this
value is more precise than input geometry, the input geometry will
not be modified.
mode : {'valid_output', 'pointwise', 'keep_collapsed'}, default 'valid_output'
This parameter determines how to handle invalid output geometries. There are three modes:
1. `'valid_output'` (default): The output is always valid. Collapsed geometry elements
(including both polygons and lines) are removed. Duplicate vertices are removed.
2. `'pointwise'`: Precision reduction is performed pointwise. Output geometry
may be invalid due to collapse or self-intersection. Duplicate vertices are not
removed. In GEOS this option is called NO_TOPO.
.. note::
'pointwise' mode requires at least GEOS 3.10. It is accepted in earlier versions,
but the results may be unexpected.
3. `'keep_collapsed'`: Like the default mode, except that collapsed linear geometry
elements are preserved. Collapsed polygonal input elements are removed. Duplicate
vertices are removed.
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
See also
--------
get_precision
Examples
--------
>>> from shapely import LineString, Point
>>> set_precision(Point(0.9, 0.9), 1.0)
<POINT (1 1)>
>>> set_precision(Point(0.9, 0.9, 0.9), 1.0)
<POINT Z (1 1 0.9)>
>>> set_precision(LineString([(0, 0), (0, 0.1), (0, 1), (1, 1)]), 1.0)
<LINESTRING (0 0, 0 1, 1 1)>
>>> set_precision(LineString([(0, 0), (0, 0.1), (0.1, 0.1)]), 1.0, mode="valid_output")
<LINESTRING Z EMPTY>
>>> set_precision(LineString([(0, 0), (0, 0.1), (0.1, 0.1)]), 1.0, mode="pointwise")
<LINESTRING (0 0, 0 0, 0 0)>
>>> set_precision(LineString([(0, 0), (0, 0.1), (0.1, 0.1)]), 1.0, mode="keep_collapsed")
<LINESTRING (0 0, 0 0)>
>>> set_precision(None, 1.0) is None
True
"""
if isinstance(mode, str):
mode = SetPrecisionMode.get_value(mode)
elif not np.isscalar(mode):
raise TypeError("mode only accepts scalar values")
if mode == SetPrecisionMode.pointwise and geos_version < (3, 10, 0):
warnings.warn(
"'pointwise' is only supported for GEOS 3.10",
UserWarning,
stacklevel=2,
)
return lib.set_precision(geometry, grid_size, np.intc(mode), **kwargs)
@multithreading_enabled
def force_2d(geometry, **kwargs):
"""Forces the dimensionality of a geometry to 2D.
Parameters
----------
geometry : Geometry or array_like
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
Examples
--------
>>> from shapely import LineString, Point, Polygon, from_wkt
>>> force_2d(Point(0, 0, 1))
<POINT (0 0)>
>>> force_2d(Point(0, 0))
<POINT (0 0)>
>>> force_2d(LineString([(0, 0, 0), (0, 1, 1), (1, 1, 2)]))
<LINESTRING (0 0, 0 1, 1 1)>
>>> force_2d(from_wkt("POLYGON Z EMPTY"))
<POLYGON EMPTY>
>>> force_2d(None) is None
True
"""
return lib.force_2d(geometry, **kwargs)
@multithreading_enabled
def force_3d(geometry, z=0.0, **kwargs):
"""Forces the dimensionality of a geometry to 3D.
2D geometries will get the provided Z coordinate; Z coordinates of 3D geometries
are unchanged (unless they are nan).
Note that for empty geometries, 3D is only supported since GEOS 3.9 and then
still only for simple geometries (non-collections).
Parameters
----------
geometry : Geometry or array_like
z : float or array_like, default 0.0
**kwargs
For other keyword-only arguments, see the
`NumPy ufunc docs <https://numpy.org/doc/stable/reference/ufuncs.html#ufuncs-kwargs>`_.
Examples
--------
>>> from shapely import LineString, Point
>>> force_3d(Point(0, 0), z=3)
<POINT Z (0 0 3)>
>>> force_3d(Point(0, 0, 0), z=3)
<POINT Z (0 0 0)>
>>> force_3d(LineString([(0, 0), (0, 1), (1, 1)]))
<LINESTRING Z (0 0 0, 0 1 0, 1 1 0)>
>>> force_3d(None) is None
True
"""
if np.isnan(z).any():
raise ValueError("It is not allowed to set the Z coordinate to NaN.")
return lib.force_3d(geometry, z, **kwargs)