1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
|
import unittest
import dask.array as da
import numpy as np
import xarray as xr
from xcube_resampling.constants import (
AGG_METHODS,
FILLVALUE_INT,
FILLVALUE_UINT8,
FILLVALUE_UINT16,
FILLVALUE_UINT32,
)
from xcube_resampling.gridmapping import GridMapping
# noinspection PyProtectedMember
from xcube_resampling.utils import (
_create_empty_dataset,
_get_fill_value,
_get_grid_mapping_name,
_get_prevent_nan_propagation,
_get_spatial_agg_method,
_get_spatial_interp_method,
_prep_spatial_interp_methods_downscale,
_select_variables,
bbox_overlap,
clip_dataset_by_bbox,
get_spatial_coords,
get_utm_crs,
reproject_bbox,
resolution_meters_to_degrees,
)
from .sampledata import create_2x4x4_dataset_with_irregular_coords
class TestUtils(unittest.TestCase):
def test_get_spatial_coords_lon_lat(self):
# Dataset with "lon" and "lat"
ds = xr.Dataset(coords={"lon": [0, 1], "lat": [0, 1]})
x_dim, y_dim = get_spatial_coords(ds)
self.assertEqual((x_dim, y_dim), ("lon", "lat"))
def test_get_spatial_coords_longitude_latitude(self):
# Dataset with "longitude" and "latitude"
ds = xr.Dataset(coords={"longitude": [0, 1], "latitude": [0, 1]})
x_dim, y_dim = get_spatial_coords(ds)
self.assertEqual((x_dim, y_dim), ("longitude", "latitude"))
def test_get_spatial_coords_x_y(self):
# Dataset with "x" and "y"
ds = xr.Dataset(coords={"x": [0, 1], "y": [0, 1]})
x_dim, y_dim = get_spatial_coords(ds)
self.assertEqual((x_dim, y_dim), ("x", "y"))
def test_get_spatial_coords_missing_dims(self):
# Dataset with no recognized spatial dimensions
ds = xr.Dataset(coords={"time": [0, 1]})
with self.assertRaises(KeyError) as context:
get_spatial_coords(ds)
self.assertIn("No standard spatial coordinates found", str(context.exception))
def test_get_utm_crs(self):
crs = get_utm_crs(10, 55.5)
self.assertEqual("EPSG:32632", crs.to_string())
crs = get_utm_crs(5, 60)
self.assertEqual("EPSG:32632", crs.to_string())
crs = get_utm_crs(2.9, 60)
self.assertEqual("EPSG:32631", crs.to_string())
crs = get_utm_crs(8, 75)
self.assertEqual("EPSG:32631", crs.to_string())
crs = get_utm_crs(20, 75)
self.assertEqual("EPSG:32633", crs.to_string())
crs = get_utm_crs(22, 75)
self.assertEqual("EPSG:32635", crs.to_string())
crs = get_utm_crs(40, 75)
self.assertEqual("EPSG:32637", crs.to_string())
def test_select_variables(self):
ds = xr.Dataset(
{
"var1": ("x", [1, 2, 3]),
"var2": ("x", [4, 5, 6]),
"var3": ("x", [7, 8, 9]),
},
coords={"x": [0, 1, 2]},
)
# if variables=None, return dataset with all data variables
result = _select_variables(ds, variables=None)
self.assertEqual(set(result.data_vars), set(ds.data_vars))
# select one variable
result = _select_variables(ds, variables="var1")
self.assertEqual(list(result.data_vars), ["var1"])
self.assertTrue("var1" in result)
# select multiple variables
result = _select_variables(ds, variables=["var1", "var3"])
self.assertEqual(set(result.data_vars), {"var1", "var3"})
self.assertTrue("var2" not in result)
# selecting a variable not in dataset should raise KeyError
with self.assertRaises(KeyError):
_select_variables(ds, variables="nonexistent_var")
def test_n_get_grid_mapping_name(self):
# no grid mapping
ds = xr.Dataset({"var1": ("x", [1, 2, 3])}, coords={"x": [0, 1, 2]})
self.assertIsNone(_get_grid_mapping_name(ds))
# grid mapping in variables attribute
ds = xr.Dataset({"var1": ("x", [1, 2, 3])})
ds["var1"].attrs["grid_mapping"] = "crs_var"
self.assertEqual(_get_grid_mapping_name(ds), "crs_var")
# grid mapping in crs variable
ds = xr.Dataset({"var1": ("x", [1, 2, 3]), "crs": 0}, coords={"x": [0, 1, 2]})
self.assertEqual(_get_grid_mapping_name(ds), "crs")
# grid mapping in spatial ref coordinate
ds = xr.Dataset(
{"var1": ("x", [1, 2, 3])}, coords={"x": [0, 1, 2], "spatial_ref": 0}
)
self.assertEqual(_get_grid_mapping_name(ds), "spatial_ref")
# if multiple grid mapping found, error should be raised.
ds = xr.Dataset({"var1": ("x", [1, 2, 3])})
ds["var1"].attrs["grid_mapping"] = "gm1"
ds["crs"] = 0
with self.assertRaises(AssertionError):
_get_grid_mapping_name(ds)
def test_get_interp_method(self):
int_var = xr.DataArray(np.array([1, 2, 3], dtype=np.int32), dims=["x"])
bool_var = xr.DataArray(
np.array([True, False, True], dtype=np.bool_), dims=["x"]
)
float_var = xr.DataArray(
np.array([1.0, 2.0, 3.0], dtype=np.float32), dims=["x"]
)
# integer type data array
result = _get_spatial_interp_method(None, "var", int_var)
self.assertEqual(result, 0)
# bool type data array
result = _get_spatial_interp_method(None, "var", bool_var)
self.assertEqual(result, 0)
# float type data array
result = _get_spatial_interp_method(None, "var", float_var)
self.assertEqual(result, 1)
# integer scalar
result = _get_spatial_interp_method(1, "var", float_var)
self.assertEqual(result, 1)
# string
result = _get_spatial_interp_method("nearest", "var", int_var)
self.assertEqual(result, "nearest")
# key matching
interp_methods = {"var": "bilinear"}
# noinspection PyTypeChecker
result = _get_spatial_interp_method(interp_methods, "var", float_var)
self.assertEqual(result, "bilinear")
# dtaa type matching
interp_methods = {np.dtype("float32"): "bilinear"}
# noinspection PyTypeChecker
result = _get_spatial_interp_method(interp_methods, "other", float_var)
self.assertEqual(result, "bilinear")
# no matching keys shall trigger a log warning
interp_methods = {"something": "bilinear"}
with self.assertLogs("xcube.resampling", level="DEBUG") as cm:
# noinspection PyTypeChecker
result = _get_spatial_interp_method(interp_methods, "var", int_var)
self.assertEqual(result, 0) # default value
self.assertIn("Defaults are assigned", cm.output[0])
def test_prep_interp_methods_downscale(self):
self.assertIsNone(_prep_spatial_interp_methods_downscale(None))
self.assertEqual(
_prep_spatial_interp_methods_downscale("triangular"), "bilinear"
)
self.assertEqual(_prep_spatial_interp_methods_downscale("nearest"), "nearest")
self.assertEqual(_prep_spatial_interp_methods_downscale(1), 1)
interp_map = {"a": "triangular", "b": "nearest"}
expected = {"a": "bilinear", "b": "nearest"}
# noinspection PyTypeChecker
self.assertEqual(
_prep_spatial_interp_methods_downscale(interp_map),
expected,
)
interp_map = {"a": "nearest", "b": "bilinear"}
# noinspection PyTypeChecker
self.assertEqual(
_prep_spatial_interp_methods_downscale(interp_map),
interp_map,
)
def test_get_agg_method(self):
int_var = xr.DataArray(np.array([1, 2, 3], dtype=np.int32), dims=["x"])
bool_var = xr.DataArray(
np.array([True, False, True], dtype=np.bool_), dims=["x"]
)
float_var = xr.DataArray(
np.array([1.0, 2.0, 3.0], dtype=np.float32), dims=["x"]
)
# integer type data array, default
result = _get_spatial_agg_method(None, "var", int_var)
self.assertEqual(result, AGG_METHODS["center"])
# bool type data array, default
result = _get_spatial_agg_method(None, "var", bool_var)
self.assertEqual(result, AGG_METHODS["center"])
# float type data array, default
result = _get_spatial_agg_method(None, "var", float_var)
self.assertEqual(result, AGG_METHODS["mean"])
# string as method
result = _get_spatial_agg_method("center", "var", float_var)
self.assertEqual(result, AGG_METHODS["center"])
# key matching
agg_methods = {"var": "mean"}
# noinspection PyTypeChecker
result = _get_spatial_agg_method(agg_methods, "var", int_var)
self.assertEqual(result, AGG_METHODS["mean"])
# data type matching
agg_methods = {np.dtype("float32"): "mean"}
# noinspection PyTypeChecker
result = _get_spatial_agg_method(agg_methods, "other", float_var)
self.assertEqual(result, AGG_METHODS["mean"])
# no matching keys triggers log warning
agg_methods = {"something": "mean"}
with self.assertLogs("xcube.resampling", level="DEBUG") as cm:
# noinspection PyTypeChecker
result = _get_spatial_agg_method(agg_methods, "var", int_var)
self.assertEqual(result, AGG_METHODS["center"]) # default value
self.assertIn("Defaults are assigned", cm.output[0])
def test_get_prevent_nan_propagation(self):
int_var = xr.DataArray(np.array([1, 2, 3], dtype=np.int32), dims=["x"])
float_var = xr.DataArray(
np.array([1.0, 2.0, 3.0], dtype=np.float32), dims=["x"]
)
# bool directly
result = _get_prevent_nan_propagation(True, "var", int_var)
self.assertTrue(result)
result = _get_prevent_nan_propagation(False, "var", float_var)
self.assertFalse(result)
# key mapping
prevent_nan_propagations = {"var": True}
# noinspection PyTypeChecker
result = _get_prevent_nan_propagation(prevent_nan_propagations, "var", int_var)
self.assertTrue(result)
# dtype mapping
prevent_nan_propagations = {np.dtype("float32"): True}
# noinspection PyTypeChecker
result = _get_prevent_nan_propagation(
prevent_nan_propagations, "other", float_var
)
self.assertTrue(result)
# missing key/dtype → default False with log warning
prevent_nan_propagations = {"something": True}
with self.assertLogs("xcube.resampling", level="DEBUG") as cm:
# noinspection PyTypeChecker
result = _get_prevent_nan_propagation(
prevent_nan_propagations, "var", int_var
)
self.assertFalse(result)
self.assertIn("Defaults are assigned", cm.output[0])
# prevent_nan_propagations is None → fallback default False
result = _get_prevent_nan_propagation(None, "var", float_var)
self.assertFalse(result)
def test_get_fill_value(self):
uint8_var = xr.DataArray(np.array([1, 2, 3], dtype=np.uint8), dims=["x"])
uint16_var = xr.DataArray(np.array([1, 2, 3], dtype=np.uint16), dims=["x"])
uint32_var = xr.DataArray(np.array([1, 2, 3], dtype=np.uint32), dims=["x"])
int_var = xr.DataArray(np.array([1, 2, 3], dtype=np.int32), dims=["x"])
bool_var = xr.DataArray(
np.array([True, False, True], dtype=np.bool_), dims=["x"]
)
float_var = xr.DataArray(
np.array([1.0, 2.0, 3.0], dtype=np.float32), dims=["x"]
)
# scalar int
result = _get_fill_value(-99, "var", int_var)
self.assertEqual(result, -99)
# scalar float
result = _get_fill_value(-9.9, "var", float_var)
self.assertEqual(result, -9.9)
# mapping by variable name
result = _get_fill_value({"var": 1234}, "var", int_var)
self.assertEqual(result, 1234)
# mapping by dtype
result = _get_fill_value({np.dtype("float32"): 3.14}, "other", float_var)
self.assertEqual(result, 3.14)
# unmatched mapping triggers warning + defaults
with self.assertLogs("xcube.resampling", level="DEBUG") as cm:
result = _get_fill_value({"something": 42}, "var", int_var)
self.assertEqual(result, FILLVALUE_INT)
self.assertIn("Fill value could not be derived", cm.output[0])
# defaults
self.assertEqual(_get_fill_value(None, "var", uint8_var), FILLVALUE_UINT8)
self.assertEqual(_get_fill_value(None, "var", uint16_var), FILLVALUE_UINT16)
self.assertEqual(_get_fill_value(None, "var", uint32_var), FILLVALUE_UINT32)
self.assertEqual(_get_fill_value(None, "var", int_var), FILLVALUE_INT)
self.assertEqual(_get_fill_value(None, "var", bool_var), 0)
self.assertTrue(np.isnan(_get_fill_value(None, "var", float_var)))
def test_reproject_bbox(self):
bbox_wgs84 = [2, 50, 3, 51]
crs_wgs84 = "EPSG:4326"
crs_3035 = "EPSG:3035"
bbox_3035 = [3748675.9529771, 3011432.8944597, 3830472.1359979, 3129432.4914285]
self.assertEqual(bbox_wgs84, reproject_bbox(bbox_wgs84, crs_wgs84, crs_wgs84))
self.assertEqual(bbox_3035, reproject_bbox(bbox_3035, crs_3035, crs_3035))
np.testing.assert_almost_equal(
reproject_bbox(bbox_wgs84, crs_wgs84, crs_3035), bbox_3035
)
np.testing.assert_almost_equal(
reproject_bbox(
reproject_bbox(bbox_wgs84, crs_wgs84, crs_3035), crs_3035, crs_wgs84
),
[
1.829619451017442,
49.93464594063249,
3.1462425554926226,
51.06428203128216,
],
)
def test_bbox_overlap(self):
# identical boxes
bbox = (0, 0, 10, 10)
self.assertEqual(1.0, bbox_overlap(bbox, bbox))
# partial overlap
source = (0, 0, 10, 10)
target = (5, 5, 15, 15)
# overlap area = 25, source area = 100
expected = 25 / 100
self.assertAlmostEqual(expected, bbox_overlap(source, target))
# no overlap
source = (0, 0, 10, 10)
target = (20, 20, 30, 30)
self.assertAlmostEqual(0.0, bbox_overlap(source, target))
# target fully inside source
source = (0, 0, 10, 10)
target = (2, 2, 8, 8)
# overlap area = 36, source area = 100
expected = 0.36
self.assertAlmostEqual(expected, bbox_overlap(source, target))
# source fully inside target
source = (2, 2, 8, 8)
target = (0, 0, 10, 10)
# overlap area = source area = 36
expected = 36 / 36
self.assertAlmostEqual(expected, bbox_overlap(source, target))
# antimeridian - identical wrapped boxes (e.g. 170°E → -170°W)
source = (170, -10, -170, 10)
target = (170, -10, -170, 10)
self.assertEqual(1.0, bbox_overlap(source, target))
# antimeridian - source crosses, target fully inside one side
source = (170, 0, -170, 10)
target = (175, 0, 178, 10)
expected = 30 / 200
self.assertAlmostEqual(expected, bbox_overlap(source, target))
# antimeridian - partial overlap across both segments
source = (170, 0, -170, 10)
target = (160, 0, 175, 10)
expected = 50 / 200
self.assertAlmostEqual(expected, bbox_overlap(source, target))
# antimeridian - non-wrapped target covering entire world
source = (170, 0, -170, 10)
target = (-180, -90, 180, 90)
self.assertEqual(1.0, bbox_overlap(source, target))
# antimeridian - wrapped target covering entire world
source = (170, 0, -170, 10)
target = (170, -90, 169.99, 90)
self.assertEqual(1.0, bbox_overlap(source, target))
# antimeridian - touching at boundary only (no real overlap)
source = (170, 0, -170, 10)
target = (-170, 0, -160, 10)
self.assertAlmostEqual(0.0, bbox_overlap(source, target))
def test_resolution_meters_to_degrees(self):
# 111320 m ≈ 1 degree at equator
lat_deg, lon_deg = resolution_meters_to_degrees(111320, 0)
self.assertAlmostEqual(1.0, lat_deg, places=6)
self.assertAlmostEqual(1.0, lon_deg, places=6)
# 222640 m ≈ 2 degrees latitude
lon_deg, lat_deg = resolution_meters_to_degrees((111320, 222640), 0)
self.assertAlmostEqual(2.0, lat_deg, places=6)
self.assertAlmostEqual(1.0, lon_deg, places=6)
# At 60 degrees latitude, longitude degrees shrink by cos(60°) = 0.5
lon_deg, lat_deg = resolution_meters_to_degrees(111320, 60)
self.assertAlmostEqual(1.0, lat_deg, places=6)
self.assertAlmostEqual(1.0 / 0.5, lon_deg, places=6) # 2 degrees
class TestClipDatasetByBBox(unittest.TestCase):
def setUp(self):
# 1D coordinates dataset
x = np.linspace(1, 10, 10)
y = np.linspace(1, 20, 20)
data_1d = np.random.rand(len(y), len(x))
self.ds_1d = xr.Dataset({"var": (("y", "x"), data_1d)}, coords={"x": x, "y": y})
# 2D coordinates dataset
x2d, y2d = np.meshgrid(x, y)
data_2d = np.random.rand(*x2d.shape)
self.ds_2d = xr.Dataset(
{"var": (("y", "x"), data_2d)},
coords={"lon": (("y", "x"), x2d), "lat": (("y", "x"), y2d)},
)
# 2D coordinates dataset as dark array
x2d, y2d = np.meshgrid(x, y)
data_2d = np.random.rand(*x2d.shape)
self.ds_2d_chunked = xr.Dataset(
{"var": (("row", "column"), data_2d)},
coords={
"lon": (("row", "column"), da.from_array(x2d, chunks=(5, 5))),
"lat": (("row", "column"), da.from_array(y2d, chunks=(5, 5))),
},
)
def test_clip_1dcoord_inside_bbox(self):
bbox = [2, 5, 8, 15] # xmin, ymin, xmax, ymax
clipped = clip_dataset_by_bbox(self.ds_1d, bbox, spatial_coords=("x", "y"))
self.assertTrue((clipped.x >= bbox[0]).all())
self.assertTrue((clipped.x <= bbox[2]).all())
self.assertTrue((clipped.y >= bbox[1]).all())
self.assertTrue((clipped.y <= bbox[3]).all())
def test_clip_2dcoord_inside_bbox(self):
bbox = [2, 5, 8, 15]
clipped = clip_dataset_by_bbox(self.ds_2d, bbox)
self.assertTrue((clipped["lon"].values >= bbox[0]).all())
self.assertTrue((clipped["lon"].values <= bbox[2]).all())
self.assertTrue((clipped["lat"].values >= bbox[1]).all())
self.assertTrue((clipped["lat"].values <= bbox[3]).all())
def test_clip_2dcoord_inside_bbox_chunked(self):
bbox = [2, 5, 8, 15]
clipped = clip_dataset_by_bbox(self.ds_2d_chunked, bbox)
self.assertTrue((clipped["lon"].values >= bbox[0]).all())
self.assertTrue((clipped["lon"].values <= bbox[2]).all())
self.assertTrue((clipped["lat"].values >= bbox[1]).all())
self.assertTrue((clipped["lat"].values <= bbox[3]).all())
def test_clip_dataset_by_bbox_invalid_bbox(self):
with self.assertRaises(ValueError) as context:
clip_dataset_by_bbox(self.ds_1d, bbox=[0, 0, 1])
self.assertIn("Expected bbox of length 4", str(context.exception))
def test_unsupported_coord_dims(self):
ds = self.ds_1d.copy()
ds["x"] = ds["x"].expand_dims("z") # 2D+ coordinate
with self.assertRaises(ValueError):
clip_dataset_by_bbox(ds, [0, 0, 5, 5])
def test_bbox_outside_1d_dataset(self):
bbox = [100, 100, 110, 110] # completely outside
with self.assertLogs("xcube.resampling", level="WARNING") as cm:
clipped = clip_dataset_by_bbox(self.ds_1d, bbox)
self.assertIn(
"Clipped dataset contains at least one zero-sized dimension.", cm.output[0]
)
# should result in zero-sized dimensions
self.assertTrue(any(size == 0 for size in clipped.sizes.values()))
def test_bbox_outside_2d_dataset(self):
bbox = [100, 100, 110, 110] # completely outside
with self.assertLogs("xcube.resampling", level="WARNING") as cm:
clipped = clip_dataset_by_bbox(self.ds_2d, bbox)
self.assertIn(
"Clipped dataset contains at least one zero-sized dimension.", cm.output[0]
)
# should result in zero-sized dimensions
self.assertTrue(any(size == 0 for size in clipped.sizes.values()))
def test_create_empty_dataset_3d(self):
source_ds = create_2x4x4_dataset_with_irregular_coords()
source_ds = source_ds.chunk(dict(y=2, x=2))
source_gm = GridMapping.from_dataset(source_ds)
target_gm = GridMapping.regular(
size=(3, 3), xy_min=(0.0, 0.0), xy_res=0.1, crs="epsg:4326"
)
target_ds = _create_empty_dataset(source_ds, source_gm, target_gm)
self.assertCountEqual(["rad"], target_ds.data_vars)
self.assertCountEqual(("time", "lat", "lon"), target_ds["rad"].dims)
self.assertCountEqual((2, 3, 3), target_ds["rad"].shape)
np.testing.assert_array_equal(
np.isnan(target_ds.rad), np.ones_like(target_ds.rad, dtype=bool)
)
|