Merge branch '112-fix-revoir-la-documentation-de-la-faq' into 'release'

Resolve "Fix: revoir la documentation de la FAQ" See merge request 3d/PandoraBox/pandora2d!90
CNES · Apr 3, 2024 · 82a7728 · 82a7728
2 parents 71d35d2 + 251c36e
commit 82a7728
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 34 deletions.
diff --git a/docs/source/developer_guide/before_coding.rst b/docs/source/developer_guide/before_coding.rst
@@ -39,19 +39,16 @@ Pandora2D Classical workflow is :
 
 .. _contribution_license_agreement:
 
-Contribution license agreement
+Contribution License Agreement
 ------------------------------
 
-Contribution license agreement
-------------------------------
-
-PANDORA2D requires that contributors sign out a `Contributor LicenseAgreement <https://en.wikipedia.org/wiki/Contributor_License_Agreement>`_.
+PANDORA2D requires that contributors sign out a `Contributor License Agreement <https://en.wikipedia.org/wiki/Contributor_License_Agreement>`_.
 The purpose of this CLA is to ensure that the project has the necessary ownership or
 grants of rights over all contributions to allow them to distribute under the
-chosen license (Apache License Version 2.0)
+chosen license (Apache License Version 2.0).
 
 To accept your contribution, we need you to complete, sign and email to *[email protected]* an
-`Individual Contributor LicensingAgreement <https://github.com/CNES/Pandora/blob/master/doc/sources/CLA/ICLA_PANDORA.doc>`_ (ICLA) form and a
+`Individual Contributor Licensing Agreement <https://github.com/CNES/Pandora/blob/master/doc/sources/CLA/ICLA_PANDORA.doc>`_ (ICLA) form and a
 `Corporate Contributor Licensing Agreement <https://github.com/CNES/Pandora/blob/master/doc/sources/CLA/CCLA_PANDORA.doc>`_ (CCLA) form if you are
 contributing on behalf of your company or another entity which retains copyright
 for your contribution.

diff --git a/docs/source/userguide/faq.rst b/docs/source/userguide/faq.rst
@@ -14,29 +14,33 @@ It is possible to add a step parameter in the configuration file. This parameter
 
     user_cfg = {
         "input": {
-            "img_left": img_left_path,
-            "img_right": img_right_path,
-            "nodata_left": "NaN",
-            "nodata_right": "NaN",
+            "left": {
+                "img": img_left_path,
+                "nodata": "NaN",
+            },
+            "right": {
+                "img": img_right_path,
+                "nodata": "NaN",
+            },
             "col_disparity": [-3, 3],
             "row_disparity": [-3, 3],
         },
-        "pipeline":{
-            "matching_cost" : {
+        "pipeline": {
+            "matching_cost": {
                 "matching_cost_method": "zncc",
                 "window_size": 7,
-                "step" : [5,5]
+                "step": [5, 5],
             },
             "disparity": {
                 "disparity_method": "wta",
-                "invalid_disparity": -9999
+                "invalid_disparity": -9999,
+            },
+            "refinement": {
+                "refinement_method": "interpolation",
             },
-            "refinement" : {
-                "refinement_method" : "interpolation"
-            }
-        }
+        },
     }
-    
+
 How do I choose to process only a certain part of the image? 
 ****************************************************************
 
@@ -48,31 +52,35 @@ It is possible to work on only one section of the image with an ROI. For this, t
 
     user_cfg = {
         "input": {
-            "img_left": img_left_path,
-            "img_right": img_right_path,
-            "nodata_left": "NaN",
-            "nodata_right": "NaN",
+            "left": {
+                "img": img_left_path,
+                "nodata": "NaN",
+            },
+            "right": {
+                "img": img_right_path,
+                "nodata": "NaN",
+            },
             "col_disparity": [-3, 3],
             "row_disparity": [-3, 3],
         },
-        "ROI":
-        {
+        "ROI": {
             "col": {"first": 10, "last": 100},
-            "row": {"first": 10, "last": 100}
+            "row": {"first": 10, "last": 100},
         },
-        "pipeline":{
-            "matching_cost" : {
+        "pipeline": {
+            "matching_cost": {
                 "matching_cost_method": "zncc",
                 "window_size": 7,
+                "step": [5, 5],
             },
             "disparity": {
                 "disparity_method": "wta",
-                "invalid_disparity": -9999
+                "invalid_disparity": -9999,
             },
-            "refinement" : {
-                "refinement_method" : "interpolation"
-            }
-        }
+            "refinement": {
+                "refinement_method": "interpolation",
+            },
+        },
     }
 
 .. code:: ipython3