demcompare.dem_processing.dem_processing_template
=================================================

.. py:module:: demcompare.dem_processing.dem_processing_template

.. autoapi-nested-parse::

   Mainly contains the DemProcessingTemplate class.



Classes
-------

.. autoapisummary::

   demcompare.dem_processing.dem_processing_template.DemProcessingTemplate


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

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

   DEM processing class


   .. py:attribute:: type
      :type:  str
      :value: None



   .. py:attribute:: fig_title
      :type:  str
      :value: None



   .. py:attribute:: colorbar_title
      :type:  str
      :value: None



   .. py:attribute:: cmap
      :type:  str
      :value: None



   .. py:method:: process_dem(dem_1: xarray.Dataset, dem_2: xarray.Dataset) -> xarray.Dataset
      :abstractmethod:


      DEM processing method

      :param dem_1: dem_1 xr.DataSet containing :

              - image : 2D (row, col) xr.DataArray float32
              - georef_transform: 1D (trans_len) xr.DataArray
              - classification_layer_masks : 3D (row, col, indicator)
                xr.DataArray
      :type dem_1: xr.Dataset
      :param dem_2: optional argument.
                    should not be given as input,
                    when the DEM processing method takes only 1 DEM as input.
                    xr.DataSet containing:

              - image : 2D (row, col) xr.DataArray float32
              - georef_transform: 1D (trans_len) xr.DataArray
              - classification_layer_masks : 3D (row, col, indicator)
                xr.DataArray
      :type dem_2: xr.Dataset
      :return: xr.DataSet containing :

              - image : 2D (row, col) xr.DataArray float32
              - georef_transform: 1D (trans_len) xr.DataArray
              - classification_layer_masks : 3D (row, col, indicator)
                xr.DataArray
      :rtype: xr.Dataset