mirror of
https://github.com/opencv/opencv.git
synced 2024-11-24 19:20:28 +08:00
Merge pull request #20721 from YanivHollander:DocFixes
Doc fixes * Update imgproc.hpp * Update imgproc.hpp
This commit is contained in:
Yaniv Hollander
GitHub
parent
c2e65bafb5
commit
ac57be91e1
@ -2745,13 +2745,6 @@ CV_EXPORTS_W void warpPolar(InputArray src, OutputArray dst, Size dsize,
|
||||
//! @addtogroup imgproc_misc
|
||||
//! @{
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS_W void integral( InputArray src, OutputArray sum, int sdepth = -1 );
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS_AS(integral2) void integral( InputArray src, OutputArray sum,
|
||||
OutputArray sqsum, int sdepth = -1, int sqdepth = -1 );
|
||||
|
||||
/** @brief Calculates the integral of an image.
|
||||
|
||||
The function calculates one or more integral images for the source image as follows:
|
||||
@ -2790,6 +2783,13 @@ CV_EXPORTS_AS(integral3) void integral( InputArray src, OutputArray sum,
|
||||
OutputArray sqsum, OutputArray tilted,
|
||||
int sdepth = -1, int sqdepth = -1 );
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS_W void integral( InputArray src, OutputArray sum, int sdepth = -1 );
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS_AS(integral2) void integral( InputArray src, OutputArray sum,
|
||||
OutputArray sqsum, int sdepth = -1, int sqdepth = -1 );
|
||||
|
||||
//! @} imgproc_misc
|
||||
|
||||
//! @addtogroup imgproc_motion
|
||||
@ -3472,19 +3472,6 @@ the first variant of the function and distanceType == #DIST_L1.
|
||||
CV_EXPORTS_W void distanceTransform( InputArray src, OutputArray dst,
|
||||
int distanceType, int maskSize, int dstType=CV_32F);
|
||||
|
||||
/** @example samples/cpp/ffilldemo.cpp
|
||||
An example using the FloodFill technique
|
||||
*/
|
||||
|
||||
/** @overload
|
||||
|
||||
variant without `mask` parameter
|
||||
*/
|
||||
CV_EXPORTS int floodFill( InputOutputArray image,
|
||||
Point seedPoint, Scalar newVal, CV_OUT Rect* rect = 0,
|
||||
Scalar loDiff = Scalar(), Scalar upDiff = Scalar(),
|
||||
int flags = 4 );
|
||||
|
||||
/** @brief Fills a connected component with the given color.
|
||||
|
||||
The function cv::floodFill fills a connected component starting from the seed point with the specified
|
||||
@ -3561,6 +3548,19 @@ CV_EXPORTS_W int floodFill( InputOutputArray image, InputOutputArray mask,
|
||||
Scalar loDiff = Scalar(), Scalar upDiff = Scalar(),
|
||||
int flags = 4 );
|
||||
|
||||
/** @example samples/cpp/ffilldemo.cpp
|
||||
An example using the FloodFill technique
|
||||
*/
|
||||
|
||||
/** @overload
|
||||
|
||||
variant without `mask` parameter
|
||||
*/
|
||||
CV_EXPORTS int floodFill( InputOutputArray image,
|
||||
Point seedPoint, Scalar newVal, CV_OUT Rect* rect = 0,
|
||||
Scalar loDiff = Scalar(), Scalar upDiff = Scalar(),
|
||||
int flags = 4 );
|
||||
|
||||
//! Performs linear blending of two images:
|
||||
//! \f[ \texttt{dst}(i,j) = \texttt{weights1}(i,j)*\texttt{src1}(i,j) + \texttt{weights2}(i,j)*\texttt{src2}(i,j) \f]
|
||||
//! @param src1 It has a type of CV_8UC(n) or CV_32FC(n), where n is a positive integer.
|
||||
@ -4399,7 +4399,7 @@ lines are drawn using Gaussian filtering.
|
||||
CV_EXPORTS_W void line(InputOutputArray img, Point pt1, Point pt2, const Scalar& color,
|
||||
int thickness = 1, int lineType = LINE_8, int shift = 0);
|
||||
|
||||
/** @brief Draws a arrow segment pointing from the first point to the second one.
|
||||
/** @brief Draws an arrow segment pointing from the first point to the second one.
|
||||
|
||||
The function cv::arrowedLine draws an arrow between pt1 and pt2 points in the image. See also #line.
|
||||
|
||||
@ -4529,11 +4529,6 @@ CV_EXPORTS_W void drawMarker(InputOutputArray img, Point position, const Scalar&
|
||||
/* END OF MARKER SECTION */
|
||||
/* ----------------------------------------------------------------------------------------- */
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS void fillConvexPoly(InputOutputArray img, const Point* pts, int npts,
|
||||
const Scalar& color, int lineType = LINE_8,
|
||||
int shift = 0);
|
||||
|
||||
/** @brief Fills a convex polygon.
|
||||
|
||||
The function cv::fillConvexPoly draws a filled convex polygon. This function is much faster than the
|
||||
@ -4552,10 +4547,9 @@ CV_EXPORTS_W void fillConvexPoly(InputOutputArray img, InputArray points,
|
||||
int shift = 0);
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS void fillPoly(InputOutputArray img, const Point** pts,
|
||||
const int* npts, int ncontours,
|
||||
const Scalar& color, int lineType = LINE_8, int shift = 0,
|
||||
Point offset = Point() );
|
||||
CV_EXPORTS void fillConvexPoly(InputOutputArray img, const Point* pts, int npts,
|
||||
const Scalar& color, int lineType = LINE_8,
|
||||
int shift = 0);
|
||||
|
||||
/** @example samples/cpp/tutorial_code/ImgProc/basic_drawing/Drawing_1.cpp
|
||||
An example using drawing functions
|
||||
@ -4580,9 +4574,10 @@ CV_EXPORTS_W void fillPoly(InputOutputArray img, InputArrayOfArrays pts,
|
||||
Point offset = Point() );
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS void polylines(InputOutputArray img, const Point* const* pts, const int* npts,
|
||||
int ncontours, bool isClosed, const Scalar& color,
|
||||
int thickness = 1, int lineType = LINE_8, int shift = 0 );
|
||||
CV_EXPORTS void fillPoly(InputOutputArray img, const Point** pts,
|
||||
const int* npts, int ncontours,
|
||||
const Scalar& color, int lineType = LINE_8, int shift = 0,
|
||||
Point offset = Point() );
|
||||
|
||||
/** @brief Draws several polygonal curves.
|
||||
|
||||
@ -4601,6 +4596,11 @@ CV_EXPORTS_W void polylines(InputOutputArray img, InputArrayOfArrays pts,
|
||||
bool isClosed, const Scalar& color,
|
||||
int thickness = 1, int lineType = LINE_8, int shift = 0 );
|
||||
|
||||
/** @overload */
|
||||
CV_EXPORTS void polylines(InputOutputArray img, const Point* const* pts, const int* npts,
|
||||
int ncontours, bool isClosed, const Scalar& color,
|
||||
int thickness = 1, int lineType = LINE_8, int shift = 0 );
|
||||
|
||||
/** @example samples/cpp/contours2.cpp
|
||||
An example program illustrates the use of cv::findContours and cv::drawContours
|
||||
\image html WindowsQtContoursOutput.png "Screenshot of the program"
|
||||
@ -4633,7 +4633,7 @@ parameter is only taken into account when there is hierarchy available.
|
||||
@param offset Optional contour shift parameter. Shift all the drawn contours by the specified
|
||||
\f$\texttt{offset}=(dx,dy)\f$ .
|
||||
@note When thickness=#FILLED, the function is designed to handle connected components with holes correctly
|
||||
even when no hierarchy date is provided. This is done by analyzing all the outlines together
|
||||
even when no hierarchy data is provided. This is done by analyzing all the outlines together
|
||||
using even-odd rule. This may give incorrect results if you have a joint collection of separately retrieved
|
||||
contours. In order to solve this problem, you need to call #drawContours separately for each sub-group
|
||||
of contours, or iterate over the collection using contourIdx parameter.
|
||||
@ -4647,7 +4647,7 @@ CV_EXPORTS_W void drawContours( InputOutputArray image, InputArrayOfArrays conto
|
||||
/** @brief Clips the line against the image rectangle.
|
||||
|
||||
The function cv::clipLine calculates a part of the line segment that is entirely within the specified
|
||||
rectangle. it returns false if the line segment is completely outside the rectangle. Otherwise,
|
||||
rectangle. It returns false if the line segment is completely outside the rectangle. Otherwise,
|
||||
it returns true .
|
||||
@param imgSize Image size. The image rectangle is Rect(0, 0, imgSize.width, imgSize.height) .
|
||||
@param pt1 First line point.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user