Skip to content
Snippets Groups Projects
Commit eb637bcc authored by Arnaud Jaen's avatar Arnaud Jaen
Browse files

DOC: Add parameter descriptions in Applications.

parent ec09180a
Branches
Tags
No related merge requests found
......@@ -58,10 +58,15 @@ private:
AddDocTag(Tags::Segmentation);
AddParameter(ParameterType_InputImage, "in", "Input Image");
SetParameterDescription( "in", "The input image." );
AddParameter(ParameterType_OutputImage, "fout", "Filtered output");
SetParameterDescription( "fout", "The filtered output image." );
AddParameter(ParameterType_OutputImage, "cout", "Clustered output");
SetParameterDescription( "cout", "The clustered output image." );
AddParameter(ParameterType_OutputImage, "lout", "Label output");
SetParameterDescription( "lout", "The label output image." );
AddParameter(ParameterType_OutputImage, "cbout", "Cluster Boundaries output");
SetParameterDescription( "cbout", "The cluster boundaries output image." );
MandatoryOff("fout");
MandatoryOff("cout");
MandatoryOff("lout");
......@@ -72,9 +77,13 @@ private:
// MandatoryOff("ram");
AddParameter(ParameterType_Int, "spatialr", "Spatial radius");
SetParameterDescription( "spatialr", "Spatial radius defining neighborhood." );
AddParameter(ParameterType_Float, "ranger", "Range radius");
SetParameterDescription( "ranger", "Range radius defining the interval in the color space." );
AddParameter(ParameterType_Int, "minsize", "Min region size");
SetParameterDescription( "minsize", "Minimun size of a region to be kept after clustering." );
AddParameter(ParameterType_Float, "scale", "Scale");
SetParameterDescription( "scale", "Scale to stretch the image before processing." );
SetDefaultParameterInt("spatialr", 5);
SetDefaultParameterFloat("ranger", 15.0);
SetDefaultParameterInt("minsize", 100);
......
......@@ -50,7 +50,7 @@ private:
SetDescription("Concatenate VectorDatas");
SetDocName("Concatenate");
SetDocLongDescription("This application concatenates a list of VectorData to produce a unique VectorData as output"
SetDocLongDescription("This application concatenates a list of VectorData to produce a unique VectorData as output."
"Note that the VectorDatas must be of the same type (Storing polygons only, lines only, or points only)");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
......@@ -62,6 +62,7 @@ private:
SetParameterDescription("vd", "VectorData files to be concatenated in an unique VectorData");
AddParameter(ParameterType_OutputVectorData, "out", "Concatenated VectorData");
SetParameterDescription("out", "Output conctenated VectorData");
// Doc example parameter settings
SetDocExampleParameterValue("vd", "ToulousePoints-examples.shp ToulouseRoad-examples.shp");
......
......@@ -87,6 +87,7 @@ private:
// Channelist Parameters
AddParameter(ParameterType_ListView, "cl", "Output Image channels");
SetParameterDescription("cl","Channels to write in the output image.");
// Doc example parameter settings
SetDocExampleParameterValue("in", "VegetationIndex.hd");
......
......@@ -64,7 +64,7 @@ private:
// Documentation
SetDocName("Multi Resolution Pyramid");
SetDocLongDescription("This application builds a multi-resolution pyramid of the input image. USer can specified the number of levels of the pyramid and the subsampling factor. To spped ip the process, you can use the fast scheme option");
SetDocLongDescription("This application builds a multi-resolution pyramid of the input image. User can specified the number of levels of the pyramid and the subsampling factor. To speed up the process, you can use the fast scheme option");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
......@@ -89,9 +89,11 @@ private:
AddParameter(ParameterType_Int, "sfactor", "Subsampling factor");
SetDefaultParameterInt("sfactor", 2);
SetParameterDescription( "sfactor", "Subsampling factor between each level of the pyramid (default is 2).");
AddParameter(ParameterType_Float, "vfactor", "Subsampling factor");
AddParameter(ParameterType_Float, "vfactor", "Variance factor");
SetDefaultParameterFloat("vfactor", 0.6);
SetParameterDescription( "vfactor", "Variance factor use in smoothing. It is multiplied by the subsampling factor of each level in the pyramid (default is 0.6).");
// Boolean Fast scheme
AddParameter(ParameterType_Empty, "fast", "Use Fast Scheme");
......
......@@ -72,7 +72,7 @@ private:
MandatoryOff("key");
AddParameter(ParameterType_String, "value", "OSM tag value");
SetParameterDescription("key", "OSM tag value to extract (motorway, footway...)");
SetParameterDescription("value", "OSM tag value to extract (motorway, footway...)");
MandatoryOff("value");
// Elevation
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment