pysiral.retracker.ccilead
=========================

.. py:module:: pysiral.retracker.ccilead

.. autoapi-nested-parse::

   The SICCILead retracker uses a waveform fitting method for pulse-limited Lead waveforms.
   Its implementation comes from the first phase of the ESA Climate Change Initiative on Sea Ice



Attributes
----------

.. autoapisummary::

   pysiral.retracker.ccilead.__author__


Classes
-------

.. autoapisummary::

   pysiral.retracker.ccilead.SICCILead


Functions
---------

.. autoapisummary::

   pysiral.retracker.ccilead.pl_lead_waveform_model
   pysiral.retracker.ccilead.rms_echo_and_model
   pysiral.retracker.ccilead.power_in_echo_tail


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

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


.. py:class:: SICCILead

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


   .. py:method:: create_retracker_properties(n_records)


   .. py:method:: l2_retrack(rng, 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_lead_retracker(rng, wfm, indices)


   .. py:method:: _filter_results()

      Filter the lead results based on threshold defined in SICCI 



   .. py:method:: __getattr__(item: str) -> Any

      Direct attribute access to the cfg dictionary

      :param item:
      :return:



.. py:function:: pl_lead_waveform_model(t, t_0, k, sigma, a)

   Lead waveform model (for SICCILead curve fitting) 


.. py:function:: rms_echo_and_model(wfm, retracked_bin, k, sigma, alpha)

   The root sum squared difference between the echo and the fitted function
   in the lead retracking is computed. The 5 bins before the tracking point
   are used as the echo rise.


.. py:function:: power_in_echo_tail(wfm, retracked_bin, alpha, pad=3)

   The tail power is computed by summing the bin count in all bins from
   2 bins beyond the tracking point to the end of the range gate, then
   normalised by dividing by the value of alpha returned from the lead
   retracking
   source: SICCI