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

.. only:: html

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

        :ref:`Go to the end <sphx_glr_download_basic_examples_plot_nuth_kaab.py>`
        to download the full example code

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

.. _sphx_glr_basic_examples_plot_nuth_kaab.py:


Nuth and Kääb coregistration
============================

Nuth and Kääb (`2011 <https:https://doi.org/10.5194/tc-5-271-2011>`_) coregistration allows for horizontal and vertical shifts to be estimated and corrected for.
In ``xdem``, this approach is implemented through the :class:`xdem.coreg.NuthKaab` class.

For more information about the approach, see :ref:`coregistration-nuthkaab`.

.. GENERATED FROM PYTHON SOURCE LINES 10-15

.. code-block:: default

    import geoutils as gu
    import numpy as np

    import xdem








.. GENERATED FROM PYTHON SOURCE LINES 16-17

**Example files**

.. GENERATED FROM PYTHON SOURCE LINES 17-25

.. code-block:: default

    reference_dem = xdem.DEM(xdem.examples.get_path("longyearbyen_ref_dem"))
    dem_to_be_aligned = xdem.DEM(xdem.examples.get_path("longyearbyen_tba_dem"))
    glacier_outlines = gu.Vector(xdem.examples.get_path("longyearbyen_glacier_outlines"))

    # Create a stable ground mask (not glacierized) to mark "inlier data"
    inlier_mask = ~glacier_outlines.create_mask(reference_dem)









.. GENERATED FROM PYTHON SOURCE LINES 26-28

The DEM to be aligned (a 1990 photogrammetry-derived DEM) has some vertical and horizontal biases that we want to avoid.
These can be visualized by plotting a change map:

.. GENERATED FROM PYTHON SOURCE LINES 28-33

.. code-block:: default


    diff_before = reference_dem - dem_to_be_aligned
    diff_before.show(cmap="coolwarm_r", vmin=-10, vmax=10, cbar_title="Elevation change (m)")





.. image-sg:: /basic_examples/images/sphx_glr_plot_nuth_kaab_001.png
   :alt: plot nuth kaab
   :srcset: /basic_examples/images/sphx_glr_plot_nuth_kaab_001.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 34-36

Horizontal and vertical shifts can be estimated using :class:`xdem.coreg.NuthKaab`.
First, the shifts are estimated, and then they can be applied to the data:

.. GENERATED FROM PYTHON SOURCE LINES 36-43

.. code-block:: default


    nuth_kaab = xdem.coreg.NuthKaab()

    nuth_kaab.fit(reference_dem, dem_to_be_aligned, inlier_mask)

    aligned_dem = nuth_kaab.apply(dem_to_be_aligned)








.. GENERATED FROM PYTHON SOURCE LINES 44-45

Then, the new difference can be plotted to validate that it improved.

.. GENERATED FROM PYTHON SOURCE LINES 45-50

.. code-block:: default


    diff_after = reference_dem - aligned_dem
    diff_after.show(cmap="coolwarm_r", vmin=-10, vmax=10, cbar_title="Elevation change (m)")





.. image-sg:: /basic_examples/images/sphx_glr_plot_nuth_kaab_002.png
   :alt: plot nuth kaab
   :srcset: /basic_examples/images/sphx_glr_plot_nuth_kaab_002.png
   :class: sphx-glr-single-img





.. GENERATED FROM PYTHON SOURCE LINES 51-52

We compare the median and NMAD to validate numerically that there was an improvement (see :ref:`robuststats-meanstd`):

.. GENERATED FROM PYTHON SOURCE LINES 52-61

.. code-block:: default

    inliers_before = diff_before[inlier_mask]
    med_before, nmad_before = np.median(inliers_before), xdem.spatialstats.nmad(inliers_before)

    inliers_after = diff_after[inlier_mask]
    med_after, nmad_after = np.median(inliers_after), xdem.spatialstats.nmad(inliers_after)

    print(f"Error before: median = {med_before:.2f} - NMAD = {nmad_before:.2f} m")
    print(f"Error after: median = {med_after:.2f} - NMAD = {nmad_after:.2f} m")





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

 .. code-block:: none

    /home/docs/checkouts/readthedocs.org/user_builds/xdem-erikm/conda/latest/lib/python3.11/site-packages/numpy/core/fromnumeric.py:784: UserWarning: Warning: 'partition' will ignore the 'mask' of the MaskedArray.
      a.partition(kth, axis=axis, kind=kind, order=order)
    Error before: median = -2.33 - NMAD = 3.42 m
    Error after: median = -0.01 - NMAD = 2.51 m




.. GENERATED FROM PYTHON SOURCE LINES 62-65

In the plot above, one may notice a positive (blue) tendency toward the east.
The 1990 DEM is a mosaic, and likely has a "seam" near there.
:ref:`sphx_glr_advanced_examples_plot_blockwise_coreg.py` tackles this issue, using a nonlinear coregistration approach.


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

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


.. _sphx_glr_download_basic_examples_plot_nuth_kaab.py:

.. only:: html

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




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

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

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

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


.. only:: html

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

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