pysiral.auxdata.mss
===================

.. py:module:: pysiral.auxdata.mss

.. autoapi-nested-parse::

   Important Note:

       All mss 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 MSS subclasses need to register at minimum the following variable:

               mean sea surface (wgs84 elevation in meter):
                   id: mss
                   name: mean_sea_surface

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

                   # Register Variables
                   self.register_auxvar("mss", "mean_sea_surface", value, uncertainty)



Classes
-------

.. autoapisummary::

   pysiral.auxdata.mss.DTU1MinGrid


Functions
---------

.. autoapisummary::

   pysiral.auxdata.mss.egm2wgs_delta_h
   pysiral.auxdata.mss.egm2top_delta_h
   pysiral.auxdata.mss.compute_delta_h


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

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

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


   Parsing Routine for DTU 1 minute global mean sea surface height files


   .. py:attribute:: elevation


   .. 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:



.. py:function:: egm2wgs_delta_h(phi)

.. py:function:: egm2top_delta_h(phi)

.. py:function:: compute_delta_h(a1, b1, a2, b2, phi)