shareloc.dtm_reader
===================

.. py:module:: shareloc.dtm_reader

.. autoapi-nested-parse::

   Image DTM Image to handle DTM image data.
   Inherits from Image Class with DTM particularities.



Classes
-------

.. autoapisummary::

   shareloc.dtm_reader.dtm_reader


Functions
---------

.. autoapisummary::

   shareloc.dtm_reader.interpolate_geoid_height


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

.. py:class:: dtm_reader(dtm_filename, geoid_filename=None, roi=None, roi_is_in_physical_space=False, fill_nodata='rio_fillnodata', fill_value=None)

   Bases: :py:obj:`shareloc.image.Image`


   class dtm_reader to handle DTM image data
   Inherits from Image Class with DTM particularities


   .. py:attribute:: dtm_filename


   .. py:attribute:: geoid_filename
      :value: None



   .. py:attribute:: stats


   .. py:attribute:: alt_data


   .. py:attribute:: trans_inv


   .. py:attribute:: transform


   .. py:method:: fill_nodata(strategy='rio_fillnodata', max_search_distance=100.0, smoothing_iterations=0, fill_value=0.0)

      fill nodata in DTM image, nan values in dtm are also filled

      :param strategy: fill strategy ('constant'/'min'/'median'/'max'/'mean'/'rio_fillnodata'/)
      :type strategy: str
      :param max_search_distance: fill max_search_distance
      :type max_search_distance: float
      :param smoothing_iterations: smoothing_iterations
      :type smoothing_iterations: int
      :param fill_value: fill value for constant strategy. fill value is used for 'roi_fillnodata' residuals nodata,
          if None 'min' is used
      :type fill_value: float



.. py:function:: interpolate_geoid_height(geoid_filename, positions, interpolation_method='linear')

   terrain to index conversion
   retrieve geoid height above ellispoid

   :param geoid_filename: geoid_filename
   :type geoid_filename: str
   :param positions: geodetic coordinates
   :type positions: 2D numpy array: (number of points, [long coord, lat coord])
   :param interpolation_method: default is 'linear' (interpn interpolation method)
   :type interpolation_method: str
   :return: geoid height
   :rtype: numpy array (number of points)