pysiral.envisat.l1_adapter
==========================

.. py:module:: pysiral.envisat.l1_adapter


Attributes
----------

.. autoapisummary::

   pysiral.envisat.l1_adapter.__author__


Classes
-------

.. autoapisummary::

   pysiral.envisat.l1_adapter.EnvisatSGDRNC


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

.. py:data:: __author__
   :value: 'Stefan Hendricks'


.. py:class:: EnvisatSGDRNC(cfg: Union[Dict, pysiral.core.legacy_classes.AttrDict], raise_on_error: bool = False)

   Bases: :py:obj:`pysiral.l1preproc.Level1PInputHandlerBase`


   Converts a Envisat SGDR object into a L1bData object 


   .. py:attribute:: timer
      :value: None



   .. py:attribute:: sgdr
      :value: None



   .. py:attribute:: filepath
      :value: None



   .. py:attribute:: l1
      :value: None



   .. py:method:: get_l1(filepath: Union[str, pathlib.Path], polar_ocean_check: Any = None, raise_on_error: bool = False) -> pysiral.l1data.Level1bData

      Read the Envisat SGDR file and transfers its content to a Level1Data instance

      :param raise_on_error:
      :param polar_ocean_check:
      :param filepath: The full file path to the netCDF file

      :return: The parsed (or empty) Level-1 data container



   .. py:method:: _set_input_file_metadata() -> None

      Extract essential metadata information from SGDR file 



   .. py:method:: _set_l1_data_groups() -> None

      Transfer data from the necessary data groups
      :return:



   .. py:method:: _transfer_timeorbit() -> None

      Extracts the time/orbit data group from the SGDR data
      :return:



   .. py:method:: _transfer_waveform_collection()

      Transfers the waveform data (power & range for each range bin)
      :return:



   .. py:method:: _transfer_range_corrections()

      Transfer range correction data from the SGDR netCDF to the
      l1bdata object. The parameters are defined in
      config/mission_def.yaml for ers1/ers2
      -> settings.sgdr_range_correction_targets

      For a description of the parameter see section 3.10 in the
      REAPER handbook



   .. py:method:: _transfer_classifiers()

      Transfer classifier parameter from the SGDR netCDF to the
      l1bdata object. Most parameter are defined in
      config/mission_def.yaml for ers1/ers2
      -> ersX.settings.sgdr_range_correction_targets



   .. py:method:: _transfer_surface_type_data()


   .. py:method:: find_and_interpolate_nans(variable, fill_on_error_value=np.nan)
      :staticmethod:


      Replace NaN's in variable with linear interpolated values
      :param variable:
      :return: interpolated variable



   .. py:method:: interp_1Hz_to_20Hz(variable_1Hz, time_1Hz, time_20Hz, fill_on_error_value=np.nan, **kwargs)
      :staticmethod:


      Computes a simple linear interpolation to transform a 1Hz into a 20Hz variable
      :param variable_1Hz: an 1Hz variable array
      :param time_1Hz: 1Hz reference time
      :param time_20Hz: 20 Hz reference time
      :return: the interpolated 20Hz variable



   .. py:property:: empty

      Default return object, if nodata should be returned
      :return: Representation of an empty object (None)