Opencv 3.0 dev python documentation

asked 2015-02-16 04:35:59 -0500

krips89 gravatar image

updated 2015-02-16 04:55:04 -0500


After using the python binding for Opencv 3, I found quite a lot of features have been changed. For example the new drawKeypoints function is:

drawKeypoints(image, keypoints, outImage[, color[, flags]]) -> outImage

see the extra mandatory outImage argument (which does not make any sense) ? These extra changes are not really documented in the Opencv 3 python documentation.

Other than that the documentation in general is highly inconstant (for example they still use cv2.SIFT() instead of cv2.xfeatures2d.SIFT_create() and similarly cv2.ORB instead of cv2.ORB_create(). I was wondering when will they update the documentation? And why did they not update the documentation with the code changes?

edit retag flag offensive close merge delete


  • where did you find those ?
  • you're highly encouraged, to report and help fixing those issues
berak gravatar imageberak ( 2015-02-16 04:43:15 -0500 )edit

@krips89 the fact that the documentation is not updated is known and is mainly due to the fact that OpenCV does not have a technical writer in charge of that. They kind of depend on the community to help out here. Like many of us, you can help out by making issues reporting all inconsistencies and supplying pull requests where possible to address them!

StevenPuttemans gravatar imageStevenPuttemans ( 2015-02-16 08:28:03 -0500 )edit

it would already be very helpful, if you'd collect some links to broken things, and add them here.

berak gravatar imageberak ( 2015-02-16 08:59:14 -0500 )edit

Jup plenty of people who are up for fixing it ^^

StevenPuttemans gravatar imageStevenPuttemans ( 2015-02-16 09:15:39 -0500 )edit

@StevenPuttemans, I can definitely post all the inconsistencies I find, and I will; but I believe that updating documentation/tutorial should be a part of the coding process. I understand that OpenCV is community dependent; most of the opensource libraries are. But when you are migrating heavily used classes over different modules, changing its signatures, you got to at least look at the repercussion of the changes in the pipeline and update tutorial. When I was an active developer at the library PCL, our strategy was to update the corresponding documentation and tutorials for any change you do to an existing class. The same should be done for OpenCV as well.

krips89 gravatar imagekrips89 ( 2015-02-16 18:11:22 -0500 )edit

@krips89 i totally agree ... but the rules are not so stricktly followed around here from my experience. There are some of the moderators on the PR stack that force people to adapt any documentation when changes are made, but I guess it also due to the latest documentation switch that it kinda got left on a sideline!

StevenPuttemans gravatar imageStevenPuttemans ( 2015-02-17 01:32:48 -0500 )edit

This issue was raised in February and the documentation is still not updated?

static gravatar imagestatic ( 2015-11-08 18:35:00 -0500 )edit

admittedly hard to find the latest docs, but they are fixed

berak gravatar imageberak ( 2015-11-09 00:34:26 -0500 )edit