pysiral.l3proc.alg.statistics
=============================

.. py:module:: pysiral.l3proc.alg.statistics


Attributes
----------

.. autoapisummary::

   pysiral.l3proc.alg.statistics.__author__


Classes
-------

.. autoapisummary::

   pysiral.l3proc.alg.statistics.Level3ValidSeaIceFreeboardCount
   pysiral.l3proc.alg.statistics.Level3SurfaceTypeStatistics
   pysiral.l3proc.alg.statistics.Level3TemporalCoverageStatistics
   pysiral.l3proc.alg.statistics.Level3GriddedClassifiers


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

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


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

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


   A Level-3 processor item to count valid sea ice freeboard values.
   This class should be used for very limited l2i outputs files that
   do not have the surface_type variable necessary for
   `Level3SurfaceTypeStatistics`


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



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



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



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Computes the number of valid sea_ice_freeboard values



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

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


   A Level-3 processor item to compute surface type stastics 


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



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



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



   .. py:attribute:: l3_output_variables


   .. py:attribute:: _surface_type_dict


   .. py:method:: apply()

      Computes the mandatory surface type statistics on the surface type stack flag

      The current list
        - is_land (land flag exists in l2i stack)
        - n_total_waveforms (size of l2i stack)
        - n_valid_waveforms (tagged as either lead, sea ice or ocean )
        - valid_fraction (n_valid/n_total)
        - lead_fraction (n_leads/n_valid)
        - ice_fraction (n_ice/n_valid)
        - ocean_fraction (n_ocean/n_valid)
        - negative thickness fraction (n_sit<0 / n_sit)



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

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


   A Level-3 processor item to compute temporal coverage statistics of sea-ice thickness in the grid period


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



   .. py:attribute:: l2_variable_dependencies
      :value: ['time', 'sea_ice_thickness']



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



   .. py:attribute:: l3_output_variables


   .. py:method:: apply()

      Computes statistics of the temporal coverage of sea ice thickness
      :return:



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

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


   A Level-3 processor item to provide gridded classifiers (for different surface types)


   .. py:attribute:: required_options
      :value: ['parameters', 'surface_types', 'statistics']



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



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



   .. py:attribute:: l3_output_variables


   .. py:attribute:: _surface_type_dict


   .. py:attribute:: _stat_functions


   .. py:method:: apply()

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



   .. py:method:: _compute_grid_variable(parameter_name, classifier_stack, surface_type, target_surface_type, statistic)

      Computes gridded surface type statistics for all grid cells
      :param parameter_name: The name of the classifier (for output name generation)
      :param classifier_stack: The Level-2 stack for the given classifier
      :param surface_type: The Level-2 stack of surface type
      :param target_surface_type: The name of the target surface type
      :param statistic: The name of the statistic to be computed
      :return: