Commit 140b9036 authored by Victor Poughon's avatar Victor Poughon

DOC: cookbook formatting

parent af992d4f
...@@ -55,12 +55,13 @@ private: ...@@ -55,12 +55,13 @@ private:
" algorithm.\n\n" " algorithm.\n\n"
"The MAD algorithm produces a set of N change maps (where N is the" "The MAD algorithm produces a set of N change maps (where N is the"
" maximum number of bands in first and second input images), with the" " maximum number of bands in first and second input images), with the"
" following properties:\n" " following properties:\n\n"
" - Change maps are differences of a pair of linear combinations of "
"* Change maps are differences of a pair of linear combinations of "
" bands from image 1 and bands from image 2 chosen to maximize the " " bands from image 1 and bands from image 2 chosen to maximize the "
" correlation, \n" " correlation, \n"
" - Each change map is orthogonal to the others.\n" "* Each change map is orthogonal to the others.\n\n"
" \n"
"This is a statistical method which can handle different modalities" "This is a statistical method which can handle different modalities"
" and even different bands and number of bands between images. \n" " and even different bands and number of bands between images. \n"
" \n" " \n"
......
...@@ -404,10 +404,9 @@ private: ...@@ -404,10 +404,9 @@ private:
SetDocName("Unsupervised KMeans image classification"); SetDocName("Unsupervised KMeans image classification");
SetDocLongDescription("Unsupervised KMeans image classification. " SetDocLongDescription("Unsupervised KMeans image classification. "
"KMeansClassification is a composite application, " "This is a composite application, using existing training and classification applications. "
"using an existing training and classification application. "
"The SharkKMeans model is used.\n\n" "The SharkKMeans model is used.\n\n"
"KMeansClassification application is only available if OTB is compiled with Shark support" "This application is only available if OTB is compiled with Shark support"
"(CMake option :code:`OTB_USE_SHARK=ON`).\n\n" "(CMake option :code:`OTB_USE_SHARK=ON`).\n\n"
"The steps of this composite application:\n\n" "The steps of this composite application:\n\n"
......
...@@ -85,7 +85,7 @@ private: ...@@ -85,7 +85,7 @@ private:
"IEEE Transactions on geoscience and remote sensing, vol. 39, NO. 2,\n" "IEEE Transactions on geoscience and remote sensing, vol. 39, NO. 2,\n"
"February 2001, p. 309-320.\n\n" "February 2001, p. 309-320.\n\n"
"Depending of the profile selection, the application provides::\n\n" "Depending of the profile selection, the application provides:\n\n"
"* The multi scale geodesic morphological opening or closing profile of the input image.\n" "* The multi scale geodesic morphological opening or closing profile of the input image.\n"
"* The multi scale derivative of the opening or closing profile.\n" "* The multi scale derivative of the opening or closing profile.\n"
......
...@@ -243,7 +243,7 @@ private: ...@@ -243,7 +243,7 @@ private:
"Please also note that the output image type should be set to uint32 to" "Please also note that the output image type should be set to uint32 to"
" ensure that there are enough labels available.\n\n" " ensure that there are enough labels available.\n\n"
"The output of this application can be passed to the" "The output of this application can be passed to the"
" LSMSSmallRegionMerging [3] or LSMSVectorization [4] applications to" " LSMSSmallRegionsMerging [3] or LSMSVectorization [4] applications to"
" complete the LSMS workflow."); " complete the LSMS workflow.");
SetDocLimitations("This application is part of the Large-Scale Mean-Shift segmentation" SetDocLimitations("This application is part of the Large-Scale Mean-Shift segmentation"
" workflow (LSMS) [1] and may not be suited for any other purpose. This" " workflow (LSMS) [1] and may not be suited for any other purpose. This"
......
...@@ -58,9 +58,9 @@ private: ...@@ -58,9 +58,9 @@ private:
// Documentation // Documentation
SetDocName("Large-Scale MeanShift"); SetDocName("Large-Scale MeanShift");
SetDocLongDescription("This application chains together the 4 steps of the " SetDocLongDescription("This application chains together the 4 steps of the "
"MeanShit framework, that is the MeanShiftSmoothing [1], the " "MeanShit framework, that is the MeanShiftSmoothing, the "
"LSMSSegmentation [2], the LSMSSmallRegionsMerging [3] and the " "LSMSSegmentation, the LSMSSmallRegionsMerging and the "
"LSMSVectorization [4].\n\n" "LSMSVectorization.\n\n"
"This application can be a preliminary step for an object-based analysis.\n\n" "This application can be a preliminary step for an object-based analysis.\n\n"
"It generates a vector data file containing the regions extracted with " "It generates a vector data file containing the regions extracted with "
"the MeanShift algorithm. The spatial and range radius parameters allow " "the MeanShift algorithm. The spatial and range radius parameters allow "
...@@ -75,10 +75,10 @@ private: ...@@ -75,10 +75,10 @@ private:
); );
SetDocLimitations("None"); SetDocLimitations("None");
SetDocAuthors("OTB-Team"); SetDocAuthors("OTB-Team");
SetDocSeeAlso("[1] MeanShiftSmoothing\n" SetDocSeeAlso("MeanShiftSmoothing\n"
"[2] LSMSSegmentation\n" "LSMSSegmentation\n"
"[3] LSMSSmallRegionsMerging\n" "LSMSSmallRegionsMerging\n"
"[4] LSMSVectorization"); "LSMSVectorization");
AddDocTag(Tags::Segmentation); AddDocTag(Tags::Segmentation);
AddDocTag("LSMS"); AddDocTag("LSMS");
......
...@@ -64,13 +64,14 @@ private: ...@@ -64,13 +64,14 @@ private:
" or CloudCompare [3]\n\n" " or CloudCompare [3]\n\n"
"This application is part of the stereo reconstruction framework. The " "This application is part of the stereo reconstruction framework. The "
"input data can be produced by the application DisparityMapToElevationMap.\n\n" "input data can be produced by the application DisparityMapToElevationMap.\n\n"
"There are two types of supported input images:\n" "There are two types of supported input images:\n\n"
" * A DEM image, with a ground projection, containing elevation values. "
"* A DEM image, with a ground projection, containing elevation values. "
"Each elevation value can be considered as a 3D point.\n" "Each elevation value can be considered as a 3D point.\n"
" * A 3D grid image, containing 5 bands (the first 3 are the 3D " "* A 3D grid image, containing 5 bands (the first 3 are the 3D "
"coordinates of each point, the 5th is a validity mask where valid values" "coordinates of each point, the 5th is a validity mask where valid values"
" are larger or equal to 1)\n" " are larger or equal to 1)\n\n"
"\n"
"The user shall also give a support image that contains color values for" "The user shall also give a support image that contains color values for"
" each 3D point. The color values will be embedded in the PLY file."); " each 3D point. The color values will be embedded in the PLY file.");
SetDocLimitations("The input DEM image has to entirely fit into memory."); SetDocLimitations("The input DEM image has to entirely fit into memory.");
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment