.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "gallery/kneighbors_gridder.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        Click :ref:`here <sphx_glr_download_gallery_kneighbors_gridder.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_gallery_kneighbors_gridder.py:


Gridding with a nearest-neighbors interpolator
==============================================

Verde offers the :class:`verde.KNeighbors` class for nearest-neighbor gridding.
The interpolation looks at the data values of the *k* nearest neighbors of a
interpolated point. If *k* is 1, then the data value of the closest neighbor is
assigned to the point. If *k* is greater than 1, the average value of the
closest *k* neighbors is assigned to the point.

The interpolation works on Cartesian data, so if we want to grid geographic
data (like our Baja California bathymetry) we need to project them into a
Cartesian system. We'll use `pyproj <https://github.com/jswhit/pyproj>`__ to
calculate a Mercator projection for the data.

For convenience, Verde still allows us to make geographic grids by passing the
``projection`` argument to :meth:`verde.KNeighbors.grid` and the like. When
doing so, the grid will be generated using geographic coordinates which will be
projected prior to interpolation.

.. GENERATED FROM PYTHON SOURCE LINES 27-93



.. image-sg:: /gallery/images/sphx_glr_kneighbors_gridder_001.png
   :alt: Nearest-neighbor gridding of bathymetry
   :srcset: /gallery/images/sphx_glr_kneighbors_gridder_001.png
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 Out:

 .. code-block:: none

    Data region: (245.0, 254.705, 20.0, 29.99131)
    Generated geographic grid:
    <xarray.Dataset>
    Dimensions:       (latitude: 600, longitude: 583)
    Coordinates:
      * longitude     (longitude) float64 245.0 245.0 245.0 ... 254.7 254.7 254.7
      * latitude      (latitude) float64 20.0 20.02 20.03 ... 29.96 29.97 29.99
    Data variables:
        bathymetry_m  (latitude, longitude) float64 -3.669e+03 -3.669e+03 ... -66.5
    Attributes:
        metadata:  Generated by KNeighbors(k=10, reduction=<function median at 0x...






|

.. code-block:: default

    import cartopy.crs as ccrs
    import matplotlib.pyplot as plt
    import numpy as np
    import pyproj

    import verde as vd

    # We'll test this on the Baja California shipborne bathymetry data
    data = vd.datasets.fetch_baja_bathymetry()

    # Data decimation using verde.BlockReduce is not necessary here since the
    # averaging operation is already performed by the k nearest-neighbor
    # interpolator.

    # Project the data using pyproj so that we can use it as input for the gridder.
    # We'll set the latitude of true scale to the mean latitude of the data.
    projection = pyproj.Proj(proj="merc", lat_ts=data.latitude.mean())
    proj_coordinates = projection(data.longitude, data.latitude)

    # Now we can set up a gridder using the 10 nearest neighbors and averaging
    # using using a median instead of a mean (the default). The median is better in
    # this case since our data are expected to have sharp changes at ridges and
    # faults.
    grd = vd.KNeighbors(k=10, reduction=np.median)
    grd.fit(proj_coordinates, data.bathymetry_m)

    # Get the grid region in geographic coordinates
    region = vd.get_region((data.longitude, data.latitude))
    print("Data region:", region)

    # The 'grid' method can still make a geographic grid if we pass in a projection
    # function that converts lon, lat into the easting, northing coordinates that
    # we used in 'fit'. This can be any function that takes lon, lat and returns x,
    # y. In our case, it'll be the 'projection' variable that we created above.
    # We'll also set the names of the grid dimensions and the name the data
    # variable in our grid (the default would be 'scalars', which isn't very
    # informative).
    grid = grd.grid(
        region=region,
        spacing=1 / 60,
        projection=projection,
        dims=["latitude", "longitude"],
        data_names="bathymetry_m",
    )
    print("Generated geographic grid:")
    print(grid)

    # Cartopy requires setting the coordinate reference system (CRS) of the
    # original data through the transform argument. Their docs say to use
    # PlateCarree to represent geographic data.
    crs = ccrs.PlateCarree()

    plt.figure(figsize=(7, 6))
    # Make a Mercator map of our gridded bathymetry
    ax = plt.axes(projection=ccrs.Mercator())
    # Plot the gridded bathymetry
    pc = grid.bathymetry_m.plot.pcolormesh(
        ax=ax, transform=crs, vmax=0, zorder=-1, add_colorbar=False
    )
    plt.colorbar(pc).set_label("meters")
    # Plot the locations of the data
    ax.plot(data.longitude, data.latitude, ".k", markersize=0.1, transform=crs)
    # Use an utility function to setup the tick labels and the land feature
    vd.datasets.setup_baja_bathymetry_map(ax)
    ax.set_title("Nearest-neighbor gridding of bathymetry")
    plt.show()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** ( 0 minutes  4.128 seconds)


.. _sphx_glr_download_gallery_kneighbors_gridder.py:


.. only :: html

 .. container:: sphx-glr-footer
    :class: sphx-glr-footer-example



  .. container:: sphx-glr-download sphx-glr-download-python

     :download:`Download Python source code: kneighbors_gridder.py <kneighbors_gridder.py>`



  .. container:: sphx-glr-download sphx-glr-download-jupyter

     :download:`Download Jupyter notebook: kneighbors_gridder.ipynb <kneighbors_gridder.ipynb>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_