Commit 81b5ac56 authored by Marina Bertolino's avatar Marina Bertolino

DOC: add nodatalabel documentation (ImageClassifier and KMeansClassification)

parent bd80627c
......@@ -80,7 +80,7 @@ private:
// Documentation
SetDocName("Image Classification");
SetDocLongDescription("This application performs an image classification based on a model file produced by the TrainImagesClassifier application. Pixels of the output image will contain the class labels decided by the classifier (maximal class label = 65535). The input pixels can be optionally centered and reduced according to the statistics file produced by the ComputeImagesStatistics application. An optional input mask can be provided, in which case only input image pixels whose corresponding mask value is greater than 0 will be classified. The remaining of pixels will be given the label 0 in the output image.");
SetDocLongDescription("This application performs an image classification based on a model file produced by the TrainImagesClassifier application. Pixels of the output image will contain the class labels decided by the classifier (maximal class label = 65535). The input pixels can be optionally centered and reduced according to the statistics file produced by the ComputeImagesStatistics application. An optional input mask can be provided, in which case only input image pixels whose corresponding mask value is greater than 0 will be classified. By default, the remaining of pixels will be given the label 0 in the output image.");
SetDocLimitations("The input image must have the same type, order and number of bands than the images used to produce the statistics file and the SVM model file. If a statistics file was used during training by the TrainImagesClassifier, it is mandatory to use the same statistics file for classification. If an input mask is used, its size must match the input image size.");
SetDocAuthors("OTB-Team");
......@@ -103,7 +103,11 @@ private:
MandatoryOff("imstat");
AddParameter(ParameterType_Int, "nodatalabel", "Label mask value");
SetParameterDescription("nodatalabel", "TODO");
SetParameterDescription("nodatalabel", "By default, "
"hidden pixels will have the assigned label 0 in the output image. "
"It's possible to define the label mask by another value, "
"but be careful to not take a label from another class (max. 65535).");
SetDefaultParameterInt("nodatalabel", 0);
MandatoryOff("nodatalabel");
......
......@@ -86,7 +86,13 @@ void ClassKMeansBase::ShareKMSamplingParameters()
void ClassKMeansBase::ShareKMClassificationParams()
{
ShareParameter("nodatalabel", "classif.nodatalabel");
ShareParameter("nodatalabel", "classif.nodatalabel", "Label mask value",
"By default, hidden pixels will have the assigned label 0 in the output image. "
"It's possible to define the label mask by another value, "
"but be careful to not take a label from another class. "
"This application initalize the labels from 0 to N-1, "
"N is the number of class (defined by 'nc' parameter).");
ShareParameter("out", "classif.out");
}
......
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