From 00e1bc49c8c38c8d57deae4eb0841dea2d05558b Mon Sep 17 00:00:00 2001 From: Ken Shirriff Date: Thu, 2 Jul 2020 03:58:53 -0700 Subject: [PATCH] Merge pull request #17708 from shirriff:patch-1 Clarify component statistics documentation * Change ConnectedComponentsTypes documentation Change from "algorithm output formats" to "statistics" because it specifies types of statistics, not formats. * Documentation: clarify component statistics Explain that ConnectedComponentTypes selects a statistic. --- modules/imgproc/include/opencv2/imgproc.hpp | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/modules/imgproc/include/opencv2/imgproc.hpp b/modules/imgproc/include/opencv2/imgproc.hpp index f6b5339194..91c1ec52fc 100644 --- a/modules/imgproc/include/opencv2/imgproc.hpp +++ b/modules/imgproc/include/opencv2/imgproc.hpp @@ -387,7 +387,7 @@ enum FloodFillFlags { //! @addtogroup imgproc_shape //! @{ -//! connected components algorithm output formats +//! connected components statistics enum ConnectedComponentsTypes { CC_STAT_LEFT = 0, //!< The leftmost (x) coordinate which is the inclusive start of the bounding //!< box in the horizontal direction. @@ -3881,9 +3881,9 @@ parallel framework is enabled and if the rows of the image are at least twice th @param image the 8-bit single-channel image to be labeled @param labels destination labeled image -@param stats statistics output for each label, including the background label, see below for -available statistics. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of -#ConnectedComponentsTypes. The data type is CV_32S. +@param stats statistics output for each label, including the background label. +Statistics are accessed via stats(label, COLUMN) where COLUMN is one of +#ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S. @param centroids centroid output for each label, including the background label. Centroids are accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively @@ -3897,9 +3897,9 @@ CV_EXPORTS_AS(connectedComponentsWithStatsWithAlgorithm) int connectedComponents /** @overload @param image the 8-bit single-channel image to be labeled @param labels destination labeled image -@param stats statistics output for each label, including the background label, see below for -available statistics. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of -#ConnectedComponentsTypes. The data type is CV_32S. +@param stats statistics output for each label, including the background label. +Statistics are accessed via stats(label, COLUMN) where COLUMN is one of +#ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S. @param centroids centroid output for each label, including the background label. Centroids are accessed via centroids(label, 0) for x and centroids(label, 1) for y. The data type CV_64F. @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively