pysiral.dot
===========

.. py:module:: pysiral.dot

.. autoapi-nested-parse::

   @author: Stefan Hendricks

   pysiral module for estimating dynamic ocean topography from existing sea-level anomaly data
   child classes of pysiral.l2proc.procsteps.Level2ProcessorStep.

   NOTES:

       1. The convention of the pysiral Level-2 processor is to compute dynamic ocean topography as

               dot = sla + mdt

          Thus, the auxiliary data set mean dynamic topography (mdt) is a mandatory auxiliary data
          set for the functionality of all classes in this module and the sla anomaly must be
          computed first.



Attributes
----------

.. autoapisummary::

   pysiral.dot.__author__


Classes
-------

.. autoapisummary::

   pysiral.dot.DynamicOceanTopography


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

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


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

   Bases: :py:obj:`pysiral.l2proc.procsteps.Level2ProcessorStep`


   A Level-2 processor step that adds sea ice density and sea ice density uncertainty
   to the L2 data object based on sea ice type classification


   .. py:method:: execute_procstep(l1b, l2)

      Mandatory Level-2 processor method that will execute the processing step and modify the
      L2 data object in-place.
      This method only sets the value of the dynamic ocean topography fields (dot) since
      DOT is a standard Level-2 data item.
      :param l1b:
      :param l2:
      :return:



   .. py:property:: l2_input_vars

      Mandatory property for Level2ProcessorStep children
      :return: list (str)



   .. py:property:: l2_output_vars

      Mandatory property for Level2ProcessorStep children
      :return: list (str)



   .. py:property:: error_bit