Fix of bug #3283 and bug #3301
authorStevenPuttemans <steven.puttemans@lessius.eu>
Tue, 1 Oct 2013 09:37:14 +0000 (11:37 +0200)
committerStevenPuttemans <steven.puttemans@lessius.eu>
Fri, 4 Oct 2013 09:19:45 +0000 (11:19 +0200)
Added extra information for fitEllipse, minAreaRect and addapted ellipse &
ellipse2Poly parameter description.

modules/core/doc/drawing_functions.rst
modules/imgproc/doc/structural_analysis_and_shape_descriptors.rst

index b277e01..7a6bd17 100644 (file)
@@ -106,7 +106,7 @@ Draws a simple or thick elliptic arc or fills an ellipse sector.
 
     :param center: Center of the ellipse.
 
-    :param axes: Length of the ellipse axes.
+    :param axes: Half of the size of the ellipse main axes.
 
     :param angle: Ellipse rotation angle in degrees.
 
@@ -144,7 +144,7 @@ Approximates an elliptic arc with a polyline.
 
     :param center: Center of the arc.
 
-    :param axes: Half-sizes of the arc. See the  :ocv:func:`ellipse`  for details.
+    :param axes: Half of the size of the ellipse main axes. See the  :ocv:func:`ellipse`  for details.
 
     :param angle: Rotation angle of the ellipse in degrees. See the  :ocv:func:`ellipse`  for details.
 
@@ -160,7 +160,6 @@ The function ``ellipse2Poly`` computes the vertices of a polyline that approxima
 :ocv:func:`ellipse` .
 
 
-
 fillConvexPoly
 ------------------
 Fills a convex polygon.
index f25cc5a..9261185 100644 (file)
@@ -358,8 +358,6 @@ Calculates the up-right bounding rectangle of a point set.
 The function calculates and returns the minimal up-right bounding rectangle for the specified point set.
 
 
-
-
 contourArea
 ---------------
 Calculates a contour area.
@@ -489,6 +487,7 @@ Fits an ellipse around a set of 2D points.
         * Nx2 numpy array (Python interface)
 
 The function calculates the ellipse that fits (in a least-squares sense) a set of 2D points best of all. It returns the rotated rectangle in which the ellipse is inscribed. The algorithm [Fitzgibbon95]_ is used.
+Developer should keep in mind that it is possible that the returned ellipse/rotatedRect data contains negative indices, due to the data points being close to the border of the containing Mat element.
 
 .. note::
 
@@ -614,7 +613,7 @@ Finds a rotated rectangle of the minimum area enclosing the input 2D point set.
         * Nx2 numpy array (Python interface)
 
 The function calculates and returns the minimum-area bounding rectangle (possibly rotated) for a specified point set. See the OpenCV sample ``minarea.cpp`` .
-
+Developer should keep in mind that the returned rotatedRect can contain negative indices when data is close the the containing Mat element boundary.
 
 
 minEnclosingCircle