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.
pull/17737/head
Ken Shirriff 5 years ago committed by GitHub
parent 5a7045181a
commit 00e1bc49c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 14
      modules/imgproc/include/opencv2/imgproc.hpp

@ -387,7 +387,7 @@ enum FloodFillFlags {
//! @addtogroup imgproc_shape //! @addtogroup imgproc_shape
//! @{ //! @{
//! connected components algorithm output formats //! connected components statistics
enum ConnectedComponentsTypes { enum ConnectedComponentsTypes {
CC_STAT_LEFT = 0, //!< The leftmost (x) coordinate which is the inclusive start of the bounding CC_STAT_LEFT = 0, //!< The leftmost (x) coordinate which is the inclusive start of the bounding
//!< box in the horizontal direction. //!< 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 image the 8-bit single-channel image to be labeled
@param labels destination labeled image @param labels destination labeled image
@param stats statistics output for each label, including the background label, see below for @param stats statistics output for each label, including the background label.
available statistics. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of Statistics are accessed via stats(label, COLUMN) where COLUMN is one of
#ConnectedComponentsTypes. The data type is CV_32S. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.
@param centroids centroid output for each label, including the background label. Centroids are @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. 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 @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively
@ -3897,9 +3897,9 @@ CV_EXPORTS_AS(connectedComponentsWithStatsWithAlgorithm) int connectedComponents
/** @overload /** @overload
@param image the 8-bit single-channel image to be labeled @param image the 8-bit single-channel image to be labeled
@param labels destination labeled image @param labels destination labeled image
@param stats statistics output for each label, including the background label, see below for @param stats statistics output for each label, including the background label.
available statistics. Statistics are accessed via stats(label, COLUMN) where COLUMN is one of Statistics are accessed via stats(label, COLUMN) where COLUMN is one of
#ConnectedComponentsTypes. The data type is CV_32S. #ConnectedComponentsTypes, selecting the statistic. The data type is CV_32S.
@param centroids centroid output for each label, including the background label. Centroids are @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. 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 @param connectivity 8 or 4 for 8-way or 4-way connectivity respectively

Loading…
Cancel
Save