sudapy.vector.ops¶
Vector geoprocessing operations: reproject, clip, dissolve, area, buffer, simplify, fix-geometry.
sudapy.vector.ops ¶
Vector geoprocessing operations.
All functions accept and return :class:geopandas.GeoDataFrame objects and
support GeoPackage, GeoJSON, and Shapefile formats on disk.
reproject ¶
reproject(src: PathLike | GeoDataFrame, to_epsg: int, out: PathLike | None = None) -> gpd.GeoDataFrame
Reproject a vector dataset to a new CRS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file path or GeoDataFrame. |
required |
to_epsg
|
int
|
Target EPSG code. |
required |
out
|
PathLike | None
|
Optional output file path. If given the result is also saved. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
Reprojected GeoDataFrame. |
Source code in src\sudapy\vector\ops.py
clip ¶
clip(src: PathLike | GeoDataFrame, clip_src: PathLike | GeoDataFrame, out: PathLike | None = None) -> gpd.GeoDataFrame
Clip a vector dataset by another vector geometry.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file or GeoDataFrame. |
required |
clip_src
|
PathLike | GeoDataFrame
|
Clipping geometry file or GeoDataFrame. |
required |
out
|
PathLike | None
|
Optional output path. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
Clipped GeoDataFrame. |
Source code in src\sudapy\vector\ops.py
dissolve ¶
Dissolve geometries by an attribute field.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file or GeoDataFrame. |
required |
by
|
str
|
Column name to dissolve on. |
required |
out
|
PathLike | None
|
Optional output path. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
Dissolved GeoDataFrame. |
Source code in src\sudapy\vector\ops.py
calculate_area ¶
calculate_area(src: PathLike | GeoDataFrame, field: str = 'area_m2', out: PathLike | None = None) -> gpd.GeoDataFrame
Calculate geometry area in square meters.
If the CRS is geographic (lat/lon) a warning is emitted and geometries are temporarily projected to the appropriate UTM zone for accurate area calculation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file or GeoDataFrame. |
required |
field
|
str
|
Name of the new area column. |
'area_m2'
|
out
|
PathLike | None
|
Optional output path. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
GeoDataFrame with a new area column. |
Source code in src\sudapy\vector\ops.py
buffer ¶
buffer(src: PathLike | GeoDataFrame, distance_m: float, out: PathLike | None = None) -> gpd.GeoDataFrame
Buffer geometries by a distance in meters.
If the CRS is geographic, the data is temporarily projected to the estimated UTM zone so the buffer distance is applied in meters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file or GeoDataFrame. |
required |
distance_m
|
float
|
Buffer distance in meters. |
required |
out
|
PathLike | None
|
Optional output path. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
Buffered GeoDataFrame (in original CRS). |
Source code in src\sudapy\vector\ops.py
simplify ¶
simplify(src: PathLike | GeoDataFrame, tolerance_m: float, out: PathLike | None = None) -> gpd.GeoDataFrame
Simplify geometries to reduce vertex count.
If the CRS is geographic, the data is temporarily projected to UTM so the tolerance is applied in meters.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file or GeoDataFrame. |
required |
tolerance_m
|
float
|
Simplification tolerance in meters. |
required |
out
|
PathLike | None
|
Optional output path. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
Simplified GeoDataFrame. |
Source code in src\sudapy\vector\ops.py
fix_geometry ¶
Repair invalid geometries using :func:shapely.validation.make_valid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
src
|
PathLike | GeoDataFrame
|
Input file or GeoDataFrame. |
required |
out
|
PathLike | None
|
Optional output path. |
None
|
Returns:
| Type | Description |
|---|---|
GeoDataFrame
|
GeoDataFrame with all geometries made valid. |