demcompare.metric.metric_template
=================================

.. py:module:: demcompare.metric.metric_template

.. autoapi-nested-parse::

   Mainly contains the MetricTemplate class.



Classes
-------

.. autoapisummary::

   demcompare.metric.metric_template.MetricTemplate


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

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

   Metric class


   .. py:attribute:: DEFAULT_TYPE
      :value: 'scalar'



   .. py:attribute:: type
      :value: 'scalar'



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


      Metric computation method