:py:mod:`cars.applications.dense_match_filling.plane`
=====================================================

.. py:module:: cars.applications.dense_match_filling.plane

.. autoapi-nested-parse::

   this module contains the fill_disp application class.



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

Classes
~~~~~~~

.. autoapisummary::

   cars.applications.dense_match_filling.plane.PlaneFill



Functions
~~~~~~~~~

.. autoapisummary::

   cars.applications.dense_match_filling.plane.fill_disparity_plane_wrapper
   cars.applications.dense_match_filling.plane.wrapper_copy_disparity



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


   Bases: :py:obj:`cars.applications.dense_match_filling.dense_match_filling.DenseMatchFilling`

   Fill invalid area in disparity map using plane method

   .. py:method:: check_conf(conf)

      Check configuration

      :param conf: configuration to check
      :type conf: dict
      :return: overloaded configuration
      :rtype: dict



   .. py:method:: get_poly_margin()

      Get the margin used for polygon

      :return: self.nb_pix
      :rtype: int


   .. py:method:: run(epipolar_disparity_map, holes_bbox_left=None, holes_bbox_right=None, disp_min=0, disp_max=0, orchestrator=None, pair_folder=None, pair_key='PAIR_0')

      Run Refill application using plane method.

      :param epipolar_disparity_map:  left to right disparity
      :type epipolar_disparity_map: CarsDataset
      :param holes_bbox_left:  left holes
      :type holes_bbox_left: CarsDataset
      :param holes_bbox_right:  right holes
      :type holes_bbox_right: CarsDataset
      :param disp_min: minimum disparity
      :type disp_min: int
      :param disp_max: maximum disparity
      :type disp_max: int
      :param orchestrator: orchestrator used
      :param pair_folder: folder used for current pair
      :type pair_folder: str
      :param pair_key: pair id
      :type pair_key: str

      :return: filled disparity map:             Each CarsDataset contains:

          - N x M Delayed tiles.              Each tile will be a future xarray Dataset containing:
              - data with keys : "disp", "disp_msk"
              - attrs with keys: profile, window, overlaps
          - attributes containing:
              "largest_epipolar_region","opt_epipolar_tile_size",
                  "epipolar_regions_grid"

      :rtype: CarsDataset




.. py:function:: fill_disparity_plane_wrapper(corresponding_tiles, corresponding_poly, window, overlap, classification, ignore_nodata_at_disp_mask_borders=True, ignore_zero_fill_disp_mask_values=True, ignore_extrema_disp_values=True, nb_pix=20, percent_to_erode=0.3, interp_options=None, saving_info=None)

   Wrapper to Fill disparity map holes

   :param corresponding_tiles: disparity map tiles
   :type corresponding_tiles: list(tuple(list, list, xr.Dataset))
   :param corresponding_poly: holes polygons
   :type corresponding_poly: list(Polygon)
   :param window: window of base tile [row min, row max, col min col max]
   :type window: list
   :param overlap: overlap [row min, row max, col min col max]
   :type overlap: list
   :param left_epi_image: left epipolar image
   :type left_epi_image:  xr.Dataset
   :param classification: list of tag to use
   :type classification: list(str)
   :param ignore_nodata_at_disp_mask_borders: ingore nodata
   :type ignore_nodata_at_disp_mask_borders: bool
   :param ignore_zero_fill_disp_mask_values: ingnore zero fill
   :type ignore_zero_fill_disp_mask_values: bool
   :param ignore_extrema_disp_values: ignore extrema
   :type ignore_extrema_disp_values: bool
   :param nb_pix: margin to use
   :type nb_pix: int
   :param percent_to_erode: percent to erode
   :type percent_to_erode: float
   :param interp_options: interp_options
   :type interp_options: dict
   :param saving_info: saving infos
   :type saving_info: dict


   :return: disp map
   :rtype: xr.Dataset


.. py:function:: wrapper_copy_disparity(disp, window, overlap, saving_info=None)

   Wrapper to copy previous disparity with additional filling band with zeros

   :param disp: disparity map
   :type disp: xr.Dataset
   :param window: window of base tile [row min, row max, col min col max]
   :type window: list
   :param overlap: overlap [row min, row max, col min col max]
   :type overlap: list
   :param saving_info: saving infos
   :type saving_info: dict

   :return: disp map
   :rtype: xr.Dataset