pysiral.auxdata.mdt
===================

.. py:module:: pysiral.auxdata.mdt

.. autoapi-nested-parse::

   module for Mean Dynamic Topography datasets.

   Important Note:

       All mdt data handlers must be subclasses of pysiral.auxdata.AuxdataBaseClass in order to work
       for the Level-2 Processor. If the auxiliary class is based on a static dataset, this should be parsed
       in `__init__`.

       Please review the variables and properties in the parent class, as well as the correspodning config and
       support classes for grid track interpolation in the pysiral.auxdata module for additional guidance.

       The only other hard requirements is the presence of on specific method in order to be a valid subclass of
       AuxdataBaseClass:


           get_l2_track_vars(l2)

               This method will be called during the Level-2 processor. The argument is the Level-2 data object and
               the purpose of the method is to compute the auxilary variable(s) and associated uncertainty. These
               variable need to be registered using the `register_auxvar(id, name, value, uncertainty)` method of
               the base class. All MDT subclasses need to register at minimum the following variable:

               mean dynamic topography (relative to MSS):
                   id: mdt
                   name: mean_dynamic_topography

               e.g., this code line is mandatory for `get_l2_track_vars` (uncertainty can be None):

                   # Register Variables
                   self.register_auxvar("mdt", "mean_dynamic_topography", value, uncertainty)



Attributes
----------

.. autoapisummary::

   pysiral.auxdata.mdt.__author__


Classes
-------

.. autoapisummary::

   pysiral.auxdata.mdt.DTUMDTGrid


Module Contents
---------------

.. py:data:: __author__
   :value: 'Stefan Hendricks <stefan.hendricks@awi.de>'


.. py:class:: DTUMDTGrid(*args, **kwargs)

   Bases: :py:obj:`pysiral.auxdata.AuxdataBaseClass`


   Parsing Routine for DTU 1/8th degree mean dynamic topography grid


   .. py:attribute:: longitude


   .. py:attribute:: latitude


   .. py:method:: get_l2_track_vars(l2)

      This method raises a NotImplementedError if it is not overwritten by child class
      :return: