Functions¶

Interoperability with other Python geospatial libraries (Shapely, GeoPandas) and in-memory geospatial formats (WKB, WKT).

geoarrow.rust.core ¶

from_wkb ¶

from_wkb(
    input: ArrowArrayExportable, to_type: ArrowSchemaExportable | None = None
) -> GeoArray

from_wkb(
    input: ArrowStreamExportable, to_type: ArrowSchemaExportable | None = None
) -> GeoArrayReader

from_wkb(
    input: ArrowArrayExportable | ArrowStreamExportable,
    to_type: ArrowSchemaExportable | None = None,
) -> GeoArray | GeoArrayReader

Parse the WKB input to the provided data type.

Parameters:

input (ArrowArrayExportable | ArrowStreamExportable) –

Input data to parse.
to_type (ArrowSchemaExportable | None, default: None ) –

The target data type to parse to. By default, parses to a Geometry type array (the output of geoarrow.rust.core.geometry).

Returns:

GeoArray | GeoArrayReader –

If input is an Array-like, a GeoArray will be returned. If input is a Stream-like (ChunkedArray or ArrayReader), a GeoArrayReader will be returned.

from_wkt ¶

from_wkt(
    input: ArrowArrayExportable, to_type: ArrowSchemaExportable | None = None
) -> GeoArray

from_wkt(
    input: ArrowStreamExportable, to_type: ArrowSchemaExportable | None = None
) -> GeoArrayReader

from_wkt(
    input: ArrowArrayExportable | ArrowStreamExportable,
    to_type: ArrowSchemaExportable | None = None,
) -> GeoArray | GeoArrayReader

Parse the WKT input to the provided data type.

Parameters:

input (ArrowArrayExportable | ArrowStreamExportable) –

Input data to parse.
to_type (ArrowSchemaExportable | None, default: None ) –

The target data type to parse to. By default, parses to a Geometry type array (the output of geoarrow.rust.core.geometry).

Returns:

GeoArray | GeoArrayReader –

If input is an Array-like, a GeoArray will be returned. If input is a Stream-like (ChunkedArray or ArrayReader), a GeoArrayReader will be returned.

to_wkb ¶

to_wkb(
    input: ArrowArrayExportable,
    wkb_type: Literal["wkb", "large_wkb", "wkb_view"] = "wkb",
) -> GeoArray

to_wkb(
    input: ArrowStreamExportable,
    wkb_type: Literal["wkb", "large_wkb", "wkb_view"] = "wkb",
) -> GeoArrayReader

to_wkb(
    input: ArrowArrayExportable | ArrowStreamExportable,
    wkb_type: Literal["wkb", "large_wkb", "wkb_view"] = "wkb",
) -> GeoArray | GeoArrayReader

Convert input to WKB.

Parameters:

input (ArrowArrayExportable | ArrowStreamExportable) –

Input data to parse.
wkb_type (Literal['wkb', 'large_wkb', 'wkb_view'], default: 'wkb' ) –

The target WKB array type to convert to. Can be one of "wkb" (binary array with i32 offsets), "large_wkb" (binary array with i64 offsets), or "wkb_view" (binary view array).

Returns:

GeoArray | GeoArrayReader –

If input is an Array-like, a GeoArray will be returned. If input is a Stream-like (ChunkedArray or ArrayReader), a GeoArrayReader will be returned.

to_wkt ¶

to_wkt(
    input: ArrowArrayExportable,
    wkt_type: Literal["wkt", "large_wkt", "wkt_view"] = "wkt",
) -> GeoArray

to_wkt(
    input: ArrowStreamExportable,
    wkt_type: Literal["wkt", "large_wkt", "wkt_view"] = "wkt",
) -> GeoArrayReader

to_wkt(
    input: ArrowArrayExportable | ArrowStreamExportable,
    wkt_type: Literal["wkt", "large_wkt", "wkt_view"] = "wkt",
) -> GeoArray | GeoArrayReader

Convert input to WKT.

Parameters:

input (ArrowArrayExportable | ArrowStreamExportable) –

Input data to parse.
wkt_type (Literal['wkt', 'large_wkt', 'wkt_view'], default: 'wkt' ) –

The target WKT array type to convert to. Can be one of "wkt" (string array with i32 offsets), "large_wkt" (string array with i64 offsets), or "wkt_view" (string view array).

Returns:

GeoArray | GeoArrayReader –

If input is an Array-like, a GeoArray will be returned. If input is a Stream-like (ChunkedArray or ArrayReader), a GeoArrayReader will be returned.

CRS Access¶

geoarrow.rust.core.get_crs ¶

get_crs(
    data: ArrowArrayExportable | ArrowStreamExportable | ArrowSchemaExportable,
    /,
    column: str | None = None,
) -> CRS | None

Get the CRS from a GeoArrow object.

Parameters:

data (ArrowArrayExportable | ArrowStreamExportable | ArrowSchemaExportable) –

A GeoArrow object. This can be an Array, ChunkedArray, ArrayReader, RecordBatchReader, Table, Field, or Schema.
column (str | None, default: None ) –

The name of the geometry column to retrieve, if there's more than one. For Schema, Table, and RecordBatchReader inputs, there may be more than one geometry column included. If there are multiple geometry columns, you must pass this column parameter. If there is only one geometry column, it will be inferred. Defaults to None.

Raises:

ValueError –

If no geometry column could be found.

Returns:

CRS | None –

a pyproj CRS object.