pandora.refinement.quadratic
============================

.. py:module:: pandora.refinement.quadratic

.. autoapi-nested-parse::

   This module contains functions associated to the quadratic method used in the refinement step.



Classes
-------

.. autoapisummary::

   pandora.refinement.quadratic.Quadratic


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

.. py:class:: Quadratic(**cfg: str)

   Bases: :py:obj:`pandora.refinement.refinement.AbstractRefinement`


   Quadratic class allows to perform the subpixel cost refinement step


   .. py:method:: refinement_method(cost: numpy.ndarray, disp: float, measure: str) -> Tuple[float, float, int]
      :staticmethod:


      Return the subpixel disparity and cost

      :param cost: cost of the values disp - 1, disp, disp + 1
      :type cost: 1D numpy array : [cost[disp -1], cost[disp], cost[disp + 1]]
      :param disp: the disparity
      :type disp: float
      :param measure: the type of measure used to create the cost volume
      :type measure: string = min | max
      :return: the refined disparity (disp + (sub_disp/subpix)), the refined cost and the state of the pixel
       ( Information: calculations stopped at the pixel step, sub-pixel interpolation did not succeed )
      :rtype: float, float, int



   .. py:attribute:: cfg


   .. py:attribute:: _refinement_method_name
      :value: ''



   .. py:method:: check_conf(**cfg: str) -> Dict[str, str]
      :staticmethod:


      Add default values to the dictionary if there are missing elements and check if the dictionary is correct

      :param cfg: refinement configuration
      :type cfg: dict
      :return cfg: refinement configuration updated
      :rtype: dict



   .. py:method:: desc() -> None

      Describes the subpixel refinement method
      :return: None