doc: add a warning about disparity range condition for interpolation …

…method
CNES · Mar 21, 2024 · 80de601 · 80de601
1 parent d571b12
commit 80de601
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/source/userguide/input.rst b/docs/source/userguide/input.rst
@@ -40,6 +40,10 @@ Input section is composed of the following keys:
       -
       - If the estimation step is not present
 
+.. warning::
+    If interpolation is used as refinement method, row_disparity and col_disparity ranges must have a size greater than or equal to 5. 
+
+
 Left and Right properties are composed of the following keys:
 
 .. list-table:: Left and Right properties

diff --git a/docs/source/userguide/step_by_step/refinement.rst b/docs/source/userguide/step_by_step/refinement.rst
@@ -13,6 +13,9 @@ It consists on 3 different steps:
     * The cost map of each pixel is interpolated using scipy to obtain a continuous function.
     * Then, the interpolated functions are minimized using scipy to obtain the refined disparities.
 
+.. warning::
+    When using the interpolation method, row and column disparity ranges must have a size greater than or equal to 5. 
+
 Optical_flow method
 -------------------
 .. warning::