From f92185d442e794ba3367c877b2f7833541565702 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Traizet?= <cedric.traizet@c-s.fr>
Date: Fri, 20 Mar 2020 14:22:45 +0100
Subject: [PATCH] DOC: update parameter documentation in
PantexTextureExtraction
---
.../app/otbPantexTextureExtraction.cxx | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/Modules/Applications/AppTextures/app/otbPantexTextureExtraction.cxx b/Modules/Applications/AppTextures/app/otbPantexTextureExtraction.cxx
index 8b5363e978..98bdd7926c 100644
--- a/Modules/Applications/AppTextures/app/otbPantexTextureExtraction.cxx
+++ b/Modules/Applications/AppTextures/app/otbPantexTextureExtraction.cxx
@@ -57,7 +57,7 @@ private:
SetDocLongDescription(
"This application computes a texture-derived built-up presence index (PanTex) from textural"
- "characteristics of scalar images. This index is the min value of the contrast in 8 directions."
+ "characteristics of scalar images. This is a contrast textural measure based on co-occurance."
);
SetDocLimitations("None");
@@ -81,12 +81,14 @@ private:
AddParameter(ParameterType_OutputImage, "out", "Output Image");
SetParameterDescription("out", "Output image containing the selected texture features.");
- AddParameter(ParameterType_Float, "min", "Image Minimum");
- SetParameterDescription("min", "Image Minimum");
+ AddParameter(ParameterType_Float, "min", "Image minimum");
+ SetParameterDescription("min", "Input image minimum. If this parameter is not set, the application will compute "
+ "the minumum of the image.");
MandatoryOff("min");
- AddParameter(ParameterType_Float, "max", "Image Maximum");
- SetParameterDescription("max", "Image Maximum");
+ AddParameter(ParameterType_Float, "max", "Image maximum");
+ SetParameterDescription("max", "Input image maximum. If this parameter is not set, the application will compute "
+ "the maximum of the image.");
MandatoryOff("max");
AddParameter(ParameterType_Int, "sradx", "Window radius (x direction)");
@@ -100,7 +102,8 @@ private:
SetDefaultParameterInt("srady", 4);
AddParameter(ParameterType_Int, "nbin", "Number of bins per axis for histogram generation");
- SetParameterDescription("nbin", "Number of bins per axis for histogram generation");
+ SetParameterDescription("nbin", "Number of bins per axis for histogram generation "
+ "(number of gray levels considered in the computation of co-occurance).");
SetDefaultParameterInt("nbin", 8);
AddRAMParameter();
--
GitLab