Commit 56f1e8f7 authored by Cyrille Valladeau's avatar Cyrille Valladeau

ENH: update docexample to the new framework for Classification appli

parent 60be175c
......@@ -50,8 +50,7 @@ private:
SetDocLimitations("The set of input images must have the same number of bands. Input images must be of the same number, type and order of bands.");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("Documentation of the TrainImagesSVMClassifier application.");
SetDocCLExample("otbApplicationLauncherCommandLine ComputeImagesStatistics ${OTB-BIN}/bin --il ${OTB-Data}/Input/Classification/QB_1_ortho.tif ${OTB-Data}/Input/Classification/QB_2_ortho.tif ${OTB-Data}/Input/Classification/QB_3_ortho.tif --out EstimateImageStatisticsQB123.xml");
AddDocTag(Tags::Learning);
AddDocTag(Tags::Analysis);
}
......@@ -69,6 +68,10 @@ private:
SetParameterDescription( "out", "XML filename where the statistics are saved for future reuse" );
MandatoryOff("out");
SetParameterRole("out", Role_Output);
// Doc example parameter settings
SetDocExampleParameterValue("il", "QB_1_ortho.tif QB_2_ortho.tif QB_3_ortho.tif");
SetDocExampleParameterValue("out", "EstimateImageStatisticsQB123.xml");
}
void DoUpdateParameters()
......
......@@ -68,7 +68,7 @@ private:
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 TrainSVMImagesClassifier, 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");
SetDocSeeAlso("TrainSVMImagesClassifier, ValidateSVMImagesClassifier, ComputeImagesStatistics");
SetDocCLExample("otbApplicationLauncherCommandLine ImageSVMClassifier ${OTB-BIN}/bin --in ${OTB-DATA}/Classification/QB_1_ortho.tif --imstat ${OTB-DATA}/Baseline/OTB-Applications/Files/clImageStatisticsQB1.xml --svn ${OTB-DATA}/Baseline/OTB-Applications/Files/clsvmModelQB1.svm --out otbConcatenateImages.png uchar");
AddDocTag(Tags::Learning);
}
......@@ -99,6 +99,12 @@ private:
AddParameter(ParameterType_RAM, "ram", "Available RAM");
SetDefaultParameterInt("ram", 256);
MandatoryOff("ram");
// Doc example parameter settings
SetDocExampleParameterValue("in", "QB_1_ortho.tif");
SetDocExampleParameterValue("imstat", "clImageStatisticsQB1.xml");
SetDocExampleParameterValue("svn", "clsvmModelQB1.svm");
SetDocExampleParameterValue("out", "otbConcatenateImages.png uchar");
}
void DoUpdateParameters()
......
......@@ -78,10 +78,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine KMeansClassification "
"--in ${OTB-Data}/Input/poupees_sub.png --vm ${OTB-Data}/Input/mask_KMeans.png "
"--ts 100 --tp 0.6 --nc 5 --cp 0.9 --sl 100 --out ClassificationFilterOuptut.tif ");
AddDocTag(Tags::Segmentation);
AddDocTag(Tags::Learning);
}
......@@ -117,6 +114,20 @@ private:
AddParameter(ParameterType_Int, "sl", "Number of lines for each streaming block");
SetParameterDescription("sl","input image will be divided into sl lines.");
SetDefaultParameterInt("sl", 1000);
SetDocCLExample("otbApplicationLauncherCommandLine KMeansClassification "
"--in ${OTB-Data}/Input/poupees_sub.png --vm ${OTB-Data}/Input/mask_KMeans.png "
"--ts 100 --tp 0.6 --nc 5 --cp 0.9 --sl 100 --out ClassificationFilterOuptut.tif");
// Doc example parameter settings
SetDocExampleParameterValue("in", "poupees_sub.png");
SetDocExampleParameterValue("vm", "mask_KMeans.png");
SetDocExampleParameterValue("ts", "100");
SetDocExampleParameterValue("tp", "0.5");
SetDocExampleParameterValue("nc", "5");
SetDocExampleParameterValue("cp", "0.9");
SetDocExampleParameterValue("sl", "100");
SetDocExampleParameterValue("out", "ClassificationFilterOuptut.tif");
}
void DoUpdateParameters()
......
......@@ -135,11 +135,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine TrainSVMImagesClassifier ${OTB-BIN}/bin"
"--io.il ${OTB-DATA}/Classification/QB_1_ortho.tif "
"--io.vd ${OTB-DATA}/Classification/ectorData_QB1.shp"
"--io.imstat ${OTB-Data}/Baseline/OTB-Applications/Files/clImageStatisticsQB1.xml"
"--sample.mv 100 --sample.vtr 0.5 --svm.opt true --io.out svmModelQB1_allOpt.svm");
AddDocTag(Tags::Learning);
}
......@@ -209,6 +205,15 @@ private:
AddParameter(ParameterType_Empty, "svm.opt", "parameters optimization");
MandatoryOff("svm.opt");
SetParameterDescription("svm.opt", "SVM parameters optimization");
// Doc example parameter settings
SetDocExampleParameterValue("io.il", "QB_1_ortho.tif");
SetDocExampleParameterValue("io.vd", "VectorData_QB1.shp");
SetDocExampleParameterValue("io.imstat", "clImageStatisticsQB1.xml");
SetDocExampleParameterValue("sample.mv", "100");
SetDocExampleParameterValue("sample.vtr", "0.5");
SetDocExampleParameterValue("sample.opt", "true");
SetDocExampleParameterValue("io.out", "svmModelQB1_allOpt.svm");
}
void DoUpdateParameters()
......
......@@ -125,11 +125,7 @@ private:
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
SetDocCLExample("otbApplicationLauncherCommandLine ValidateSVMImagesClassifier ${OTB-BIN}/bin"
"--il ${OTB-Data}/Classification/QB_1_ortho.tif --vd ${OTB-Data}/Classification/VectorData_QB1_bis.shp"
" --imstat ${OTB-Data}/Baseline/OTB-Applications/Files/clImageStatisticsQB123.xml "
" --svm ${OTB-Data}/Baseline/OTB-Applications/Files/clsvmModelQB123.svm"
" --out PerformanceEstimationQB123.txt ");
AddDocTag(Tags::Learning);
}
......@@ -157,6 +153,13 @@ private:
AddParameter(ParameterType_Filename, "svm", "SVM validation filename");
SetParameterDescription("svm",
"SVM model to validate (given by TrainSVMImagesClassification output for instance).");
// Doc example parameter settings
SetDocExampleParameterValue("il", "Classification/QB_1_ortho.tif");
SetDocExampleParameterValue("vd", "VectorData_QB1_bis.shp");
SetDocExampleParameterValue("imstat", "clImageStatisticsQB123.xml");
SetDocExampleParameterValue("svm", "clsvmModelQB123.svm");
SetDocExampleParameterValue("out", "PerformanceEstimationQB123.txt");
}
void DoUpdateParameters()
......
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