From 80de60191c58b152518c604570ff1e82f4c29110 Mon Sep 17 00:00:00 2001 From: duzelis Date: Wed, 6 Mar 2024 14:37:06 +0100 Subject: [PATCH] doc: add a warning about disparity range condition for interpolation method --- docs/source/userguide/input.rst | 4 ++++ docs/source/userguide/step_by_step/refinement.rst | 3 +++ 2 files changed, 7 insertions(+) diff --git a/docs/source/userguide/input.rst b/docs/source/userguide/input.rst index 96d1502..cfe6594 100644 --- 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 index 6f321e6..53467d1 100644 --- 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::