From a3ab4813c19b74ba7495d4264e7c5a928f3f6640 Mon Sep 17 00:00:00 2001 From: Guillaume Pasero <guillaume.pasero@c-s.fr> Date: Wed, 7 Mar 2018 16:41:28 +0100 Subject: [PATCH] DOC: clarification about EmptyParameter/BoolParameter --- Documentation/Cookbook/rst/recipes/python.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/Documentation/Cookbook/rst/recipes/python.rst b/Documentation/Cookbook/rst/recipes/python.rst index cbb119372d..92c6b2dabd 100644 --- a/Documentation/Cookbook/rst/recipes/python.rst +++ b/Documentation/Cookbook/rst/recipes/python.rst @@ -229,12 +229,16 @@ doing geometry, projections, and also calibration. Future developments will probably offer a more adapted structure to import and export images between OTB and Python world. -Setting of boolean parameters -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Setting of EmptyParameter +^^^^^^^^^^^^^^^^^^^^^^^^^ -Most of the parameters are set using functions ``SetParameterXXX()``. The boolean -parameters are handled differently (also called Empty parameter). Let's take an example with the application -``ReadImageInfo``: +Most of the parameters are set using functions ``SetParameterXXX()``, except for +one type of parameter: the ``EmptyParameter``. This class was the first +implementation of a boolean. It is now **deprecated**, you should use ``BoolParameter`` +instead. + +Let's take an example with the application ``ReadImageInfo`` when it was still +using an ``EmptyParameter`` for parameter ``keywordlist``: .. code-block:: python -- GitLab