:py:mod:`cars.applications.grid_generation.epipolar_grid_generation`
====================================================================

.. py:module:: cars.applications.grid_generation.epipolar_grid_generation

.. autoapi-nested-parse::

   this module contains the epipolar grid generation application class.



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

Classes
~~~~~~~

.. autoapisummary::

   cars.applications.grid_generation.epipolar_grid_generation.EpipolarGridGeneration




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


   Bases: :py:obj:`cars.applications.grid_generation.grid_generation.GridGeneration`

   EpipolarGridGeneration

   .. py:method:: check_conf(conf)

      Check configuration

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

      :return: overloaded configuration
      :rtype: dict



   .. py:method:: get_save_grids()

      Get whether the grid will be saved

      :return: true is grid saving is activated
      :rtype: bool


   .. py:method:: run(image_left, image_right, geometry_plugin, orchestrator=None, pair_folder=None, pair_key='PAIR_0')

      Run EpipolarGridGeneration application

      Create left and right grid CarsDataset filled with xarray.Dataset ,
      corresponding to left and right epipolar grids.

      :param image_left: left image. Dict Must contain keys :          "image", "color", "geomodel","no_data", "mask". Paths must be absolutes
      :type image_left: dict
      :param image_right: right image. Dict Must contain keys :         "image", "color", "geomodel","no_data", "mask". Paths must be absolutes
      :type image_right: dict
      :param geometry_plugin: geometry plugin to use
      :type geometry_plugin: AbstractGeometry
      :param pair_folder: folder used for current pair
      :type pair_folder: str
      :param orchestrator: orchestrator used
      :param pair_key: pair configuration id
      :type pair_key: str

      :return: left grid, right grid. Each grid CarsDataset contains :

          - A single tile stored in [0,0], containing a (N, M, 2) shape                array in xarray Dataset
          - Attributes containing: "grid_spacing", "grid_origin",                 "epipolar_size_x", epipolar_size_y", "epipolar_origin_x",                 "epipolar_origin_y","epipolar_spacing_x",                 "epipolar_spacing", "disp_to_alt_ratio",

      :rtype: Tuple(CarsDataset, CarsDataset)