polartoolkit.points_inside_shapefile#
- points_inside_shapefile(points, shapefile, crs=None, coord_names=None, hemisphere=None, epsg=None)[source]#
return a subset of a dataframe which is located inside a shapefile.
- Parameters:
points (pandas.DataFrame | geopandas.GeoDataFrame) – dataframe with coordinate columns specified by coord_names to use for defining if within shapefile
shapefile (geopandas.GeoDataFrame) – shapefile to use for defining if point are within it or not
crs (str | None, optional) – if points is not a geodataframe, crs to use to convert into a geodataframe, by default None
coord_names (tuple[str, str] | None, optional) – names of coordinate columns, by default ‘x’ and ‘y’ or ‘easting’ and ‘northing’
hemisphere (str, optional,) – set projection based on “north” or “south” hemispheres, by default None
epsg (str | None, optional) – set projection from EPSG code string (“3031”), by default None
- Returns:
returns a subset dataframe
- Return type: