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

DOC: review vertexcomponentanalysis app

parent 0a7a735d
No related branches found
No related tags found
No related merge requests found
......@@ -50,16 +50,28 @@ private:
void DoInit() ITK_OVERRIDE
{
SetName("VertexComponentAnalysis");
SetDescription("Find endmembers in hyperspectral images with Vertex Component Analysis");
SetDescription("Given a set of mixed spectral vectors, estimate"
"reference subtances also known as endmembers using the Vertex"
"Component Analysis algorithm.");
// Documentation
SetDocName("Vertex Component Analysis");
SetDocLongDescription("Applies the Vertex Component Analysis to an hyperspectral image to extract endmembers");
SetDocLongDescription("Apply the Vertex Component Analysis [1] to"
"an hyperspectral image to extract endmembers. Given a set of mixed"
"spectral vectors (multispectral or hyperspectral), the application"
"estimates the spectral signature of reference subtances also known"
"as endmembers.");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
AddDocTag("Miscellaneous");
SetDocSeeAlso("[1] J. M. P. Nascimento and J. M. B. Dias, Vertex"
"component analysis: a fast algorithm to unmix hyperspectral data,"
"in IEEE Transactions on Geoscience and Remote Sensing, vol. 43,"
"no. 4, pp. 898-910, April 2005.J. M. P. Nascimento and"
"J. M. B. Dias, Vertex component analysis: a fast algorithm to"
"unmix hyperspectral data, in IEEE Transactions on Geoscience and"
"Remote Sensing, vol. 43, no. 4, pp. 898-910, April 2005.");
AddDocTag("Miscellaneous");
AddDocTag(Tags::Hyperspectral);
AddDocTag(Tags::DimensionReduction);
......@@ -67,12 +79,15 @@ private:
SetParameterDescription("in","Input hyperspectral data cube");
AddParameter(ParameterType_Int, "ne", "Number of endmembers");
SetParameterDescription("ne","The number of endmembers to extract from the data cube");
SetParameterDescription("ne","The number of endmembers to extract from the hyperspectral image.");
SetParameterInt("ne",1, false);
MandatoryOn("ne");
AddParameter(ParameterType_OutputImage, "outendm", "Output Endmembers");
SetParameterDescription("outendm","The endmebers, stored in a one-line multi-spectral image, each pixel representing an endmember");
SetParameterDescription("outendm","Endmembers, stored in a"
"one-line multi-spectral image.Each pixel corresponds to one"
"endmembers and each band values corresponds to the spectral"
"signature of the corresponding endmember.");
MandatoryOn("outendm");
AddRANDParameter();
......
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