Arrow PyCapsule Protocol_ (i.e. having an __arrow_c_array__
method). This object can then be consumed by your Arrow implementation
of choice that supports this protocol.
.. _Arrow PyCapsule Protocol: https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html
Note: Requires geopandas versions >= 1.0.0 to use with Sedona.
Signature
Parameters
(WKB, geoarrow)
default:"'WKB'"
The GeoArrow encoding to use for the data conversion.
bool
default:"True"
Only relevant for ‘geoarrow’ encoding. If True, the geometries’
coordinates are interleaved in a single fixed size list array.
If False, the coordinates are stored as separate arrays in a
struct type.
bool
default:"None"
Only relevant for ‘geoarrow’ encoding (for WKB, the dimensionality
of the individual geometries is preserved).
If False, return 2D geometries. If True, include the third dimension
in the output (if a geometry has no third dimension, the z-coordinates
will be NaN). By default, will infer the dimensionality from the
input geometries. Note that this inference can be unreliable with
empty geometries (for a guaranteed result, it is recommended to
specify the keyword).
Returns
GeoArrowArray
A generic Arrow array object with geometry data encoded to GeoArrow.