GeoSeries

polars_st.GeoSeries

GeoSeries(
    name: str | ArrayLike | None = None,
    values: ArrayLike | None = None,
    dtype: PolarsDataType | None = None,
    *,
    strict: bool = True,
    nan_to_null: bool = False,
    geometry_format: (
        Literal[
            "wkb",
            "wkt",
            "ewkt",
            "geojson",
            "shapely",
            "coords",
            "point",
            "multipoint",
            "linestring",
            "circularstring",
            "multilinestring",
            "polygon",
        ]
        | None
    ) = None
)

Bases: Series

Create a new GeoSeries.

GeoSeries is used as an alias for pl.Series with type annotations added for the st namespace, and an overriden constructor which will parse the values into binary EWKB format.

You can create a GeoSeries from a list of coordinate arrays, WKB, WKT, EWKT or GeoJSON strings, or Shapely objects. If geometry_format is not set, the geometries will be created by infering the correct deserialization operation from its datatype.

See pl.Series for parameters documentation.

Note

Because Polars doesn't support subclassing of their types, calling this constructor will NOT create an instance of GeoSeries, but an instance of pl.Series.

As a result, instance checks are not permitted on this class to prevent misuse:

>>> s = st.GeoSeries(["POINT(0 0)"])
>>> type(s)
<class 'polars.series.series.Series'>
>>> isinstance(s, st.GeoSeries)
Traceback (most recent call last):
...
TypeError: instance check on abstract class GeoSeries is not allowed

Examples:

>>> gs = st.GeoSeries([
...     "POINT(0 0)",
...     "POINT(1 2)",
... ])
>>> gs2 = st.GeoSeries([
...     [0, 0],
...     [1, 2],
... ], geometry_format="point")
>>> gs.equals(gs2)
True

>>> import shapely
>>> gs = st.GeoSeries([
...     shapely.Point(0, 0),
...     shapely.Point(1, 2),
... ])
>>> gs2 = st.GeoSeries([
...     '{"type": "Point", "coordinates": [0, 0]}',
...     '{"type": "Point", "coordinates": [1, 2]}',
... ])
>>> gs.equals(gs2)
True

st property

st: GeoSeriesNameSpace

polars_st.GeoSeriesNameSpace

polars_st.GeoSeriesNameSpace.__geo_interface__ property

__geo_interface__: dict

Return a GeoJSON GeometryCollection dict representation of the DataFrame.

polars_st.GeoSeriesNameSpace.geometry_type

geometry_type() -> Series

See GeoExprNameSpace.geometry_type.

polars_st.GeoSeriesNameSpace.dimensions

dimensions() -> Series

See GeoExprNameSpace.dimensions.

polars_st.GeoSeriesNameSpace.coordinate_dimension

coordinate_dimension() -> Series

See GeoExprNameSpace.coordinate_dimension.

polars_st.GeoSeriesNameSpace.area

area() -> Series

See GeoExprNameSpace.area.

polars_st.GeoSeriesNameSpace.bounds

bounds() -> Series

See GeoExprNameSpace.bounds.

polars_st.GeoSeriesNameSpace.length

length() -> Series

See GeoExprNameSpace.length.

polars_st.GeoSeriesNameSpace.minimum_clearance

minimum_clearance() -> Series

See GeoExprNameSpace.minimum_clearance.

polars_st.GeoSeriesNameSpace.x

x() -> Series

See GeoExprNameSpace.x.

polars_st.GeoSeriesNameSpace.y

y() -> Series

See GeoExprNameSpace.y.

polars_st.GeoSeriesNameSpace.z

z() -> Series

See GeoExprNameSpace.z.

polars_st.GeoSeriesNameSpace.m

m() -> Series

See GeoExprNameSpace.m.

polars_st.GeoSeriesNameSpace.count_coordinates

count_coordinates() -> Series

See GeoExprNameSpace.count_coordinates.

polars_st.GeoSeriesNameSpace.coordinates

coordinates(output_dimension: Literal[2, 3] | None = None) -> Series

See GeoExprNameSpace.coordinates.

polars_st.GeoSeriesNameSpace.exterior_ring

exterior_ring() -> GeoSeries

See GeoExprNameSpace.exterior_ring.

polars_st.GeoSeriesNameSpace.interior_rings

interior_rings() -> Series

See GeoExprNameSpace.interior_rings.

polars_st.GeoSeriesNameSpace.count_interior_rings

count_interior_rings() -> Series

See GeoExprNameSpace.count_interior_rings.

polars_st.GeoSeriesNameSpace.get_interior_ring

get_interior_ring(index: IntoIntegerExpr) -> GeoSeries

See GeoExprNameSpace.get_interior_ring.

polars_st.GeoSeriesNameSpace.count_geometries

count_geometries() -> Series

See GeoExprNameSpace.count_geometries.

polars_st.GeoSeriesNameSpace.get_geometry

get_geometry(index: IntoIntegerExpr) -> GeoSeries

See GeoExprNameSpace.get_geometry.

polars_st.GeoSeriesNameSpace.count_points

count_points() -> Series

See GeoExprNameSpace.count_points.

polars_st.GeoSeriesNameSpace.get_point

get_point(index: IntoIntegerExpr) -> GeoSeries

See GeoExprNameSpace.get_point.

polars_st.GeoSeriesNameSpace.parts

parts() -> Series

See GeoExprNameSpace.parts.

polars_st.GeoSeriesNameSpace.precision

precision() -> Series

See GeoExprNameSpace.precision.

polars_st.GeoSeriesNameSpace.set_precision

set_precision(
    grid_size: IntoNumericExpr,
    mode: Literal["valid_output", "no_topo", "keep_collapsed"] = "valid_output",
) -> GeoSeries

See GeoExprNameSpace.set_precision.

polars_st.GeoSeriesNameSpace.distance

distance(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.distance.

polars_st.GeoSeriesNameSpace.hausdorff_distance

hausdorff_distance(
    other: IntoGeoExprColumn, densify: float | None = None
) -> Series

See GeoExprNameSpace.hausdorff_distance.

polars_st.GeoSeriesNameSpace.frechet_distance

frechet_distance(
    other: IntoGeoExprColumn, densify: float | None = None
) -> Series

See GeoExprNameSpace.frechet_distance.

polars_st.GeoSeriesNameSpace.srid

srid() -> Series

See GeoExprNameSpace.srid.

polars_st.GeoSeriesNameSpace.set_srid

set_srid(srid: IntoIntegerExpr) -> GeoSeries

See GeoExprNameSpace.set_srid.

polars_st.GeoSeriesNameSpace.to_srid

to_srid(srid: IntoIntegerExpr) -> GeoSeries

See GeoExprNameSpace.to_srid.

polars_st.GeoSeriesNameSpace.to_wkt

to_wkt(
    rounding_precision: int | None = 6,
    trim: bool = True,
    output_dimension: Literal[2, 3, 4] = 3,
    old_3d: bool = False,
) -> Series

See GeoExprNameSpace.to_wkt.

polars_st.GeoSeriesNameSpace.to_ewkt

to_ewkt(
    rounding_precision: int | None = 6,
    trim: bool = True,
    output_dimension: Literal[2, 3, 4] = 3,
    old_3d: bool = False,
) -> Series

See GeoExprNameSpace.to_ewkt.

polars_st.GeoSeriesNameSpace.to_wkb

to_wkb(
    output_dimension: Literal[2, 3, 4] = 3,
    byte_order: Literal[0, 1] | None = None,
    include_srid: bool = False,
) -> Series

See GeoExprNameSpace.to_wkb.

polars_st.GeoSeriesNameSpace.to_geojson

to_geojson(indent: int | None = None) -> Series

See GeoExprNameSpace.to_geojson.

polars_st.GeoSeriesNameSpace.to_shapely

to_shapely() -> Series

See GeoExprNameSpace.to_shapely.

polars_st.GeoSeriesNameSpace.to_dict

to_dict() -> Series

See GeoExprNameSpace.to_dict.

polars_st.GeoSeriesNameSpace.cast

cast(into: IntoExprColumn) -> Series

See GeoExprNameSpace.cast.

polars_st.GeoSeriesNameSpace.multi

multi() -> Series

See GeoExprNameSpace.multi.

polars_st.GeoSeriesNameSpace.to_geopandas

to_geopandas(
    *, use_pyarrow_extension_array: bool = False, **kwargs: Any
) -> GeoSeries

Convert this pl.Series to a geopandas GeoSeries.

polars_st.GeoSeriesNameSpace.has_z

has_z() -> Series

See GeoExprNameSpace.has_z.

polars_st.GeoSeriesNameSpace.has_m

has_m() -> Series

See GeoExprNameSpace.has_m.

polars_st.GeoSeriesNameSpace.is_ccw

is_ccw() -> Series

See GeoExprNameSpace.is_ccw.

polars_st.GeoSeriesNameSpace.is_closed

is_closed() -> Series

See GeoExprNameSpace.is_closed.

polars_st.GeoSeriesNameSpace.is_empty

is_empty() -> Series

See GeoExprNameSpace.is_empty.

polars_st.GeoSeriesNameSpace.is_ring

is_ring() -> Series

See GeoExprNameSpace.is_ring.

polars_st.GeoSeriesNameSpace.is_simple

is_simple() -> Series

See GeoExprNameSpace.is_simple.

polars_st.GeoSeriesNameSpace.is_valid

is_valid() -> Series

See GeoExprNameSpace.is_valid.

polars_st.GeoSeriesNameSpace.is_valid_reason

is_valid_reason() -> Series

See GeoExprNameSpace.is_valid_reason.

polars_st.GeoSeriesNameSpace.crosses

crosses(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.crosses.

polars_st.GeoSeriesNameSpace.contains

contains(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.contains.

polars_st.GeoSeriesNameSpace.contains_properly

contains_properly(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.contains_properly.

polars_st.GeoSeriesNameSpace.covered_by

covered_by(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.covered_by.

polars_st.GeoSeriesNameSpace.covers

covers(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.covers.

polars_st.GeoSeriesNameSpace.disjoint

disjoint(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.disjoint.

polars_st.GeoSeriesNameSpace.dwithin

dwithin(other: IntoGeoExprColumn, distance: float) -> Series

See GeoExprNameSpace.dwithin.

polars_st.GeoSeriesNameSpace.intersects

intersects(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.intersects.

polars_st.GeoSeriesNameSpace.overlaps

overlaps(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.overlaps.

polars_st.GeoSeriesNameSpace.touches

touches(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.touches.

polars_st.GeoSeriesNameSpace.within

within(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.within.

polars_st.GeoSeriesNameSpace.equals

equals(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.equals.

polars_st.GeoSeriesNameSpace.equals_exact

equals_exact(other: IntoGeoExprColumn, tolerance: float = 0.0) -> Series

See GeoExprNameSpace.equals_exact.

polars_st.GeoSeriesNameSpace.equals_identical

equals_identical(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.equals_identical.

polars_st.GeoSeriesNameSpace.relate

relate(other: IntoGeoExprColumn) -> Series

See GeoExprNameSpace.relate.

polars_st.GeoSeriesNameSpace.relate_pattern

relate_pattern(other: IntoGeoExprColumn, pattern: str) -> Series

See GeoExprNameSpace.relate_pattern.

polars_st.GeoSeriesNameSpace.union

union(other: IntoGeoExprColumn, grid_size: float | None = None) -> GeoSeries

See GeoExprNameSpace.union.

polars_st.GeoSeriesNameSpace.unary_union

unary_union(grid_size: float | None = None) -> GeoSeries

See GeoExprNameSpace.unary_union.

polars_st.GeoSeriesNameSpace.coverage_union

coverage_union() -> GeoSeries

See GeoExprNameSpace.coverage_union.

polars_st.GeoSeriesNameSpace.intersection

intersection(
    other: IntoGeoExprColumn, grid_size: float | None = None
) -> GeoSeries

See GeoExprNameSpace.intersection.

polars_st.GeoSeriesNameSpace.difference

difference(
    other: IntoGeoExprColumn, grid_size: float | None = None
) -> GeoSeries

See GeoExprNameSpace.difference.

polars_st.GeoSeriesNameSpace.symmetric_difference

symmetric_difference(
    other: IntoGeoExprColumn, grid_size: float | None = None
) -> GeoSeries

See GeoExprNameSpace.symmetric_difference.

polars_st.GeoSeriesNameSpace.boundary

boundary() -> GeoSeries

See GeoExprNameSpace.boundary.

polars_st.GeoSeriesNameSpace.buffer

buffer(
    distance: IntoNumericExpr,
    quad_segs: int = 8,
    cap_style: Literal["round", "square", "flat"] = "round",
    join_style: Literal["round", "mitre", "bevel"] = "round",
    mitre_limit: float = 5.0,
    single_sided: bool = False,
) -> GeoSeries

See GeoExprNameSpace.buffer.

polars_st.GeoSeriesNameSpace.offset_curve

offset_curve(
    distance: IntoNumericExpr,
    quad_segs: int = 8,
    join_style: Literal["round", "mitre", "bevel"] = "round",
    mitre_limit: float = 5.0,
) -> GeoSeries

See GeoExprNameSpace.offset_curve.

polars_st.GeoSeriesNameSpace.centroid

centroid() -> GeoSeries

See GeoExprNameSpace.centroid.

polars_st.GeoSeriesNameSpace.center

center() -> GeoSeries

See GeoExprNameSpace.center.

polars_st.GeoSeriesNameSpace.clip_by_rect

clip_by_rect(
    xmin: IntoNumericExpr,
    ymin: IntoNumericExpr,
    xmax: IntoNumericExpr,
    ymax: IntoNumericExpr,
) -> GeoSeries

See GeoExprNameSpace.clip_by_rect.

polars_st.GeoSeriesNameSpace.convex_hull

convex_hull() -> GeoSeries

See GeoExprNameSpace.convex_hull.

polars_st.GeoSeriesNameSpace.concave_hull

concave_hull(ratio: float = 0.0, allow_holes: bool = False) -> GeoSeries

See GeoExprNameSpace.concave_hull.

polars_st.GeoSeriesNameSpace.segmentize

segmentize(max_segment_length: IntoNumericExpr) -> GeoSeries

See GeoExprNameSpace.segmentize.

polars_st.GeoSeriesNameSpace.envelope

envelope() -> GeoSeries

See GeoExprNameSpace.envelope.

polars_st.GeoSeriesNameSpace.extract_unique_points

extract_unique_points() -> GeoSeries

See GeoExprNameSpace.extract_unique_points.

polars_st.GeoSeriesNameSpace.build_area

build_area() -> GeoSeries

See GeoExprNameSpace.build_area.

polars_st.GeoSeriesNameSpace.make_valid

make_valid() -> GeoSeries

See GeoExprNameSpace.make_valid.

polars_st.GeoSeriesNameSpace.normalize

normalize() -> GeoSeries

See GeoExprNameSpace.normalize.

polars_st.GeoSeriesNameSpace.node

node() -> GeoSeries

See GeoExprNameSpace.node.

polars_st.GeoSeriesNameSpace.point_on_surface

point_on_surface() -> GeoSeries

See GeoExprNameSpace.point_on_surface.

polars_st.GeoSeriesNameSpace.remove_repeated_points

remove_repeated_points(tolerance: IntoNumericExpr = 0.0) -> GeoSeries

See GeoExprNameSpace.remove_repeated_points.

polars_st.GeoSeriesNameSpace.reverse

reverse() -> GeoSeries

See GeoExprNameSpace.reverse.

polars_st.GeoSeriesNameSpace.simplify

simplify(
    tolerance: IntoNumericExpr, preserve_topology: bool = True
) -> GeoSeries

See GeoExprNameSpace.simplify.

polars_st.GeoSeriesNameSpace.force_2d

force_2d() -> GeoSeries

See GeoExprNameSpace.force_2d.

polars_st.GeoSeriesNameSpace.force_3d

force_3d(z: IntoNumericExpr = 0.0) -> GeoSeries

See GeoExprNameSpace.force_3d.

polars_st.GeoSeriesNameSpace.flip_coordinates

flip_coordinates() -> GeoSeries

See GeoExprNameSpace.flip_coordinates.

polars_st.GeoSeriesNameSpace.minimum_rotated_rectangle

minimum_rotated_rectangle() -> GeoSeries

See GeoExprNameSpace.minimum_rotated_rectangle.

polars_st.GeoSeriesNameSpace.snap

snap(other: IntoGeoExprColumn, tolerance: IntoNumericExpr) -> GeoSeries

See GeoExprNameSpace.snap.

polars_st.GeoSeriesNameSpace.shortest_line

shortest_line(other: IntoGeoExprColumn) -> GeoSeries

See GeoExprNameSpace.shortest_line.

polars_st.GeoSeriesNameSpace.affine_transform

affine_transform(matrix: IntoExprColumn | Sequence[float]) -> GeoSeries

See GeoExprNameSpace.affine_transform.

polars_st.GeoSeriesNameSpace.translate

translate(
    x: IntoNumericExpr = 0.0, y: IntoNumericExpr = 0.0, z: IntoNumericExpr = 0.0
) -> GeoSeries

See GeoExprNameSpace.translate.

polars_st.GeoSeriesNameSpace.rotate

rotate(
    angle: IntoNumericExpr,
    origin: Literal["center", "centroid"] | Sequence[float] = "center",
) -> GeoSeries

See GeoExprNameSpace.rotate.

polars_st.GeoSeriesNameSpace.scale

scale(
    x: IntoNumericExpr = 1.0,
    y: IntoNumericExpr = 1.0,
    z: IntoNumericExpr = 1.0,
    origin: Literal["center", "centroid"] | Sequence[float] = "center",
) -> GeoSeries

See GeoExprNameSpace.scale.

polars_st.GeoSeriesNameSpace.skew

skew(
    x: IntoNumericExpr = 0.0,
    y: IntoNumericExpr = 0.0,
    z: IntoNumericExpr = 0.0,
    origin: Literal["center", "centroid"] | Sequence[float] = "center",
) -> GeoSeries

See GeoExprNameSpace.skew.

polars_st.GeoSeriesNameSpace.interpolate

interpolate(distance: IntoNumericExpr, normalized: bool = False) -> GeoSeries

See GeoExprNameSpace.interpolate.

polars_st.GeoSeriesNameSpace.project

project(other: IntoGeoExprColumn, normalized: bool = False) -> Series

See GeoExprNameSpace.project.

polars_st.GeoSeriesNameSpace.line_merge

line_merge(directed: bool = False) -> GeoSeries

See GeoExprNameSpace.line_merge.

polars_st.GeoSeriesNameSpace.shared_paths

shared_paths(other: IntoGeoExprColumn) -> GeoSeries

See GeoExprNameSpace.shared_paths.

polars_st.GeoSeriesNameSpace.total_bounds

total_bounds() -> Series

See GeoExprNameSpace.total_bounds.

polars_st.GeoSeriesNameSpace.collect

collect(into: GeometryType | None = None) -> GeoSeries

See GeoExprNameSpace.collect.

polars_st.GeoSeriesNameSpace.union_all

union_all(grid_size: float | None = None) -> GeoSeries

See GeoExprNameSpace.union_all.

polars_st.GeoSeriesNameSpace.coverage_union_all

coverage_union_all() -> GeoSeries

See GeoExprNameSpace.coverage_union_all.

polars_st.GeoSeriesNameSpace.intersection_all

intersection_all(grid_size: float | None = None) -> GeoSeries

See GeoExprNameSpace.intersection_all.

polars_st.GeoSeriesNameSpace.difference_all

difference_all(grid_size: float | None = None) -> GeoSeries

See GeoExprNameSpace.difference_all.

polars_st.GeoSeriesNameSpace.symmetric_difference_all

symmetric_difference_all(grid_size: float | None = None) -> GeoSeries

See GeoExprNameSpace.symmetric_difference_all.

polars_st.GeoSeriesNameSpace.polygonize

polygonize() -> GeoSeries

See GeoExprNameSpace.polygonize.

polars_st.GeoSeriesNameSpace.voronoi_polygons

voronoi_polygons(
    tolerance: float = 0.0,
    extend_to: bytes | None = None,
    only_edges: bool = False,
) -> GeoSeries

See GeoExprNameSpace.voronoi_polygons.

polars_st.GeoSeriesNameSpace.delaunay_triangles

delaunay_triangles(
    tolerance: float = 0.0, only_edges: bool = False
) -> GeoSeries

See GeoExprNameSpace.delaunay_triangles.

polars_st.GeoSeriesNameSpace.plot

plot(**kwargs: Unpack[MarkConfigKwds]) -> Chart

Draw map plot.

Polars does not implement plotting logic itself but instead defers to Altair.

df.st.plot(**kwargs) is shorthand for alt.Chart(df).mark_geoshape(**kwargs).interactive(). Please read Altair GeoShape documentation for available options.