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

.. py:module:: pysiral.retracker

.. autoapi-nested-parse::

   @author: Stefan Hendricks



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pysiral/retracker/ccilead/index
   /autoapi/pysiral/retracker/corrections/index
   /autoapi/pysiral/retracker/mock/index
   /autoapi/pysiral/retracker/ocog/index
   /autoapi/pysiral/retracker/samosa/index
   /autoapi/pysiral/retracker/samosa_wfm/index
   /autoapi/pysiral/retracker/tfmra/index


Classes
-------

.. autoapisummary::

   pysiral.retracker.BaseRetracker


Package Contents
----------------

.. py:class:: BaseRetracker

   Bases: :py:obj:`object`


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


   .. py:attribute:: _indices
      :value: None



   .. py:attribute:: _classifier
      :value: None



   .. py:attribute:: _l1b
      :value: None



   .. py:attribute:: _l2
      :value: None



   .. py:attribute:: _range
      :value: None



   .. py:attribute:: _power
      :value: None



   .. py:attribute:: _options


   .. py:attribute:: auxdata_output
      :value: []



   .. py:method:: set_options(**opt_dict)


   .. py:method:: set_indices(indices)


   .. py:method:: set_classifier(classifier)


   .. py:method:: init(n_records)


   .. py:method:: register_auxdata_output(var_id, var_name, value, uncertainty=None)

      Add an auxiliary parameter, that will be transferred to the l2data object after retracking



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


   .. py:method:: l2_retrack(rng, pwr, indices, radar_mode, is_valid)
      :abstractmethod:


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



   .. py:method:: get_l1b_parameter(data_group, parameter_name)

      Get any valid level-2 paremeter name 



   .. py:method:: get_l2_parameter(parameter_name)

      Get any valid level-2 paremeter name 



   .. py:method:: _create_default_properties(n_records)


   .. py:method:: create_retracker_properties(n_records)


   .. py:property:: range


   .. py:property:: uncertainty


   .. py:property:: power


   .. py:property:: indices


   .. py:property:: error_flag