pysiral.l3proc.alg.flag
=======================

.. py:module:: pysiral.l3proc.alg.flag


Attributes
----------

.. autoapisummary::

   pysiral.l3proc.alg.flag.__author__


Classes
-------

.. autoapisummary::

   pysiral.l3proc.alg.flag.Level3StatusFlag
   pysiral.l3proc.alg.flag.Level3QualityFlag


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

.. py:data:: __author__
   :value: 'Stefan Hendricks <stefan.hendricks@awi.de>'


.. py:class:: Level3StatusFlag(*args, **kwargs)

   Bases: :py:obj:`pysiral.l3proc.Level3ProcessorItem`


   A Level-3 processor item to compute the status flag


   .. py:attribute:: required_options
      :value: ['retrieval_status_target', 'sic_thrs', 'flag_values']



   .. py:attribute:: l2_variable_dependencies
      :value: []



   .. py:attribute:: l3_variable_dependencies
      :value: ['sea_ice_concentration', 'n_valid_waveforms', 'landsea']



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Computes the status flag
      :return:



.. py:class:: Level3QualityFlag(*args, **kwargs)

   Bases: :py:obj:`pysiral.l3proc.Level3ProcessorItem`


   A Level-3 processor item to compute the status flag


   .. py:attribute:: required_options
      :value: ['add_rule_flags', 'rules']



   .. py:attribute:: l2_variable_dependencies
      :value: []



   .. py:attribute:: l3_variable_dependencies
      :value: ['sea_ice_thickness', 'n_valid_waveforms', 'negative_thickness_fraction', 'lead_fraction']



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Computation of quality flag indicator based on several rules defined in the l3 settings file