minor: add warning about optical flow

CNES · Feb 16, 2024 · cac35bd · cac35bd
1 parent cb187bd
commit cac35bd
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 2 deletions.
diff --git a/docs/source/exploring_the_field/refining_disparity.rst b/docs/source/exploring_the_field/refining_disparity.rst
@@ -10,3 +10,6 @@ Two methods are available in pandora2d:
 
 - Interpolation
 - Optical flow.
+
+.. warning::
+    The optical flow method is still in an experimental phase.
diff --git a/docs/source/userguide/step_by_step/refinement.rst b/docs/source/userguide/step_by_step/refinement.rst
@@ -15,6 +15,8 @@ It consists on 3 different steps:
 
 Optical_flow method
 -------------------
+.. warning::
+    The optical flow method is still in an experimental phase.
 
 Inspired by [Lucas & Kanade]_.'s algorithm
 

diff --git a/pandora2d/common.py b/pandora2d/common.py
@@ -61,7 +61,7 @@ def dataset_disp_maps(delta_row: np.ndarray, delta_col: np.ndarray, attributes:
     :type delta_row: np.ndarray
     :param delta_col: disparity map for col
     :type delta_col: np.ndarray
-    :param attributes: disparity map for col
+    :param attributes: attributes containing invalid disparity values
     :type attributes: dict
     :return: dataset: Dataset with the disparity maps with the data variables :
 

diff --git a/pandora2d/refinement/dichotomy.py b/pandora2d/refinement/dichotomy.py
@@ -77,7 +77,7 @@ def refinement_method(
         :type cost_volumes: xarray.Dataset
         :param disp_map: pixel disparity maps
         :type disp_map: xarray.Dataset
-        param img_left: left image dataset
+        :param img_left: left image dataset
         :type img_left: xarray.Dataset
         :param img_right: right image dataset
         :type img_right: xarray.Dataset

diff --git a/pandora2d/state_machine.py b/pandora2d/state_machine.py
@@ -415,6 +415,10 @@ def refinement_run(self, cfg: Dict[str, dict], input_step: str) -> None:
         """
 
         logging.info("Refinement computation...")
+
+        if cfg["pipeline"][input_step]["refinement_method"] == "optical_flow":
+            logging.warning("The optical flow method is still in an experimental phase.")
+
         refinement_run = refinement.AbstractRefinement(
             cfg["pipeline"][input_step], self.step, self.window_size
         )  # type: ignore[abstract]