ST_CollectionExtract (Python)

Extract a specific type of geometry from a geometry collection column as a multi-geometry column. SQL reference: ST_CollectionExtract

Signature

from sedona.spark.sql.st_functions import ST_CollectionExtract

ST_CollectionExtract(
    collection: ColumnOrName,
    geom_type: Optional[Union[ColumnOrName, int]] = None,
) -> Column

Parameters

ColumnOrName

required

Column for the geometry collection.

Optional[Union[ColumnOrName, int]]

default:"None"

Type of geometry to extract where 1 is point, 2 is linestring, and 3 is polygon, if None then the highest dimension geometry is extracted, defaults to None

Returns

Column

Multi-geometry column containing all geometry from collection of the selected type.

​Signature

​Parameters

​Returns

Signature

Parameters

Returns