pandora2d.matching_cost.pandora
===============================

.. py:module:: pandora2d.matching_cost.pandora

.. autoapi-nested-parse::

   This module contains functions associated to the matching cost computation step.



Classes
-------

.. autoapisummary::

   pandora2d.matching_cost.pandora.PandoraMatchingCostMethods


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

.. py:class:: PandoraMatchingCostMethods(cfg: dict)

   Bases: :py:obj:`pandora2d.matching_cost.base.BaseMatchingCost`


   Matching Cost class


   .. py:attribute:: pandora_matching_cost_


   .. py:attribute:: grid
      :type:  xarray.Dataset | None
      :value: None



   .. py:property:: cfg
      :type: dict[str, str | int | list[int]]


      Get used configuration

      :return: cfg: dictionary with all parameters



   .. py:property:: schema


   .. py:method:: check_conf(cfg: dict) -> dict[str, str]

      Check the matching cost configuration
      and raise error if float precision is float64



   .. py:property:: window_size
      :type: int


      Get window_size, parameter specific to pandora

      :return: window_size: window used to compute correlation



   .. py:property:: _subpix
      :type: int


      Get subpix, parameter specific to pandora

      :return: subpix: subpix used



   .. py:property:: _spline_order
      :type: int


      Get spline_order, parameter specific to pandora

      :return: spline_order: spline_order used



   .. py:property:: margins
      :type: pandora.margins.Margins


      Get margins from pandora correlation measurement




   .. py:method:: get_config_for_pandora(cfg: dict) -> dict[str, str]

      Get configuration for matching_cost in pandora

      :param cfg: user_config for matching cost pandora2d
      :return: cfg: matching cost pandora configuration



   .. py:method:: allocate(img_left: xarray.Dataset, img_right: xarray.Dataset, cfg: dict, margins: pandora2d.margins.Margins = None) -> None

      Allocate the cost volume for pandora

      :param img_left: xarray.Dataset containing :
              - im : 2D (row, col) xarray.DataArray
              - msk : 2D (row, col) xarray.DataArray
      :param img_right: xarray.Dataset containing :
              - im : 2D (row, col) xarray.DataArray
              - msk : 2D (row, col) xarray.DataArray
      :param cfg: matching_cost computation configuration
      :param margins: refinement margins
      :return: None



   .. py:method:: set_shifted_right_images(img_right: xarray.Dataset) -> None

      Compute shifted by subpix right image and assign `shifted_right_images` attribute.

      :param img_right: xarray.Dataset containing :
              - im : 2D (row, col) xarray.DataArray
              - msk : 2D (row, col) xarray.DataArray
      :return: None



   .. py:method:: compute_cost_volumes(img_left: xarray.Dataset, img_right: xarray.Dataset, margins: pandora2d.margins.Margins = None) -> xarray.Dataset

      Computes the cost volumes

      :param img_left: xarray.Dataset containing :
              - im : 2D (row, col) xarray.DataArray
              - msk : 2D (row, col) xarray.DataArray
      :param img_right: xarray.Dataset containing :
              - im : 2D (row, col) xarray.DataArray
              - msk : 2D (row, col) xarray.DataArray
      :param margins: refinement margins
      :return: cost_volumes: 4D Dataset containing the cost_volumes