pysiral.retracker.ocog
======================

.. py:module:: pysiral.retracker.ocog

.. autoapi-nested-parse::

   This OCOG implementation comes from the first phase of the ESA Climate Change Initiative on Sea Ice



Attributes
----------

.. autoapisummary::

   pysiral.retracker.ocog.__author__


Classes
-------

.. autoapisummary::

   pysiral.retracker.ocog.SICCIOcog


Functions
---------

.. autoapisummary::

   pysiral.retracker.ocog.ocog_tail_shape
   pysiral.retracker.ocog.ocog_func
   pysiral.retracker.ocog.ocog_properties


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

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


.. py:class:: SICCIOcog

   Bases: :py:obj:`pysiral.retracker.BaseRetracker`


   Main Retracker Class (all retrackers must be of instance BaseRetracker)
   # TODO: API clean-up is sorely needed.


   .. py:attribute:: retracked_bin
      :value: None



   .. py:attribute:: leading_edge_width
      :value: None



   .. py:attribute:: tail_shape
      :value: None



   .. py:method:: create_retracker_properties(n_records)


   .. py:method:: l2_retrack(range, wfm, indices, radar_mode, is_valid)

      Abstract method, not to be called directly but expected to be overwritten
      by the child class
      :return:



   .. py:method:: _sicci_ice_retracker(range, wfm, indices)


   .. py:method:: _filter_results()

      These thresholds are based on the SICCI code



.. py:function:: ocog_tail_shape(wfm, tracking_point, tail_pad=3)

   From SICCI module 


.. py:function:: ocog_func(wave, percentage, skip)

.. py:function:: ocog_properties(waveform: numpy.ndarray) -> Tuple[float, float, float]

   Computes the three OCOG properties center of gravity, amplitude & width
   of a waveform in range gate units.

   :param waveform: The waveform array

   :return: center of gravity (cog), amplitude & width