Skip to content

Commit f8cf91e

Browse files
committed
add docstring
1 parent 52de10a commit f8cf91e

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

third_party/bigframes_vendored/geopandas/geoseries.py

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,3 +496,31 @@ def is_closed(self: GeoSeries) -> bigframes.series.Series:
496496
``bigframes.bigquery.st_isclosed(series)``, instead.
497497
"""
498498
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
499+
500+
def simplify(self, crs=None) -> bigframes.series.Series: # type: ignore
501+
"""[Not Implemented] Use ``bigframes.bigquery.st_simplify(series, tolerance_meters)``,
502+
instead to set the tolerance in meters.
503+
504+
In GeoPandas, this returns a GeoSeries containing a simplified
505+
representation of each geometry.
506+
507+
Args:
508+
tolerance (float):
509+
All parts of a simplified geometry will be no more than
510+
tolerance distance from the original. It has the same units as
511+
the coordinate reference system of the GeoSeries. For example,
512+
using tolerance=100 in a projected CRS with meters as units
513+
means a distance of 100 meters in reality.
514+
preserve_topology (bool):
515+
Default True. False uses a quicker algorithm, but may produce
516+
self-intersecting or otherwise invalid geometries.
517+
518+
Returns:
519+
bigframes.geopandas.GeoSeries:
520+
Series of simplified geometries.
521+
522+
Raises:
523+
NotImplementedError:
524+
GeoSeries.area is not supported. Use bigframes.bigquery.st_area(series), instead.
525+
"""
526+
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

0 commit comments

Comments
 (0)