demcompare.metric.scalar_metrics
================================

.. py:module:: demcompare.metric.scalar_metrics

.. autoapi-nested-parse::

   Mainly contains different scalar metric classes



Classes
-------

.. autoapisummary::

   demcompare.metric.scalar_metrics.Mean
   demcompare.metric.scalar_metrics.Max
   demcompare.metric.scalar_metrics.Min
   demcompare.metric.scalar_metrics.Std
   demcompare.metric.scalar_metrics.Rmse
   demcompare.metric.scalar_metrics.Median
   demcompare.metric.scalar_metrics.Nmad
   demcompare.metric.scalar_metrics.Sum
   demcompare.metric.scalar_metrics.SumSquaredErr
   demcompare.metric.scalar_metrics.Percentil90


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

.. py:class:: Mean(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Mean metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed mean
      :rtype: float



.. py:class:: Max(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Max metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed max
      :rtype: float



.. py:class:: Min(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Min metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed min
      :rtype: float



.. py:class:: Std(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Standard deviation metric class



   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed std
      :rtype: float



.. py:class:: Rmse(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Root-mean-square-deviation metric class



   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed rmse
      :rtype: rmse



.. py:class:: Median(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Median metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed median
      :rtype: float



.. py:class:: Nmad(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Normalized-median-absolute-deviation metric class



   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed nmad
      :rtype: float



.. py:class:: Sum(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Summation metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed sum
      :rtype: float



.. py:class:: SumSquaredErr(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   Squared summation metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed squared_sum
      :rtype: float



.. py:class:: Percentil90(parameters: Dict = None)

   Bases: :py:obj:`demcompare.metric.metric_template.MetricTemplate`


   90 percentil metric class


   .. py:method:: compute_metric(data: numpy.ndarray) -> Union[Tuple[numpy.ndarray, numpy.ndarray], numpy.ndarray, float]

      Metric computation method

      :param data: input data to compute the metric
      :type data: np.array
      :return: the computed percentil_90
      :rtype: float