:py:mod:`cars.applications.dem_generation.rasterization`
========================================================

.. py:module:: cars.applications.dem_generation.rasterization

.. autoapi-nested-parse::

   this module contains the dichotomic dem generation application class.



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

Classes
~~~~~~~

.. autoapisummary::

   cars.applications.dem_generation.rasterization.Rasterization



Functions
~~~~~~~~~

.. autoapisummary::

   cars.applications.dem_generation.rasterization.edit_transform
   cars.applications.dem_generation.rasterization.reverse_dem
   cars.applications.dem_generation.rasterization.downsample_dem
   cars.applications.dem_generation.rasterization.launch_bulldozer
   cars.applications.dem_generation.rasterization.compute_stats



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


   Bases: :py:obj:`cars.applications.dem_generation.dem_generation.DemGeneration`

   Rasterization

   .. py:method:: check_conf(conf)

      Check configuration

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

      :return: overloaded configuration
      :rtype: dict



   .. py:method:: run(triangulated_matches_list, output_dir, geoid_path, dem_roi_to_use=None, initial_elevation=None, cars_orchestrator=None)

      Run dichotomic dem generation using matches

      :param triangulated_matches_list: list of triangulated matches
          positions must be in a metric system
      :type triangulated_matches_list: list(pandas.Dataframe)
      :param output_dir: directory to save dem
      :type output_dir: str
      :param geoid_path: geoid path
      :param dem_roi_to_use: dem roi polygon to use as roi

      :return: dem data computed with mean, min and max.
          dem is also saved in disk, and paths are available in attributes.
          (DEM_MEDIAN_PATH, DEM_MIN_PATH, DEM_MAX_PATH)
      :rtype: CarsDataset



.. py:function:: edit_transform(input_dem, resolution=None, transform=None)

   Change transform of an image
   :param input_res: path of image
   :type input_dem: str
   :param resolution: image resolution for new transform to apply
   :type resolution: float
   :param transform: new transform to apply if resolution is not given
   :type transform: affine.Affine


.. py:function:: reverse_dem(input_dem)

   Compute the opposite of a DEM :
   Altitudes sign is changed

   :param input_dem: path of DEM to reverse
   :type input_dem: str


.. py:function:: downsample_dem(input_dem, scale)

   Downsample median DEM with median resampling

   :param input_dem: path of DEM to downsample (only one band)
   :type input_dem: str


.. py:function:: launch_bulldozer(input_dem, output_dir, cars_orchestrator, max_object_size)

   Launch bulldozer on a DEM to smooth it

   :param input_dem: path of DEM to reverse
   :type input_dem: str
   :param output_dir: directory where bulldozer output is dumped
   :type output_dir: str
   :param cars_orchestrator: orchestrator of the whole pipeline
                             (used to get number of workers)
   :type cars_orchestrator: Orchestrator
   :param max_object_size: bulldozer parameter "max_object_size"
   :type max_object_size: int


.. py:function:: compute_stats(diff)

   Compute and display statistics of difference between two DEM :
   Minimum, median, percentiles and maximum

   :param diff: altimetric difference between two DEM
   :type diff: numpy.array