demcompare.transformation
=========================

.. py:module:: demcompare.transformation

.. autoapi-nested-parse::

   This module contains classes and functions associated to the dem transformation.



Classes
-------

.. autoapisummary::

   demcompare.transformation.Transformation


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

.. py:class:: Transformation(x_offset: float, y_offset: float, z_offset: float, estimated_initial_shift_x: float = 0.0, estimated_initial_shift_y: float = 0.0, adapting_factor: Tuple[float, float] = (1.0, 1.0), rotation: List[float] = None)

   Transformation class
   A transformation defines a way to transform
   the DEMs by offsets and/or rotations.
   For now, only x,y offset translation


   .. py:attribute:: adapting_factor
      :value: (1.0, 1.0)



   .. py:attribute:: x_offset


   .. py:attribute:: y_offset


   .. py:attribute:: z_offset


   .. py:attribute:: total_offset_x


   .. py:attribute:: total_offset_y


   .. py:attribute:: rotation
      :value: None



   .. py:method:: __repr__()

      Represent transformation offsets



   .. py:method:: apply_transform(dem: xarray.Dataset) -> xarray.Dataset

      Apply Transformation to input dem, currently only
      the offsets are considered

      :param dem: dem 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: xr.Dataset
      :return: transformed dem 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