"""Checks for various geospatial and IO conditions."""
import collections
import logging
import warnings
from collections.abc import Sequence
from pathlib import Path
from typing import Any, Union
from . import gis_import_error_message
try:
import fiona
import rasterio
from pyproj import CRS
from pyproj.exceptions import CRSError
from shapely.geometry import GeometryCollection, MultiPolygon, Point, shape
except (ImportError, ModuleNotFoundError) as err:
msg = gis_import_error_message.format(Path(__file__).stem)
raise ImportError(msg) from err
import ravenpy.utilities.io as io
LOGGER = logging.getLogger("RavenPy")
[docs]
def single_file_check(file_list: Sequence[Union[str, Path]]) -> Any:
"""
Return the first element of a file list.
Raise an error if the list is empty or contains more than one element.
Parameters
----------
file_list : Sequence of str or Path
Listing of file locations.
"""
if isinstance(file_list, (str, Path)):
return file_list
try:
if len(file_list) > 1:
msg = "Multi-file handling for file is not supported. Exiting."
raise NotImplementedError(msg)
elif len(file_list) == 0:
msg = "No files found. Exiting."
raise FileNotFoundError(msg)
return file_list[0]
except (FileNotFoundError, NotImplementedError) as e:
LOGGER.error(e)
raise
[docs]
def boundary_check(
*args: Union[str, Path],
max_y: Union[int, float] = 60,
min_y: Union[int, float] = -60,
) -> None:
r"""
Verify that boundaries do not exceed specific latitudes for geographic coordinate data. Emit a UserWarning if so.
Parameters
----------
\*args : Sequence of str or Path
str or Path to file(s).
max_y : int or float
Maximum value allowed for latitude. Default: 60.
min_y : int or float
Minimum value allowed for latitude. Default: -60.
"""
vectors = (".gml", ".shp", ".geojson", ".gpkg", ".json")
rasters = (".tif", ".tiff")
for file in args:
file = Path(file)
try:
if file.suffix.lower() in vectors:
src = fiona.open(file, "r")
elif file.suffix.lower() in rasters:
src = rasterio.open(file, "r")
else:
raise FileNotFoundError()
try:
geographic = CRS(src.crs).is_geographic
except CRSError:
geographic = True
src_min_y, src_max_y = src.bounds[1], src.bounds[3]
if geographic and (src_max_y > max_y or src_min_y < min_y):
msg = f"Vector {file} contains geometries in high latitudes. Verify choice of projected CRS is appropriate for analysis."
LOGGER.warning(msg)
warnings.warn(msg, UserWarning, stacklevel=2)
if not geographic:
msg = f"Vector {file} is not in a geographic coordinate system."
LOGGER.warning(msg)
warnings.warn(msg, UserWarning, stacklevel=2)
src.close()
except FileNotFoundError:
msg = f"Unable to read boundaries from {file}"
LOGGER.error(msg)
raise
return
[docs]
def multipolygon_check(geom: GeometryCollection) -> None:
"""
Perform a check to verify a geometry is a MultiPolygon.
Parameters
----------
geom : GeometryCollection
The geometry to check.
Returns
-------
None
"""
if not isinstance(geom, GeometryCollection):
try:
geom = shape(geom)
except AttributeError:
LOGGER.error("Unable to load argument as shapely.geometry.shape().")
raise
if isinstance(geom, MultiPolygon):
LOGGER.warning("Shape is a Multipolygon.")
return
[docs]
def feature_contains(
point: Union[tuple[Union[int, float, str], Union[str, float, int]], Point],
shp: Union[str, Path, list[Union[str, Path]]],
) -> Union[dict, bool]:
"""
Return the first feature containing a location.
Parameters
----------
point : tuple[Union[int, float, str], Union[str, float, int]], Point]
Geographic coordinates of a point (lon, lat) or a shapely Point.
shp : str or Path or list of str or Path
The path to the file storing the geometries.
Returns
-------
dict or bool
The feature found.
Notes
-----
This is really slow. Another approach is to use the `fiona.Collection.filter` method.
"""
if isinstance(point, collections.abc.Sequence) and not isinstance(point, str):
for coord in point:
if isinstance(coord, (int, float)):
pass
point = Point(point)
elif isinstance(point, Point):
pass
else:
raise ValueError(f"point should be shapely.Point or tuple of coordinates, got : {point} of type({type(point)})")
shape_crs = io.crs_sniffer(single_file_check(shp))
if isinstance(shp, list):
shp = shp[0]
for i, _ in enumerate(fiona.listlayers(str(shp))):
with fiona.open(shp, "r", crs=shape_crs, layer=i) as vector:
for f in vector.filter(bbox=(point.x, point.y, point.x, point.y)):
return dict(f)
return False