Merge branch '332-check_dataset-renommer-check_json-py' into 'master'

refact: rename check_json to check_configuration Closes #332 See merge request 3d/PandoraBox/pandora!280
CNES · Sep 1, 2023 · 6556987 · 6556987
2 parents 51f8344 + 570f192
commit 6556987
Show file tree

Hide file tree

Showing 15 changed files with 98 additions and 94 deletions.
diff --git a/docs/source/userguide/as_an_api.rst b/docs/source/userguide/as_an_api.rst
@@ -13,7 +13,7 @@ Pandora provides a full python API which can be used to compute disparity maps a
     import pandora
     from pandora import common
     from pandora.img_tools import read_img, read_disp
-    from pandora.check_json import check_conf, read_config_file
+    from pandora.check_configuration import check_conf, read_config_file
     from pandora.state_machine import PandoraMachine
 
     def pandora_stereo(cfg_path: str, output: str, verbose: bool) -> None:

diff --git a/notebooks/advanced_examples/api_check_conf.ipynb b/notebooks/advanced_examples/api_check_conf.ipynb
@@ -40,7 +40,7 @@
    "outputs": [],
    "source": [
     "from pandora import import_plugin\n",
-    "from pandora.check_json import (\n",
+    "from pandora.check_configuration import (\n",
     "    check_conf,\n",
     "    get_config_input,\n",
     "    check_input_section,\n",

diff --git a/notebooks/advanced_examples/cost_profile_analysis.ipynb b/notebooks/advanced_examples/cost_profile_analysis.ipynb
@@ -28,7 +28,7 @@
    "source": [
     "import pandora\n",
     "from pandora.img_tools import read_img\n",
-    "from pandora.check_json import check_pipeline_section, concat_conf\n",
+    "from pandora.check_configuration import check_pipeline_section, concat_conf\n",
     "from pandora.state_machine import PandoraMachine\n",
     "from pandora import import_plugin, check_conf"
    ]

diff --git a/notebooks/introduction_and_basic_usage.ipynb b/notebooks/introduction_and_basic_usage.ipynb
@@ -182,7 +182,7 @@
     "# Load pandora imports\n",
     "import pandora\n",
     "from pandora.img_tools import read_img\n",
-    "from pandora.check_json import check_pipeline_section, concat_conf, memory_consumption_estimation, get_metadata, get_config_pipeline\n",
+    "from pandora.check_configuration import check_pipeline_section, concat_conf, memory_consumption_estimation, get_metadata, get_config_pipeline\n",
     "from pandora.state_machine import PandoraMachine\n",
     "from pandora import import_plugin, check_conf"
    ]

diff --git a/notebooks/statistical_and_visual_analysis.ipynb b/notebooks/statistical_and_visual_analysis.ipynb
@@ -87,7 +87,7 @@
     "# Load pandora imports\n",
     "import pandora\n",
     "from pandora.img_tools import read_img\n",
-    "from pandora.check_json import check_pipeline_section, concat_conf, get_metadata, get_config_pipeline\n",
+    "from pandora.check_configuration import check_pipeline_section, concat_conf, get_metadata, get_config_pipeline\n",
     "from pandora.state_machine import PandoraMachine\n",
     "from pandora import import_plugin, check_conf"
    ]

diff --git a/notebooks/usage_with_multiscale.ipynb b/notebooks/usage_with_multiscale.ipynb
@@ -207,7 +207,7 @@
     "# Load pandora imports\n",
     "import pandora\n",
     "from pandora.img_tools import read_img\n",
-    "from pandora.check_json import check_pipeline_section, concat_conf, get_metadata, get_config_pipeline\n",
+    "from pandora.check_configuration import check_pipeline_section, concat_conf, get_metadata, get_config_pipeline\n",
     "from pandora.state_machine import PandoraMachine\n",
     "from pandora import import_plugin, check_conf"
    ]

diff --git a/pandora/__init__.py b/pandora/__init__.py
@@ -33,7 +33,7 @@
 
 from . import common
 from .img_tools import read_img, read_disp
-from .check_json import check_conf, read_config_file, read_multiscale_params
+from .check_configuration import check_conf, read_config_file, read_multiscale_params
 from .state_machine import PandoraMachine
 
 

diff --git a/pandora/check_json.py → pandora/check_configuration.py b/pandora/check_json.py → pandora/check_configuration.py
diff --git a/tests/test_confidence.py b/tests/test_confidence.py
@@ -164,7 +164,7 @@ def test_ambiguity_std_full_pipeline():
         pandora_machine = PandoraMachine()
 
         # Update the user configuration with default values
-        cfg = pandora.check_json.update_conf(pandora.check_json.default_short_configuration, user_cfg)
+        cfg = pandora.check_configuration.update_conf(pandora.check_configuration.default_short_configuration, user_cfg)
 
         # Run the pandora pipeline
         left, _ = pandora.run(pandora_machine, left_im, right_im, -1, 1, cfg)
@@ -278,7 +278,7 @@ def test_non_normalized_ambiguity_std_full_pipeline():
         pandora_machine = PandoraMachine()
 
         # Update the user configuration with default values
-        cfg = pandora.check_json.update_conf(pandora.check_json.default_short_configuration, user_cfg)
+        cfg = pandora.check_configuration.update_conf(pandora.check_configuration.default_short_configuration, user_cfg)
 
         # Run the pandora pipeline
         left, _ = pandora.run(pandora_machine, left_im, right_im, -1, 1, cfg)