diff --git a/Modules/Learning/Unsupervised/include/otbContingencyTableCalculator.h b/Modules/Learning/Unsupervised/include/otbContingencyTableCalculator.h index eeabdbc2c140857bf89726c0ccc60ad9011370cb..b8d8d924af49ed402c70cad906854560f0f4e9db 100644 --- a/Modules/Learning/Unsupervised/include/otbContingencyTableCalculator.h +++ b/Modules/Learning/Unsupervised/include/otbContingencyTableCalculator.h @@ -29,12 +29,12 @@ namespace otb { /** - * \brief ContingencyTableCalculator provide facilities to compute ContingencyTable with different structure type - * The size of the label list should be the same for both list. - * \tparam TRefListLabel data structure type which contain the reference labels - * \tparam TProdListLabel data structure type which contain the produced labels - * \tparam TClassLabel the label data type + * \brief ContingencyTableCalculator provide facilities to compute ContingencyTable. + * + * The ContingencyTableCalculator can be used with different structure type, + * the size of the label list should be the same for both list. * + * \tparam TClassLabel the label data type * \ingroup OTBUnsupervised */ template<class TClassLabel> @@ -59,12 +59,18 @@ public: typedef typename std::map<TClassLabel, unsigned long> CountMapType; typedef typename std::map<TClassLabel, CountMapType > MapOfClassesType; - /** Populate the confusion Matrix for a image iteration */ + /** Populate the confusion Matrix for a image iteration. + * \tparam TRefListLabel data structure type which contain the reference labels. + * \tparam TProdListLabel data structure type which contain the produced labels. + */ template<class TRefIterator, class TProdIterator> void Compute(TRefIterator itRef, TProdIterator itProd, bool refHasNoData = false, typename TRefIterator::InternalPixelType refNoData = 0, bool prodHasNoData = false, typename TProdIterator::InternalPixelType prodNoData = 0); - /** Populate the confusion Matrix with input which provide GetMeasurementVector()[0] access */ + /** Populate the confusion Matrix with input which provide GetMeasurementVector()[0] access + * \tparam TRefListLabel data structure type which contain the reference labels. + * \tparam TProdListLabel data structure type which contain the produced labels. + */ template<class TRefIterator, class TProdIterator> void Compute(TRefIterator refBegin, TRefIterator refEnd, TProdIterator prodBegin, TProdIterator prodEnd);