pandora2d.check_configuration

This module contains functions allowing to check the configuration given to Pandora pipeline.

Module Contents

Functions

check_datasets(→ None)

Check that left and right datasets are correct

check_input_section(→ Dict[str, dict])

Complete and check if the dictionary is correct

check_roi_section(→ Dict[str, dict])

Complete and check if the dictionary is correct

check_pipeline_section(→ Dict[str, dict])

Check if the pipeline is correct by

check_conf(→ dict)

Complete and check if the dictionary is correct

check_right_nodata_condition(→ None)

Check that only int is accepted for nodata of right image when matching_cost_method is sad or ssd.

check_roi_coherence(→ None)

Check that the first ROI coords are lower than the last.

get_roi_config(→ Dict[str, dict])

Get the ROI configuration

Attributes

input_configuration_schema

default_short_configuration_input

roi_configuration_schema

pandora2d.check_configuration.check_datasets(left: xarray.Dataset, right: xarray.Dataset) → None[source]

Check that left and right datasets are correct

Parameters:

  • left – dataset

  • right – dataset

pandora2d.check_configuration.check_input_section(user_cfg: Dict[str, dict]) → Dict[str, dict][source]

Complete and check if the dictionary is correct

Parameters:

user_cfg (dict) – user configuration

Returns:

cfg: global configuration

Return type:

cfg: dict

pandora2d.check_configuration.check_roi_section(user_cfg: Dict[str, dict]) → Dict[str, dict][source]

Complete and check if the dictionary is correct

Parameters:

user_cfg (dict) – user configuration

Returns:

cfg: global configuration

Return type:

cfg: dict

pandora2d.check_configuration.check_pipeline_section(user_cfg: Dict[str, dict], pandora2d_machine: pandora2d.state_machine.Pandora2DMachine) → Dict[str, dict][source]

Check if the pipeline is correct by - Checking the sequence of steps according to the machine transitions - Checking parameters, define in dictionary, of each Pandora step

Parameters:

  • user_cfg (dict) – pipeline user configuration

  • pandora2d_machine (PandoraMachine object) – instance of PandoraMachine

Returns:

cfg: pipeline configuration

Return type:

cfg: dict

pandora2d.check_configuration.check_conf(user_cfg: Dict, pandora2d_machine: pandora2d.state_machine.Pandora2DMachine) → dict[source]

Complete and check if the dictionary is correct

Parameters:

  • user_cfg (dict) – user configuration

  • pandora2d_machine (PandoraMachine) – instance of PandoraMachine

Returns:

cfg: global configuration

Return type:

cfg: dict

pandora2d.check_configuration.check_right_nodata_condition(cfg_input: Dict, cfg_pipeline: Dict) → None[source]

Check that only int is accepted for nodata of right image when matching_cost_method is sad or ssd. :param cfg_input: inputs section of configuration :type cfg_input: Dict :param cfg_pipeline: pipeline section of configuration :type cfg_pipeline: Dict

pandora2d.check_configuration.check_roi_coherence(roi_cfg: dict) → None[source]

Check that the first ROI coords are lower than the last.

Parameters:

  • roi_cfg (dict) – user configuration for ROI

  • dim (str) – dimension row or col

pandora2d.check_configuration.get_roi_config(user_cfg: Dict[str, dict]) → Dict[str, dict][source]

Get the ROI configuration

Parameters:

user_cfg (dict) – user configuration

Return cfg:

partial configuration

Rtype cfg:

dict

pandora2d.check_configuration.input_configuration_schema[source]
pandora2d.check_configuration.default_short_configuration_input[source]
pandora2d.check_configuration.roi_configuration_schema[source]