From 10dc64898251a696802d9ad2ff0e023e69eee8e7 Mon Sep 17 00:00:00 2001
From: Guillaume Pasero <guillaume.pasero@c-s.fr>
Date: Thu, 14 Dec 2017 10:24:45 +0100
Subject: [PATCH] DOC: fix applications doc
---
.../app/otbTrainDimensionalityReduction.cxx | 22 +++++++++++++++++--
.../app/otbVectorDimensionalityReduction.cxx | 1 +
2 files changed, 21 insertions(+), 2 deletions(-)
diff --git a/Modules/Applications/AppDimensionalityReduction/app/otbTrainDimensionalityReduction.cxx b/Modules/Applications/AppDimensionalityReduction/app/otbTrainDimensionalityReduction.cxx
index df735345a1..1cbc567c56 100644
--- a/Modules/Applications/AppDimensionalityReduction/app/otbTrainDimensionalityReduction.cxx
+++ b/Modules/Applications/AppDimensionalityReduction/app/otbTrainDimensionalityReduction.cxx
@@ -71,8 +71,18 @@ private:
void DoInit()
{
SetName("TrainDimensionalityReduction");
- SetDescription("Trainer for the dimensionality reduction algorithms used in"
- " the ImageDimensionalityReduction and VectorDimensionalityReduction applications.");
+ SetDescription("Train a dimensionality reduction model");
+
+ SetDocName("Train Dimensionality Reduction");
+ SetDocLongDescription("Trainer for dimensionality reduction algorithms "
+ "(autoencoders, PCA, SOM). All input samples are used to compute the "
+ "model, like other machine learning models.\n"
+ "The model can be used in the ImageDimensionalityReduction and "
+ "VectorDimensionalityReduction applications.");
+
+ SetDocLimitations("None");
+ SetDocAuthors("OTB-Team");
+ SetDocSeeAlso("ImageDimensionalityReduction, VectorDimensionalityReduction");
AddParameter(ParameterType_Group, "io", "Input and output data");
SetParameterDescription("io", "This group of parameters allows setting input and output data.");
@@ -95,6 +105,14 @@ private:
Superclass::DoInit();
AddRAMParameter();
+
+ // Doc example parameter settings
+ SetDocExampleParameterValue("io.vd", "cuprite_samples.sqlite");
+ SetDocExampleParameterValue("io.out", "mode.ae");
+ SetDocExampleParameterValue("algorithm", "pca");
+ SetDocExampleParameterValue("algorithm.pca.dim", "8");
+ SetDocExampleParameterValue("feat","value_0 value_1 value_2 value_3 value_4"
+ " value_5 value_6 value_7 value_8 value_9");
}
void DoUpdateParameters()
diff --git a/Modules/Applications/AppDimensionalityReduction/app/otbVectorDimensionalityReduction.cxx b/Modules/Applications/AppDimensionalityReduction/app/otbVectorDimensionalityReduction.cxx
index dd4e89097b..c34039180f 100644
--- a/Modules/Applications/AppDimensionalityReduction/app/otbVectorDimensionalityReduction.cxx
+++ b/Modules/Applications/AppDimensionalityReduction/app/otbVectorDimensionalityReduction.cxx
@@ -92,6 +92,7 @@ private:
"dimensionality reduction based on a model file produced by the "
"TrainDimensionalityReduction application.");
SetDocSeeAlso("TrainDimensionalityReduction");
+ SetDocLimitations("None");
AddDocTag(Tags::Learning);
AddParameter(ParameterType_InputVectorData, "in", "Name of the input vector data");
--
GitLab