pysiral.l2proc
==============

.. py:module:: pysiral.l2proc

.. autoapi-nested-parse::

   Created on Fri Jul 24 14:04:27 2015

   @author: Stefan



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/pysiral/l2proc/procsteps/index


Classes
-------

.. autoapisummary::

   pysiral.l2proc.Level2ProcessorStepOrder
   pysiral.l2proc.Level2Processor
   pysiral.l2proc.Level2ProductDefinition


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

.. py:class:: Level2ProcessorStepOrder(cfg)

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


   A container providing the ordered list of processing steps
   as initialized classes for each trajectory


   .. py:attribute:: cfg


   .. py:attribute:: _classes
      :value: []



   .. py:method:: get_procstep_classes()

      Retrieves the required classes from the processor definition files and stores them in a list
      without initializing them. This way a freshly initialized version can be supplied to each
      l2 data object without risk of interference of class properties
      :return:



   .. py:method:: get_algorithm_error_flag_bit(procstep_module)

      Return the corresponding bit (0-15) for the procstep module
      :param procstep_module: str
      :return:



   .. py:method:: validate() -> bool

      Checkout the difference processing steps and validate input/output variables in
      the order of the steps
      :return:



   .. py:property:: class_list

      Return a list of not initialized classes (class instances with the options from the level-2
      :return:



   .. py:property:: class_instances

      Return a list of initialized classes (class instances with the options from the level-2 processor
      definition file passed to the class instance)
      :return:



.. py:class:: Level2Processor(product_def, auxclass_handler=None)

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


   Template for default pysiral class with logging/error handling capabilities


   .. py:attribute:: _l2def


   .. py:attribute:: _auxclass_handler
      :value: None



   .. py:attribute:: _registered_auxdata_handlers
      :value: []



   .. py:attribute:: _auxhandlers


   .. py:attribute:: procsteps
      :value: None



   .. py:attribute:: _output_handler


   .. py:attribute:: _orbit


   .. py:attribute:: _l1b_files
      :value: []



   .. py:attribute:: _config


   .. py:attribute:: _initialized
      :value: False



   .. py:method:: set_l1b_files(l1b_files)


   .. py:method:: process_l1b_files(l1b_files)


   .. py:method:: run()

      Run the processor 



   .. py:method:: initialize_processor()

      Read required auxiliary data sets 



   .. py:method:: set_auxdata_handler()

      Adds all auxdata types from the l2 config file to the Level-2 processor instance
      :return: None



   .. py:method:: set_procstep_handler()

      Add and initialize Level-2 processor items

      :return: None



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

      Executes all Level-2 processor steps.

      Note: This is where the algorithm are executed in their order defined
            in the Level-2 processor definition file

      :param l1b:
      :param l2:

      :return: None



   .. py:method:: _report_output_location()


   .. py:method:: _l2_processing_of_orbit_files()

      Orbit-wise level2 processing 



   .. py:method:: _read_l1b_file(l1b_file)

      Read a L1b data file (l1bdata netCDF) 



   .. py:method:: get_auxiliary_data(l1p: pysiral.l1data.L1bdataNCFile, l2: pysiral.l2data.Level2Data)

      Transfer along-track data from all registered auxdata handler to the l2 data object 



   .. py:method:: _create_l2_outputs(l2)


   .. py:method:: _add_to_orbit_collection(l2)


   .. py:property:: orbit


   .. py:property:: has_empty_file_list


   .. py:property:: l2def


   .. py:property:: registered_auxdata_handlers


   .. py:property:: l2_auxdata_source_dict

      A dictionary that contains the descriptions of the auxiliary data sources 



.. py:class:: Level2ProductDefinition(l2_settings_file: str, force_l2def_record_type: bool = False)

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


   Main configuration class for the Level-2 Processor 


   .. py:attribute:: error


   .. py:attribute:: _l2_settings_file


   .. py:attribute:: _run_tag


   .. py:attribute:: force_l2def_record_type
      :value: False



   .. py:attribute:: _output_handler
      :value: []



   .. py:method:: add_output_definition(output_def_file: Union[str, pathlib.Path], period: str = 'default', overwrite_protection: bool = False) -> None


   .. py:method:: _parse_l2_settings()


   .. py:method:: _get_run_tag() -> str

      Set the run tag (will be used for defining the output path)

      :return:



   .. py:property:: run_tag


   .. py:property:: l2def


   .. py:property:: auxdata


   .. py:property:: procsteps


   .. py:property:: product_line


   .. py:property:: record_type


   .. py:property:: platform


   .. py:property:: version


   .. py:property:: file_version_tag


   .. py:property:: label


   .. py:property:: hemisphere


   .. py:property:: hemisphere_code


   .. py:property:: output_handler