pysiral.ers.iotools
===================

.. py:module:: pysiral.ers.iotools


Classes
-------

.. autoapisummary::

   pysiral.ers.iotools.ERSFileList
   pysiral.ers.iotools.ERSCycleBasedSGDR


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

.. py:class:: ERSFileList

   Bases: :py:obj:`pysiral.core.legacy_classes.DefaultLoggingClass`


   Class for the construction of a list of Envisat N1 files
   sorted by acquisition time
   XXX: Currently only support order by month/date and not cycle


   .. py:attribute:: folder
      :value: None



   .. py:attribute:: year
      :value: None



   .. py:attribute:: month
      :value: None



   .. py:attribute:: time_range
      :value: None



   .. py:attribute:: day_list
      :value: []



   .. py:attribute:: pattern
      :value: '.NC'



   .. py:attribute:: _list


   .. py:attribute:: _sorted_list
      :value: []



   .. py:method:: search(time_range)


   .. py:property:: sorted_list


   .. py:method:: _get_file_listing()

      Look for files
      :return:



   .. py:method:: _get_toplevel_search_folder()


.. py:class:: ERSCycleBasedSGDR(cfg)

   Bases: :py:obj:`pysiral.core.legacy_classes.DefaultLoggingClass`


   Template for default pysiral class with logging/error handling capabilities


   .. py:attribute:: error


   .. py:attribute:: cfg


   .. py:method:: get_file_for_period(period)

      Query for Sentinel Level-2 files for a specific period.
      :param period: dateperiods.DatePeriod
      :return: sorted list of filenames



   .. py:method:: _create_date_lookup_table()

      Get a lookup table based on the folder names for each cycle. The content will be stored in
      self._date_lookup_table
      :return: None



   .. py:method:: _reset_file_list()

      Resets the result of previous file searches 



   .. py:method:: _query(period)

      Searches for files in the given period and stores result in property _sorted_list
      :param period: dateperiods.DatePeriod
      :return: None



   .. py:method:: _get_cycle_folders_from_lookup_table(datestr)

      Return a list of cycle folders that contain a date. Should be between 0 and 2
      :param datestr:
      :return:



   .. py:property:: sorted_list