Skip to content
Snippets Groups Projects
Commit 6ca4e7dd authored by Ludovic Hussonnois's avatar Ludovic Hussonnois
Browse files

DOC: add doxygen comment and description.

parent dd349c69
No related branches found
No related tags found
No related merge requests found
......@@ -22,10 +22,19 @@ public:
// Documentation
SetDocName( "Train a classifier from multiple images" );
SetDocLongDescription( "TODO" );
SetDocLongDescription(
"This application performs a classifier training from multiple pairs of input images and optional training vector data. "
"Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by "
"the ComputeImagesStatistics application.\n If provided the training vector data must contain polygons with a positive integer field "
"representing the class label. The name of this field can be set using the \"Class label field\" parameter. Training and validation "
"sample lists could be built such that each class is equally represented in both lists if input training vector data is provided."
"Otherwise a percent of the number of available pixel in the image is used. One parameter allows controlling the ratio "
"between the number of samples in training and validation sets. Two parameters allow managing the size of the training and "
"validation sets per class and per image.\n Several classifier parameters can be set depending on the chosen classifier. "
"\n This application is based on Shark Machine Learning " );
SetDocLimitations( "None" );
SetDocAuthors( "OTB-Team" );
SetDocSeeAlso( "OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html " );
SetDocSeeAlso( "otbTrainImagesClassifier" );
AddDocTag( Tags::Learning );
......
......@@ -32,6 +32,15 @@ namespace otb
namespace Wrapper
{
/** \class TrainImagesBase
* \brief Base class for the TrainImagesBaseClassifier and Clustering
*
* This class intends to hold common input/output parameters and
* composite application connection for both supervised and unsupervised
* model training.
*
* \ingroup OTBAppClassification
*/
class TrainImagesBase : public CompositeApplication
{
public:
......@@ -473,6 +482,7 @@ protected:
* \class TrainFileNamesHandler
* This class is used to store file names requires for the application's input and output.
* And to clear temporary files generated by the applications
* \ingroup OTBAppClassification
*/
class TrainFileNamesHandler
{
......
......@@ -61,7 +61,7 @@ namespace otb
* \sa ImageClassificationFilter
*
*
* \ingroup OTBSupervised
* \ingroup OTBLearningBase
*/
template <class TInputValue, class TTargetValue, class TConfidenceValue = double >
class ITK_EXPORT MachineLearningModel
......
......@@ -29,7 +29,7 @@ namespace otb
* This class intends to hold the static attributes that can not be
* part of a template class (ld error).
*
*
* \ingroup OTBLearningBase
*/
class OTBSupervised_EXPORT MachineLearningModelFactoryBase : public itk::Object
{
......
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