pandora2d
=========

.. py:module:: pandora2d

.. autoapi-nested-parse::

   This module contains functions to run Pandora pipeline.



Submodules
----------

.. toctree::
   :maxdepth: 1

   /api_reference/pandora2d/Pandora2d/index
   /api_reference/pandora2d/check_configuration/index
   /api_reference/pandora2d/common/index
   /api_reference/pandora2d/common_cpp/index
   /api_reference/pandora2d/constants/index
   /api_reference/pandora2d/cost_volume_confidence/index
   /api_reference/pandora2d/criteria/index
   /api_reference/pandora2d/disparity/index
   /api_reference/pandora2d/estimation/index
   /api_reference/pandora2d/img_tools/index
   /api_reference/pandora2d/interpolation_filter/index
   /api_reference/pandora2d/interpolation_filter_cpp/index
   /api_reference/pandora2d/margins/index
   /api_reference/pandora2d/matching_cost/index
   /api_reference/pandora2d/matching_cost_cpp/index
   /api_reference/pandora2d/memory_estimation/index
   /api_reference/pandora2d/profiling/index
   /api_reference/pandora2d/refinement/index
   /api_reference/pandora2d/refinement_cpp/index
   /api_reference/pandora2d/reporting/index
   /api_reference/pandora2d/schema/index
   /api_reference/pandora2d/state_machine/index
   /api_reference/pandora2d/statistics/index
   /api_reference/pandora2d/types/index


Functions
---------

.. autoapisummary::

   pandora2d.log_list_elements
   pandora2d.setup_logging
   pandora2d.run
   pandora2d.run_pandora2d
   pandora2d.run_pandora2d_segment_mode
   pandora2d.main


Package Contents
----------------

.. py:function:: log_list_elements(list_to_log: list, log_level: int) -> None

   Display each element of a list line by line

   :param list_to_log: elements
   :param log_level: logging level define by user


.. py:function:: setup_logging(verbose: int) -> None

   Setup the logging configuration

   :param verbose: verbose mode
   :return: None


.. py:function:: run(pandora2d_machine: state_machine.Pandora2DMachine, img_left: xarray.Dataset, img_right: xarray.Dataset, cfg: dict[str, dict]) -> tuple[xarray.Dataset, dict]

   Run the Pandora 2D pipeline

   :param pandora2d_machine: instance of Pandora2DMachine
   :param img_left: left Dataset image containing :

           - im : 2D (row, col) xarray.DataArray
           - msk (optional): 2D (row, col) xarray.DataArray
   :param img_right: right Dataset image containing :

           - im : 2D (row, col) xarray.DataArray
           - msk (optional): 2D (row, col) xarray.DataArray
   :param cfg: configuration

   :return: None


.. py:function:: run_pandora2d(pandora2d_machine: state_machine.Pandora2DMachine, cfg: dict[str, dict]) -> tuple[xarray.Dataset, dict]

   Process ROI, create image datasets and run pandora2d pipeline

   :param pandora2d_machine: instance of Pandora2DMachine
   :param cfg: configuration


.. py:function:: run_pandora2d_segment_mode(pandora2d_machine: state_machine.Pandora2DMachine, cfg: dict[str, dict]) -> tuple[xarray.Dataset, dict]

   Run pandora2d pipeline with segment mode

   :param pandora2d_machine: instance of Pandora2DMachine
   :param cfg: configuration


.. py:function:: main(cfg_path: os.PathLike | str, verbose: bool) -> None

   Check config file and run pandora 2D framework accordingly

   :param cfg_path: path to the json configuration file
   :param verbose: verbose mode
   :return: None