demcompare.stats_processing
===========================

.. py:module:: demcompare.stats_processing

.. autoapi-nested-parse::

   Mainly contains the StatsProcessing class
   for stats computation of an input dem



Classes
-------

.. autoapisummary::

   demcompare.stats_processing.StatsProcessing


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

.. py:class:: StatsProcessing(cfg: Dict, dem: xarray.Dataset = None, dem_processing_method: str = None)

   StatsProcessing class


   .. py:attribute:: _DEFAULT_GLOBAL_LAYER_NAME
      :value: 'global'



   .. py:attribute:: _DEFAULT_GLOBAL_LAYER


   .. py:attribute:: _REMOVE_OUTLIERS
      :value: False



   .. py:attribute:: _DEFAULT_METRICS


   .. py:attribute:: cfg
      :type:  Dict


   .. py:attribute:: output_dir
      :type:  Union[str, None]


   .. py:attribute:: dem_processing_method
      :value: None



   .. py:attribute:: remove_outliers
      :type:  bool


   .. py:attribute:: dem
      :type:  xarray.Dataset
      :value: None



   .. py:attribute:: classification_layers
      :type:  List[demcompare.classification_layer.ClassificationLayer]
      :value: []



   .. py:attribute:: classification_layers_names
      :type:  List[str]
      :value: []



   .. py:method:: fill_conf(cfg: demcompare.internal_typing.ConfigType = None)

      Init Stats options from configuration

      :param cfg: Input demcompare configuration
      :type cfg: ConfigType



   .. py:method:: _create_classif_layers()

      Create the classification layer objects



   .. py:method:: compute_stats(classification_layer: List[str] = None, metrics: List[Union[dict, str]] = None) -> demcompare.stats_dataset.StatsDataset

      Compute DEM stats

      If no classification layer is given, all classification
      layers are considered
      If no metrics are given, all metrics are considered

      :param classification_layer: names of the layers
      :type classification_layer: List[str]
      :param metrics: List of metrics to be computed
      :type metrics: List[Union[dict, str]]
      :return: stats dataset
      :rtype: StatsDataset



   .. py:method:: show_all_available_metrics() -> str
      :staticmethod:


      Return a string showing all available values
      :return: output_metrics
      :rtype: str



   .. py:method:: show_available_classification_layers() -> list