pysiral.l3proc.alg.mask
=======================

.. py:module:: pysiral.l3proc.alg.mask


Attributes
----------

.. autoapisummary::

   pysiral.l3proc.alg.mask.__author__


Classes
-------

.. autoapisummary::

   pysiral.l3proc.alg.mask.Level3LoadMasks
   pysiral.l3proc.alg.mask.Level3LoadCCILandMask
   pysiral.l3proc.alg.mask.Level3ParameterMask


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

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


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

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


   A Level-3 processor item to load external masks


   .. py:attribute:: required_options
      :value: ['mask_names']



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



   .. py:attribute:: l3_variable_dependencies
      :value: []



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Load masks and add them as grid variable (variable name -> mask name)
      :return:



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

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


   A Level-3 processor item to load the CCI land mask


   .. py:attribute:: required_options
      :value: ['local_machine_def_mask_tag', 'mask_name_dict']



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



   .. py:attribute:: l3_variable_dependencies
      :value: []



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Load masks and add them as grid variable (variable name -> mask name)
      :return:



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

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


   A Level-3 processor item to load external masks


   .. py:attribute:: required_options
      :value: ['source', 'condition', 'targets']



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



   .. py:attribute:: l3_variable_dependencies
      :value: []



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Mask certain parameters based on condition of one other parameter
      :return:



   .. py:method:: _get_l3_mask(source_param, condition, options)

      Return bool array based on a parameter and a predefined
      masking operation