cars.applications.dsm_filling.exogenous_filling_app
===================================================

.. py:module:: cars.applications.dsm_filling.exogenous_filling_app

.. autoapi-nested-parse::

   This module contains the exogenous dsm filling application class.



Classes
-------

.. autoapisummary::

   cars.applications.dsm_filling.exogenous_filling_app.ExogenousFilling


Functions
---------

.. autoapisummary::

   cars.applications.dsm_filling.exogenous_filling_app.exogenous_filling_wrapper


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

.. py:class:: ExogenousFilling(conf=None)

   Bases: :py:obj:`cars.applications.dsm_filling.abstract_dsm_filling_app.DsmFilling`


   Exogenous filling


   .. py:attribute:: used_method


   .. py:attribute:: classification


   .. py:attribute:: fill_with_geoid


   .. py:attribute:: interpolation_method


   .. py:attribute:: save_intermediate_data


   .. py:method:: check_conf(conf)

      Check configuration

      :param conf: configuration to check
      :type conf: dict

      :return: overloaded configuration
      :rtype: dict




   .. py:method:: run(dsm_file, classif_file, filling_file, dump_dir, roi_polys, roi_epsg, output_geoid, geom_plugin, dsm_dir=None, tile_size=10000, orchestrator=None)

      Run dsm filling using initial elevation and the current dsm
      Replaces dsm.tif by the filled dsm. Adds a new band
      to filling.tif if it exists.
      The old dsm is saved in dump_dir.

      roi_poly can any of these objects :
          - a list of Shapely Polygons
          - a Shapely Polygon



.. py:function:: exogenous_filling_wrapper(dsm_file, filling_file, classif_file, geo_plugin_dem, geo_plugin_geoid, output_geoid, roi_polys, roi_epsg, fill_with_geoid, interpolation_method, classification, window=None, saving_info=None, profile=None)

   Wrapper for exogenous filling, to be applied on each tile of the DSM.

   :param dsm_file:  dsm file to fill
   :param filling_file: filling file
   :param classif_file:  classification file
   :param geo_plugin_dem: initial elevation dem
   :param geo_plugin_geoid: initial elevation geoid
   :param output_geoid:  output geoid
   :return:  filled dsm xarray dataset