Fixes #875: add out-of-core dask CPU viewshed

README.md

@@ -225,7 +225,7 @@ In the GIS world, rasters are used for representing continuous phenomena (e.g. e
 | [Hillshade](xrspatial/hillshade.py) | Simulates terrain illumination from a given sun angle and azimuth | ✅️ | ✅️ | ✅️ | ✅️ |
 | [Slope](xrspatial/slope.py) | Computes terrain gradient steepness at each cell in degrees | ✅️  | ✅️  | ✅️ | ✅️  |
 | [Terrain Generation](xrspatial/terrain.py) | Generates synthetic terrain elevation using fractal noise | ✅️ | ✅️ | ✅️ | |
-| [Viewshed](xrspatial/viewshed.py) | Determines visible cells from a given observer point on terrain | ✅️ |  | | |
+| [Viewshed](xrspatial/viewshed.py) | Determines visible cells from a given observer point on terrain | ✅️ | ✅️ | ✅️ | ✅️ |
 | [Min Observable Height](xrspatial/experimental/min_observable_height.py) | Finds the minimum observer height needed to see each cell *(experimental)* | ✅️ | | | |
 | [Perlin Noise](xrspatial/perlin.py) | Generates smooth continuous random noise for procedural textures | ✅️ | ✅️ | ✅️ | |
 | [Bump Mapping](xrspatial/bump.py) | Adds randomized bump features to simulate natural terrain variation | ✅️ | | | |

xrspatial/tests/test_viewshed.py

@@ -1,3 +1,4 @@
+import dask.array as da
 import datashader as ds
 import numpy as np
 import pandas as pd
@@ -6,6 +7,7 @@
 
 from xrspatial import viewshed
 from xrspatial.tests.general_checks import general_output_checks
+from xrspatial.viewshed import INVISIBLE
 
 from ..gpu_rtx import has_rtx
 
@@ -159,3 +161,202 @@ def test_viewshed_flat(backend, observer_elev, target_elev):
         # Should do better with viewshed gpu output angles.
         mask = (v.data < 90)
         np.testing.assert_allclose(v.data[mask], angle[mask], atol=0.03)
+
+
+# -------------------------------------------------------------------
+# Dask backend tests
+# -------------------------------------------------------------------
+
+@pytest.mark.parametrize("observer_elev", [5, 2])
+@pytest.mark.parametrize("target_elev", [0, 1])
+def test_viewshed_dask_flat(observer_elev, target_elev):
+    """Flat terrain: dask should match analytical formula."""
+    x, y = 0, 0
+    ny, nx = 5, 4
+    arr = da.from_array(np.full((ny, nx), 1.3), chunks=(3, 2))
+    xs = np.arange(nx) * 0.5
+    ys = np.arange(ny) * 1.5
+    xarr = xa.DataArray(arr, coords=dict(x=xs, y=ys), dims=["y", "x"])
+    v = viewshed(xarr, x=x, y=y,
+                 observer_elev=observer_elev, target_elev=target_elev)
+    result = v.values
+
+    xs2, ys2 = np.meshgrid(xs, ys)
+    d_vert = observer_elev - target_elev
+    d_horz = np.sqrt((xs2 - x) ** 2 + (ys2 - y) ** 2)
+    expected = np.rad2deg(np.arctan2(d_horz, d_vert))
+    expected[0, 0] = result[0, 0]  # observer cell
+    np.testing.assert_allclose(result, expected)
+
+
+def test_viewshed_dask_matches_numpy():
+    """Dask should closely match numpy R2 sweep on small varied terrain."""
+    np.random.seed(42)
+    ny, nx = 12, 10
+    terrain = np.random.uniform(0, 5, (ny, nx))
+    xs = np.arange(nx, dtype=float)
+    ys = np.arange(ny, dtype=float)
+
+    # numpy reference
+    raster_np = xa.DataArray(terrain.copy(), coords=dict(x=xs, y=ys),
+                             dims=["y", "x"])
+    v_np = viewshed(raster_np, x=5.0, y=6.0, observer_elev=10)
+
+    # dask (will use Tier B — full compute + R2 — on this small grid)
+    raster_da = xa.DataArray(
+        da.from_array(terrain.copy(), chunks=(4, 5)),
+        coords=dict(x=xs, y=ys), dims=["y", "x"])
+    v_da = viewshed(raster_da, x=5.0, y=6.0, observer_elev=10)
+
+    np.testing.assert_allclose(v_da.values, v_np.values)
+
+
+def test_viewshed_dask_max_distance():
+    """max_distance should produce partial viewshed within radius."""
+    ny, nx = 20, 20
+    arr_np = np.zeros((ny, nx))
+    xs = np.arange(nx, dtype=float)
+    ys = np.arange(ny, dtype=float)
+
+    raster_da = xa.DataArray(
+        da.from_array(arr_np, chunks=(10, 10)),
+        coords=dict(x=xs, y=ys), dims=["y", "x"])
+    v = viewshed(raster_da, x=10.0, y=10.0,
+                 observer_elev=5, max_distance=5.0)
+    result = v.values
+
+    # Observer cell is visible
+    assert result[10, 10] == 180.0
+
+    # Cells far beyond max_distance should be INVISIBLE
+    assert result[0, 0] == INVISIBLE
+    assert result[19, 19] == INVISIBLE
+
+    # Cells within max_distance should be visible (flat terrain, observer up)
+    assert result[10, 12] > INVISIBLE  # 2 cells away
+    assert result[8, 10] > INVISIBLE   # 2 cells away
+
+
+def test_viewshed_dask_distance_sweep():
+    """Force the distance-sweep path (Tier C) and verify flat terrain."""
+    from unittest.mock import patch
+
+    ny, nx = 10, 10
+    arr_np = np.full((ny, nx), 0.0)
+    xs = np.arange(nx, dtype=float)
+    ys = np.arange(ny, dtype=float)
+
+    raster_da = xa.DataArray(
+        da.from_array(arr_np, chunks=(5, 5)),
+        coords=dict(x=xs, y=ys), dims=["y", "x"])
+
+    # R2 needs 280*10*10=28000 bytes; Tier B requires <50% of avail.
+    # Output grid is 10*10*8=800 bytes; memory guard requires <80% of avail.
+    # 10000 bytes: skips Tier B (28000 > 5000) and passes guard (800 < 8000).
+    with patch('xrspatial.viewshed._available_memory_bytes',
+               return_value=10_000):
+        v = viewshed(raster_da, x=5.0, y=5.0, observer_elev=5)
+
+    result = v.values
+    assert result[5, 5] == 180.0
+    # All cells on flat terrain should be visible
+    assert (result > INVISIBLE).all()
+
+
+def test_viewshed_dask_max_distance_lazy_output():
+    """max_distance on a large dask raster should produce a lazy output
+    without allocating the full grid in memory."""
+    ny, nx = 100_000, 100_000  # 80 GB if materialized
+    # Don't actually create the data — just define a lazy dask array
+    single_chunk = da.zeros((1000, 1000), chunks=(1000, 1000),
+                            dtype=np.float64)
+    # Tile to 100k x 100k via dask (no memory allocated)
+    big = da.tile(single_chunk, (100, 100))
+    xs = np.arange(nx, dtype=float)
+    ys = np.arange(ny, dtype=float)
+    raster = xa.DataArray(big, coords=dict(x=xs, y=ys), dims=["y", "x"])
+    v = viewshed(raster, x=50000.0, y=50000.0,
+                 observer_elev=5, max_distance=10.0)
+    # Output should be a dask array (lazy), not numpy
+    assert isinstance(v.data, da.Array)
+    assert v.shape == (ny, nx)
+    # Only compute a small slice to verify correctness
+    # max_distance=10 → radius_cells=10 → window is obs ± 10
+    center = v.isel(y=slice(49989, 50012), x=slice(49989, 50012)).values
+    # Observer is at index 11 within this 23-cell slice
+    assert center[11, 11] == 180.0  # observer cell
+    # Cells within the circle should be visible (flat terrain, observer up)
+    assert center[11, 13] > INVISIBLE  # 2 cells away
+    # Corner (49989,49989) is sqrt(11^2+11^2) ≈ 15.6 from observer → outside
+    assert center[0, 0] == INVISIBLE
+
+
+def test_viewshed_numpy_max_distance():
+    """max_distance should work on plain numpy raster too."""
+    ny, nx = 20, 20
+    arr_np = np.zeros((ny, nx))
+    xs = np.arange(nx, dtype=float)
+    ys = np.arange(ny, dtype=float)
+
+    raster_np = xa.DataArray(arr_np, coords=dict(x=xs, y=ys),
+                             dims=["y", "x"])
+    v = viewshed(raster_np, x=10.0, y=10.0,
+                 observer_elev=5, max_distance=5.0)
+    result = v.values
+
+    assert result[10, 10] == 180.0
+    assert result[0, 0] == INVISIBLE
+    assert result[19, 19] == INVISIBLE
+    assert result[10, 12] > INVISIBLE
+
+
+@pytest.mark.parametrize("backend", ["numpy", "cupy"])
+def test_viewshed_max_distance_matches_full(backend):
+    """max_distance results should match full viewshed within the radius."""
+    if backend == "cupy":
+        if not has_rtx():
+            pytest.skip("rtxpy not available")
+        else:
+            import cupy as cp
+
+    ny, nx = 10, 8
+    np.random.seed(123)
+    arr = np.random.uniform(0, 3, (ny, nx))
+    xs = np.arange(nx, dtype=float)
+    ys = np.arange(ny, dtype=float)
+    if backend == "cupy":
+        arr_backend = cp.asarray(arr)
+    else:
+        arr_backend = arr.copy()
+
+    raster = xa.DataArray(arr_backend, coords=dict(x=xs, y=ys),
+                          dims=["y", "x"])
+    v_full = viewshed(raster, x=4.0, y=5.0, observer_elev=10)
+
+    if backend == "cupy":
+        arr_backend = cp.asarray(arr)
+    else:
+        arr_backend = arr.copy()
+    raster2 = xa.DataArray(arr_backend, coords=dict(x=xs, y=ys),
+                           dims=["y", "x"])
+    v_dist = viewshed(raster2, x=4.0, y=5.0, observer_elev=10,
+                      max_distance=3.5)
+
+    full_vals = v_full.values if isinstance(v_full.data, np.ndarray) \
+        else v_full.data.get()
+    dist_vals = v_dist.values if isinstance(v_dist.data, np.ndarray) \
+        else v_dist.data.get()
+
+    # Within the circular radius, results should match
+    obs_r, obs_c = 5, 4
+    max_d = 3.5
+    for r in range(max(0, obs_r - 3), min(ny, obs_r + 4)):
+        for c in range(max(0, obs_c - 3), min(nx, obs_c + 4)):
+            dr = (r - obs_r) * 1.0  # ns_res = 1
+            dc = (c - obs_c) * 1.0  # ew_res = 1
+            if np.sqrt(dr**2 + dc**2) > max_d:
+                continue  # outside circle — correctly INVISIBLE
+            np.testing.assert_allclose(
+                dist_vals[r, c], full_vals[r, c],
+                atol=0.03,
+                err_msg=f"Mismatch at ({r},{c})")