pysiral.sentinel3.iotools
=========================

.. py:module:: pysiral.sentinel3.iotools


Classes
-------

.. autoapisummary::

   pysiral.sentinel3.iotools.Sentinel3FileList
   pysiral.sentinel3.iotools.CodaL2SralFileDiscovery
   pysiral.sentinel3.iotools.L2SeaIceFileDiscovery
   pysiral.sentinel3.iotools.S3FileNaming


Functions
---------

.. autoapisummary::

   pysiral.sentinel3.iotools.get_sentinel3_l1b_filelist
   pysiral.sentinel3.iotools.get_sentinel3_sral_l1_from_l2


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

.. py:class:: Sentinel3FileList

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


   Class for the construction of a list of Sentinel-3 SRAL L2 files
   sorted by acquisition time
   XXX: Based on the file and directory structure of the early access data


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



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



   .. py:attribute:: target
      :value: 'enhanced_measurement.nc'



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



   .. py:method:: search(time_range)

      Find all files falling in a defined time range 



   .. py:property:: sorted_list


   .. py:method:: _get_file_listing()

      List all files in time range 



   .. py:method:: _get_toplevel_search_folder(year, month)


.. py:class:: CodaL2SralFileDiscovery(cfg)

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


   Class to retrieve Sentinel-3 SRAL files from the Copernicus Online Data Archive 


   .. 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:: _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_toplevel_search_folder(year, month)

      Get the folder for the file search 



   .. py:method:: _reset_file_list()

      Resets the result of previous file searches 



   .. py:property:: sorted_list

      Return the search result 



.. py:class:: L2SeaIceFileDiscovery(cfg)

   Bases: :py:obj:`object`


   Class to retrieve Sentinel-3 SRAL files from the Copernicus Online Data Archive 


   .. py:attribute:: cfg


   .. py:attribute:: catalogue


   .. py:method:: _get_dataset_catalogue() -> pandas.DataFrame

      Create a catalogues of file properties for all Sentinel-3 files in the lookup directory

      :return: catalogue as pandas DataFrame



   .. 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:: _query(period: dateperiods.DatePeriod) -> None

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



   .. py:method:: _reset_file_list()

      Resets the result of previous file searches 



   .. py:property:: sorted_list

      Return the search result 



   .. py:property:: n_catalogue_files
      :type: int


      Return the number of files in the file catalogue
      :return:



.. py:function:: get_sentinel3_l1b_filelist(folder, target_nc_filename)

   Returns a list with measurement.nc files for given month 


.. py:function:: get_sentinel3_sral_l1_from_l2(l2_filename, target='enhanced_measurement.nc')

   Returns the corresponding sral l1 file to a given l2 filename 


.. py:class:: S3FileNaming

   Deciphering the Sentinel-3 filenaming convention
   (source: Sentinel 3 PDGS File Naming Convention (EUM/LEO-SEN3/SPE/10/0070, v1D, 24 June 2016)


   .. py:attribute:: filepath
      :type:  pathlib.Path


   .. py:attribute:: is_valid_file
      :type:  bool


   .. py:attribute:: file_id
      :type:  str


   .. py:attribute:: mission_id
      :type:  str


   .. py:attribute:: data_source
      :type:  str


   .. py:attribute:: processing_level
      :type:  str


   .. py:attribute:: data_type_id
      :type:  str


   .. py:attribute:: time_coverage_start
      :type:  datetime.datetime


   .. py:attribute:: time_coverage_end
      :type:  datetime.datetime


   .. py:attribute:: creation_time
      :type:  datetime.datetime


   .. py:attribute:: instance_id
      :type:  str


   .. py:attribute:: product_generation_center
      :type:  str


   .. py:attribute:: product_platform
      :type:  str


   .. py:attribute:: timeliness
      :type:  str


   .. py:attribute:: baseline
      :type:  str


   .. py:attribute:: extension
      :type:  str


   .. py:method:: __post_init__()