pysiral.l2preproc
=================

.. py:module:: pysiral.l2preproc

.. autoapi-nested-parse::

   Created on Fri Aug 11 17:07:02 2017

   @author: shendric



Classes
-------

.. autoapisummary::

   pysiral.l2preproc.Level2PreProcessor
   pysiral.l2preproc.Level2PreProcProductDefinition
   pysiral.l2preproc.Level2POutputHandler


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

.. py:class:: Level2PreProcessor(product_def)

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


   Template for default pysiral class with logging/error handling capabilities


   .. py:attribute:: error


   .. py:attribute:: _job


   .. py:method:: process_l2i_files(l2i_files, period)

      Reads all l2i files and merges the valid data into a l2p
      summary file 



   .. py:property:: job


.. py:class:: Level2PreProcProductDefinition

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


   Template for default pysiral class with logging/error handling capabilities


   .. py:attribute:: _output_handler
      :value: None



   .. py:method:: add_output_definition(l2i_product_dir, output_def_file, period='default', overwrite_protection=True, doi=None)


   .. py:property:: output_handler


.. py:class:: Level2POutputHandler(l2i_product_dir, output_def='default', subdirectory=None, period='default', overwrite_protection=True, doi=None)

   Bases: :py:obj:`pysiral.core.output.OutputHandlerBase`


   Default output handler with pysiral conventions. Uses product
   directory from local_machine_def.yaml as standard repository 


   .. py:attribute:: default_file_location
      :value: ['settings', 'outputdef', 'l2p_default.yaml']



   .. py:attribute:: subfolder_tags
      :value: ['year', 'month']



   .. py:attribute:: applicable_data_level
      :value: 2



   .. py:attribute:: l2i_product_dir


   .. py:attribute:: _period
      :value: 'default'



   .. py:attribute:: _doi
      :value: None



   .. py:attribute:: subdirectory
      :value: None



   .. py:attribute:: overwrite_protection
      :value: True



   .. py:method:: get_filename_from_data(l2p: pysiral.l2data.Level2Data) -> str

      Return the filename for a defined level-2 data object
      based on tag filenaming in output definition file 



   .. py:method:: get_directory_from_data(l2p: pysiral.l2data.Level2Data, create: bool = True) -> str

      Return the output directory based on l2 data object metadata

      :param l2p:
      :param create:
      :return:



   .. py:method:: get_fullpath_from_data(l2)

      Return export path and filename based on information
      provided in the l2 data object 



   .. py:method:: get_global_attribute_dict(l2)


   .. py:method:: remove_old(time_range)

      This method will erase all files in the target orbit for a
      given time range. Use with care 



   .. py:method:: _init_product_directory()

      Get main product directory from local_machine_def, add mandatory
      runtag subdirectory, optional second subdirectory for overwrite
      protection and product level id subfolder



   .. py:property:: has_doi


   .. py:property:: doi


   .. py:property:: default_output_def_filename