pysiral.retracker.corrections
=============================

.. py:module:: pysiral.retracker.corrections

.. autoapi-nested-parse::

   This module contains range corrections associated with the retracking step



Attributes
----------

.. autoapisummary::

   pysiral.retracker.corrections.SAMOSA_OK


Classes
-------

.. autoapisummary::

   pysiral.retracker.corrections.ERSPulseDeblurring
   pysiral.retracker.corrections.SSBCorrectionJason2


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

.. py:data:: SAMOSA_OK
   :value: True


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

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


   A processing step applying the pulse deblurring correction of
   Peacock 1998 to retracked ranges.

   NOTE: Should only be used for ERS-1/2 data


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

      Compute the pulse deblurring correction

          Hcor = h + eps / 5. (eps < 0)

      based on the classifier data transferred from the l1p (epss: epsilon in seconds).
      :param l1b:
      :param l2:
      :return: error_status_flag



   .. py:property:: l2_input_vars


   .. py:property:: l2_output_vars


   .. py:property:: target_variables


   .. py:property:: error_bit


   .. py:property:: constant_slope


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

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


   A processing step applying a sea state bias correction.

   NOTE: Designed for use with SAMOSA retracker and taken from the Jason 2 mission

   Sea state bias model by Tran et al. (2012), CLS-CNES [1]

   [1]Tran N., S. Philipps, J.-C. Poisson, S. Urien, E. Bronner, N. Picot, "Impact of GDR_D standards on SSB
   corrections", Presentation OSTST2012 in Venice, http://www.aviso.altimetry.fr/fileadmin/
   documents/OSTST/2012/oral/02_friday_28/01_instr_processing_I/01_IP1_Tran.pdf



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

      Compute the ssb correction.
      :param l1b:
      :param l2:
      :return: error_status_flag



   .. py:property:: l2_input_vars


   .. py:property:: l2_output_vars


   .. py:property:: target_variables


   .. py:property:: error_bit