Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

raise error when xarray dataset have wrong geo information #726

Merged
merged 6 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# unreleased

* raise `MissingCRS` or `InvalidGeographicBounds` errors when Xarray datasets have wrong geographic metadata
* better error message for `TileOutsideBounds` errors (author @abarciauskas-bgse, https://github.com/cogeotiff/rio-tiler/pull/712)
* handle of inverted latitude in `reader.point` (author @georgespill, https://github.com/cogeotiff/rio-tiler/pull/716)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/readers.md
Original file line number Diff line number Diff line change
Expand Up @@ -1179,4 +1179,4 @@ print(info.json(exclude_none=True))
!!! Important

Not Implemented
```

8 changes: 8 additions & 0 deletions rio_tiler/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,3 +83,11 @@ class AssetAsBandError(RioTilerError):

class InvalidPointDataError(RioTilerError):
"""Invalid PointData."""


class MissingCRS(RioTilerError):
"""Dataset doesn't have CRS information."""


class InvalidGeographicBounds(RioTilerError):
"""Invalid Geographic bounds."""
19 changes: 18 additions & 1 deletion rio_tiler/io/xarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,12 @@
from rasterio.warp import transform as transform_coords

from rio_tiler.constants import WEB_MERCATOR_TMS, WGS84_CRS
from rio_tiler.errors import PointOutsideBounds, TileOutsideBounds
from rio_tiler.errors import (
InvalidGeographicBounds,
MissingCRS,
PointOutsideBounds,
TileOutsideBounds,
)
from rio_tiler.io.base import BaseReader
from rio_tiler.models import BandStatistics, ImageData, Info, PointData
from rio_tiler.types import BBox, NoData, WarpResampling
Expand Down Expand Up @@ -72,6 +77,18 @@ def __attrs_post_init__(self):

self.bounds = tuple(self.input.rio.bounds())
self.crs = self.input.rio.crs
if not self.crs:
raise MissingCRS(
"Dataset doesn't have CRS information, please add it before using rio-tiler (e.g. `ds.rio.write_crs('epsg:4326', inplace=True)`)"
)

if self.crs == WGS84_CRS and (
self.bounds[0] < -180
vincentsarago marked this conversation as resolved.
Show resolved Hide resolved
or min(self.bounds[1], self.bounds[3]) < -90
or self.bounds[2] > 180
vincentsarago marked this conversation as resolved.
Show resolved Hide resolved
or max(self.bounds[1], self.bounds[3]) > 90
):
raise InvalidGeographicBounds(f"Invalid geographic bounds: {self.bounds}")
vincentsarago marked this conversation as resolved.
Show resolved Hide resolved

self._dims = [
d
Expand Down
51 changes: 51 additions & 0 deletions tests/test_io_xarray.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import rioxarray
import xarray

from rio_tiler.errors import InvalidGeographicBounds, MissingCRS
from rio_tiler.io import XarrayReader


Expand Down Expand Up @@ -321,3 +322,53 @@ def test_xarray_reader_resampling():

with pytest.warns(DeprecationWarning):
_ = dst.feature(feat, resampling_method="nearest")


def test_xarray_reader_no_crs():
"""Should raise MissingCRS."""
arr = numpy.arange(0.0, 33 * 35).reshape(1, 33, 35)
data = xarray.DataArray(
arr,
dims=("time", "y", "x"),
coords={
"x": numpy.arange(-170, 180, 10),
"y": numpy.arange(-80, 85, 5),
"time": [datetime(2022, 1, 1)],
},
)
data.attrs.update({"valid_min": arr.min(), "valid_max": arr.max()})
with pytest.raises(MissingCRS):
with XarrayReader(data):
pass


def test_xarray_reader_invalid_bounds_crs():
"""Should raise InvalidGeographicBounds."""
arr = numpy.arange(0.0, 33 * 35).reshape(1, 33, 35)
data = xarray.DataArray(
arr,
dims=("time", "y", "x"),
coords={
"x": list(range(10, 360, 10)),
"y": list(range(-80, 85, 5)),
"time": [datetime(2022, 1, 1)],
},
)
data.rio.write_crs("epsg:4326", inplace=True)
with pytest.raises(InvalidGeographicBounds):
with XarrayReader(data):
pass

data = xarray.DataArray(
arr,
dims=("time", "y", "x"),
coords={
"x": list(range(-170, 180, 10)),
"y": list(range(15, 180, 5)),
"time": [datetime(2022, 1, 1)],
},
)
data.rio.write_crs("epsg:4326", inplace=True)
with pytest.raises(InvalidGeographicBounds):
with XarrayReader(data):
pass
Loading