Ask Your Question

How to find the documentation of Python API?

asked 2017-02-18 07:50:47 -0500

fanta gravatar image

Given an OpenCV 3.2 API method, class, etc. in C++, how can I find the corresponding method, class, etc. in Python? Is it documented somewhere?

E.g., the C++ API has a function called void cv::HoughLinesP(); how do I find the signature of the corresponding function in Python?


edit retag flag offensive close merge delete

1 answer

Sort by ยป oldest newest most voted

answered 2017-02-20 03:43:48 -0500

berak gravatar image

since opencv3, the python docs are no more generated, the last version, that had those is this one

but you can use the builtin help function:

>>> help(cv2)

to see all of it, or in your case:

>>> help(cv2.HoughLinesP)
Help on built-in function HoughLinesP:

    HoughLinesP(image, rho, theta, threshold[, lines[, minLineLength[, maxLineGap]]]) -> lines

edit flag offensive delete link more


Thanks for the link. It's disappointing that the documentation is no longer generated though. The Python API is much more accessible from my point of view, but without proper documentation it's really hard to use. I have tried using help(cv2.whatever) but it always just seems to return the C++ documentation. Is there not a way to generate the Python documentation? If Python is still supported, it surely must be possible! Perhaps I'll just have to invest some time working out how to use and compile C++ for OpenCV.

rmwiseman gravatar imagermwiseman ( 2018-04-26 03:12:05 -0500 )edit

Question Tools

1 follower


Asked: 2017-02-18 07:50:47 -0500

Seen: 305 times

Last updated: Feb 20 '17