Skip to content
Snippets Groups Projects
Commit 7d8da651 authored by Manuel Grizonnet's avatar Manuel Grizonnet
Browse files

Merge branch 'app_docsprint' of https://git.orfeo-toolbox.org/git/otb into app_docsprint

parents c495cb82 81eb1659
No related branches found
No related tags found
No related merge requests found
......@@ -64,11 +64,16 @@ private:
void DoInit() ITK_OVERRIDE
{
SetName("EdgeExtraction");
SetDescription("Computes edge features on every pixel of the input image selected channel");
SetDescription(
"This application computes edge features on every pixel of the input image "
"selected channel");
// Documentation
SetDocName("Edge Feature Extraction");
SetDocLongDescription("This application computes edge features on a mono band image");
SetDocLongDescription(
"This application computes edge features on a selected channel of the input."
"It uses different filter such as gradient, Sobel and Touzi");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("otb class");
......@@ -77,7 +82,7 @@ AddDocTag(Tags::FeatureExtraction);
AddDocTag("Edge");
AddParameter(ParameterType_InputImage, "in", "Input Image");
SetParameterDescription("in", "The input image to compute the features on.");
SetParameterDescription("in", "The input image on which the features are computed.");
AddParameter(ParameterType_Int, "channel", "Selected Channel");
SetParameterDescription("channel", "The selected channel index");
......@@ -91,15 +96,26 @@ SetParameterDescription("filter", "Choice of edge feature");
//Gradient Section
AddChoice("filter.gradient", "Gradient");
SetParameterDescription("Gradient",
"This filter computes the gradient magnitude of the image at each pixel.");
//Sobel Section
AddChoice("filter.sobel", "Sobel");
SetParameterDescription("Sobel",
"This filter uses the Sobel operator to calculate the image gradient and "
"then finds the magnitude of this gradient vector.");
//Touzi Section
AddChoice("filter.touzi", "Touzi");
AddParameter(ParameterType_Int, "filter.touzi.xradius", "The X Radius");
SetParameterDescription("Touzi",
"This filter is more suited for radar images. It has a spatial parameter "
"to avoid speckle noise perturbations. The larger the radius is, "
"less sensible to the speckle noise the filter is, but micro edge will be missed.");
AddParameter(ParameterType_Int, "filter.touzi.xradius",
"The X radius of the neighborhood.");
SetDefaultParameterInt("filter.touzi.xradius", 1);
AddParameter(ParameterType_Int, "filter.touzi.yradius", "The Y Radius");
AddParameter(ParameterType_Int, "filter.touzi.yradius",
"The Y radius of the neighborhood.");
SetDefaultParameterInt("filter.touzi.yradius", 1);
//Canny Section
......
......@@ -60,10 +60,19 @@ private:
// Documentation
SetDocName("Line segment detection");
SetDocLongDescription("This application detects locally straight contours in a image. It is based on Burns, Hanson, and Riseman method and use an a contrario validation approach (Desolneux, Moisan, and Morel). The algorithm was published by Rafael Gromponevon Gioi, Jérémie Jakubowicz, Jean-Michel Morel and Gregory Randall.\n The given approach computes gradient and level lines of the image and detects aligned points in line support region. The application allows exporting the detected lines in a vector data.");
SetDocLongDescription(
"This application detects locally straight contours in a image."
" It is based on Burns, Hanson, and Riseman method and use an a contrario "
"validation approach (Desolneux, Moisan, and Morel). The algorithm was published "
"by Rafael Gromponevon Gioi, Jérémie Jakubowicz, Jean-Michel Morel and "
"Gregory Randall. The given approach computes gradient and level lines of the "
"image and detects aligned points in line support region. "
"The application allows exporting the detected lines in a vector data.");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("On Line demonstration of the LSD algorithm is available here: http://www.ipol.im/pub/algo/gjmr_line_segment_detector/\n");
SetDocSeeAlso(
"On Line demonstration of the LSD algorithm is available here: "
"http://www.ipol.im/pub/algo/gjmr_line_segment_detector/\n");
AddDocTag(Tags::FeatureExtraction);
......@@ -77,7 +86,9 @@ private:
ElevationParametersHandler::AddElevationParameters(this, "elev");
AddParameter(ParameterType_Empty, "norescale", "No rescaling in [0, 255]");
SetParameterDescription("norescale","By default, the input image amplitude is rescaled between [0,255]. Turn on this parameter to skip rescaling");
SetParameterDescription("norescale",
"By default, the input image amplitude is rescaled between [0,255]."
" Turn on this parameter to skip rescaling");
MandatoryOff("norescale");
AddRAMParameter();
......
This diff is collapsed.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment