pysiral.sit
===========

.. py:module:: pysiral.sit

.. autoapi-nested-parse::

   Created on Mon Apr 25 17:15:39 2016

   @author: shendric



Classes
-------

.. autoapisummary::

   pysiral.sit.AlexandrovSeaIceDensity
   pysiral.sit.SeaIceFreeboard2SIT
   pysiral.sit.SnowFreeboard2SIT
   pysiral.sit.L2SeaIceDraft


Functions
---------

.. autoapisummary::

   pysiral.sit.icefreeboard2thickness
   pysiral.sit.snowfreeboard2thickness
   pysiral.sit.frb2sit_errprop


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

.. py:class:: AlexandrovSeaIceDensity(*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 method for the Level2ProcessorStep class. Will add sea ice density
      and uncertainty computed from the sea ice type (interpreted as multi-year ice fraction)
      and add output parameters to the L2 data object
      :param l1b:
      :param l2:
      :return: Error Status



   .. py:property:: l2_input_vars


   .. py:property:: l2_output_vars


   .. py:property:: error_bit


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

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


   Classical freeboard to thickness conversion assuming that the variable freeboard
   represent sea ice freeboard.


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

      Compute sea ice thickness based on a Level-2 data object
      - Assuming freeboard is sea ice freeboard
      :param l1b:
      :param l2:
      :return:



   .. py:property:: l2_input_vars


   .. py:property:: l2_output_vars


   .. py:property:: error_bit


   .. py:property:: func

      Return the function for transforming sea-ice freeboard to thickness
      :return:



   .. py:property:: uncfunc

      Return the function for computing sea-ice thickness uncertainty
      :return:



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

   Bases: :py:obj:`SeaIceFreeboard2SIT`


   Variant of the SeaIceFreeboard2SIT, but for snow freeboard to thickness conversion.
   This is implemented as the children to SeaIceFreeboard2SIT, with only different
   pointer to the correct functions


   .. py:property:: func

      Return the function for transforming sea-ice freeboard to thickness
      :return:



   .. py:property:: uncfunc

      Return the function for computing sea-ice thickness uncertainty
      :return:



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

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


   A Level-2 processor step class for computing sea ice draft and its uncertainty


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

      API class for the Level-2 processor. Functionality is to compute sea ice draft and its uncertainty
      :param l1b: Level-1 data instance
      :param l2: A Level-2 data instance
      :return: None, Level-2 object is change in place



   .. py:property:: l2_input_vars


   .. py:property:: l2_output_vars


   .. py:property:: error_bit


.. py:function:: icefreeboard2thickness(frb, sd, rho_w, rho_i, rho_s)

.. py:function:: snowfreeboard2thickness(frb, sd, rho_w, rho_i, rho_s)

.. py:function:: frb2sit_errprop(frb, sd, rho_w, rho_i, rho_s, frb_unc, sd_unc, rho_i_unc, rho_s_unc)