Add a function to fill NaNs in grids by interpolation

verde/tests/test_utils.py

@@ -27,9 +27,28 @@
     meshgrid_to_1d,
     parse_engine,
     partition_by_sum,
+    fill_nans
 )
 
 
+def test_fill_nans():
+    """
+    This function tests the fill_nans function.
+    """
+
+    grid = xr.DataArray([[1, np.nan, 3],
+                        [4, 5, np.nan],
+                        [np.nan, 7, 8]])
+
+    filled_grid = fill_nans(grid)
+    expected_values = xr.DataArray([[1, 1, 3],
+                            [4, 5, 3],
+                            [4, 7, 8]])
+
+    assert np.isnan(filled_grid).sum() == 0
+    assert np.allclose(filled_grid, expected_values)
+
+
 def test_parse_engine():
     "Check that it works for common input"
     assert parse_engine("numba") == "numba"

verde/utils.py

@@ -13,8 +13,10 @@
 import numpy as np
 import pandas as pd
 import xarray as xr
+import verde as vd
 from scipy.spatial import cKDTree
 
+
 try:
     from pykdtree.kdtree import KDTree as pyKDTree
 except ImportError:
@@ -681,6 +683,37 @@ def kdtree(coordinates, use_pykdtree=True, **kwargs):
     return tree
 
 
+def fill_nans(grid):
+    """
+    This methos is responsible for fill the NaN values in the grid using the KNN algorithm.
+
+    Parameters
+    ----------
+    grid : :class:`xarray.DataArray`
+        A 2D grid with one or more data variables.
+    Returns
+    -------
+    grid : :class:`xarray.DataArray`
+        A 2D grid with the NaN values filled.
+    """
+
+    filled_grid = grid.copy()
+
+    not_nan_values = np.argwhere(~np.isnan(grid.values))
+    unknown_indices = np.argwhere(np.isnan(grid.values))
+
+    knn_imputer = vd.KNeighbors()
+    easting, northing = not_nan_values[:, 0], not_nan_values[:, 1]
+    knn_imputer.fit((easting, northing), grid.values[not_nan_values[:, 0],
+                    not_nan_values[:, 1]])
+    predicted_values = knn_imputer.predict((easting, northing))
+
+    for i, idx in enumerate(unknown_indices):
+        filled_grid[tuple(idx)] = predicted_values[i]
+
+    return filled_grid
+
+
 def partition_by_sum(array, parts):
     """
     Partition an array into parts of approximately equal sum.