pandora2d

This module contains functions to run Pandora pipeline.

Submodules

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

Functions

log_list_elements(→ None)	Display each element of a list line by line
setup_logging(→ None)	Setup the logging configuration
run(→ tuple[xarray.Dataset, dict])	Run the Pandora 2D pipeline
run_pandora2d(→ tuple[xarray.Dataset, dict])	Process ROI, create image datasets and run pandora2d pipeline
run_pandora2d_segment_mode(→ tuple[xarray.Dataset, dict])	Run pandora2d pipeline with segment mode
main(→ None)	Check config file and run pandora 2D framework accordingly

Package Contents

pandora2d.log_list_elements(list_to_log: list, log_level: int) → None

Display each element of a list line by line

Parameters:

• list_to_log – elements

• log_level – logging level define by user

pandora2d.setup_logging(verbose: int) → None

Setup the logging configuration

Parameters:

verbose – verbose mode

Returns:

None

pandora2d.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

Parameters:

• pandora2d_machine – instance of Pandora2DMachine

• img_left –

  left Dataset image containing :

  • im : 2D (row, col) xarray.DataArray

  • msk (optional): 2D (row, col) xarray.DataArray

• img_right –

  right Dataset image containing :

  • im : 2D (row, col) xarray.DataArray

  • msk (optional): 2D (row, col) xarray.DataArray

• cfg – configuration

Returns:

None

pandora2d.run_pandora2d(pandora2d_machine: state_machine.Pandora2DMachine, cfg: dict[str, dict]) → tuple[xarray.Dataset, dict]

Process ROI, create image datasets and run pandora2d pipeline

Parameters:

• pandora2d_machine – instance of Pandora2DMachine

• cfg – configuration

pandora2d.run_pandora2d_segment_mode(pandora2d_machine: state_machine.Pandora2DMachine, cfg: dict[str, dict]) → tuple[xarray.Dataset, dict]

Run pandora2d pipeline with segment mode

Parameters:

• pandora2d_machine – instance of Pandora2DMachine

• cfg – configuration

pandora2d.main(cfg_path: os.PathLike | str, verbose: bool) → None

Check config file and run pandora 2D framework accordingly

Parameters:

• cfg_path – path to the json configuration file

• verbose – verbose mode

Returns:

None