gemgis.vector.extract_xy#

gemgis.vector.extract_xy(gdf: geopandas.geodataframe.GeoDataFrame, reset_index: bool = True, drop_index: bool = True, drop_id: bool = True, drop_points: bool = True, drop_level0: bool = True, drop_level1: bool = True, overwrite_xy: bool = True, target_crs: Union[str, pyproj.crs.crs.CRS] = None, bbox: Optional[Sequence[float]] = None, remove_total_bounds: bool = False, threshold_bounds: Union[float, int] = 0.1) → geopandas.geodataframe.GeoDataFrame#

Extracting X and Y coordinates from a GeoDataFrame (Points, LineStrings, MultiLineStrings, Polygons, Geometry Collections) and returning a GeoDataFrame with X and Y coordinates as additional columns

Parameters

gdf (gpd.geodataframe.GeoDataFrame) – GeoDataFrame created from vector data such as Shapely Points, LineStrings, MultiLineStrings or Polygons or data loaded from disc with GeoPandas (i.e. Shape File)
reset_index (bool) – Variable to reset the index of the resulting GeoDataFrame. Options include: True or False, default set to True
drop_level0 (bool) – Variable to drop the level_0 column. Options include: True or False, default set to True
drop_level1 (bool) – Variable to drop the level_1 column. Options include: True or False, default set to True
drop_index (bool) – Variable to drop the index column. Options include: True or False, default set to True
drop_id (bool) – Variable to drop the id column. Options include: True or False, default set to True
drop_points (bool) – Variable to drop the points column. Options include: True or False, default set to True
overwrite_xy (bool) – Variable to overwrite existing X and Y values. Options include: True or False, default set to False
target_crs (Union[str, pyproj.crs.crs.CRS]) – Name of the CRS provided to reproject coordinates of the GeoDataFrame, e.g. target_crs='EPSG:4647'
bbox (list) – Values (minx, maxx, miny, maxy) to limit the extent of the data, e.g. bbox=[0, 972, 0, 1069]
remove_total_bounds (bool) – Variable to remove the vertices representing the total bounds of a GeoDataFrame consisting of Polygons Options include: True or False, default set to False
threshold_bounds (Union[float, int]) – Variable to set the distance to the total bound from where vertices are being removed, e.g. threshold_bounds=10, default set to 0.1

Returns

gdf – GeoDataFrame with appended x, y columns and Point geometry features

Return type

gpd.geodataframe.GeoDataFrame

New in version 1.0.x.

Changed in version 1.1: If a GeoDataFrame contains LineStrings and MultiLineStrings, the index of the exploded GeoDataFrame will now be reset. Not resetting the index will cause index errors later on.

Example

>>> # Loading Libraries and File
>>> import gemgis as gg
>>> import geopandas as gpd
>>> gdf = gpd.read_file(filename='file.shp')
>>> gdf
    id      formation   geometry
0       None    Ton             POINT (19.150 293.313)
1       None    Ton             POINT (61.934 381.459)
2       None    Ton             POINT (109.358 480.946)
3       None    Ton             POINT (157.812 615.999)
4       None    Ton             POINT (191.318 719.094)

>>> # Extracting X and Y Coordinates from Shapely Base Geometries
>>> gdf_xy = gg.vector.extract_xy(gdf=gdf, reset_index=False)
>>> gdf_xy
    formation   geometry                X       Y
0       Ton             POINT (19.150 293.313)  19.15   293.31
1       Ton             POINT (61.934 381.459)  61.93   381.46
2       Ton             POINT (109.358 480.946) 109.36  480.95
3       Ton             POINT (157.812 615.999) 157.81  616.00
4       Ton             POINT (191.318 719.094) 191.32  719.09

GemGIS - Spatial data processing for geomodeling

gemgis.vector.extract_xy

gemgis.vector.extract_xy#