Is OpenCv documentation Open Source.

asked 2014-04-10 15:24:49 -0500

edmoney gravatar image

updated 2014-04-10 15:41:14 -0500

berak gravatar image

I'm making a library of Lisp bindings for OpenCv. In the OpenCv documentation there are C, C++, and Python function names usually listed for each funtion as below

    C++: void convertScaleAbs(InputArray src, OutputArray dst, double alpha=1, double beta=0)

    Python: cv2.convertScaleAbs(src[, dst[, alpha[, beta]]]) → dst

    C: void cvConvertScaleAbs(const CvArr* src, CvArr* dst, double scale=1, double shift=0)

I thought it would be cool, to make my documentation , to copy OpenCv's verbatim, word for word, except take out the C, and Python function headers and add in LisP function headers. I keep C++ to show them side by side, because I'm wrapping the C++ interface. I change all the references to C++ function names and change to the variations in my own library, I add code examples for each one and post in the documentation, I keep the images with the equations on them but convert them(invert them) to black and change all the conditional references ie A == C to Lisp versions..ie (eq A C). Anything in another programming language I change to a Lisp version. All code anything. I wondered is this legal, if I post my documentation this way on a website I create and post links to in my source code..All my software is free and Open source ..I don't charge for it. Any advice on to the legality of this is appreciated.

edit retag flag offensive close merge delete

Comments

OpenCV is a open-source project which you can indeed use for own products without problem. Same goes for the documentation afaik. Just keep a reference to the correct documentation I would say! BTW if you are creating LISP bindings, it might be an idea to introduce them by a pull request?

StevenPuttemans gravatar imageStevenPuttemans ( 2014-04-11 04:10:36 -0500 )edit

@StevenPuttemans By reference, you mean post a link in my documentation to theirs or say a quick thank you. Do you think when my bindings get big enough I might really have a shot to add them? They are very well tested, with example code included for each function

edmoney gravatar imageedmoney ( 2014-04-11 09:30:04 -0500 )edit

Yeah I guess a quick thank you with a link to the correct documentation on the main page will do just fine. However, this is a guess on my part but it should be conform to the open source standards. As to having a shot to add them, I do think so, take a look at the contribution page. Completely new functionality like your bindings, is best added using the opencv contrib repository I think. I think devs will certainly be enthousiastic if you keep updating your bindings and documentation. The extra tests and example code are also needed! To prove they are working. Try it out! Maybe you will add a large chunck of bindings to this interesting project!

StevenPuttemans gravatar imageStevenPuttemans ( 2014-04-14 02:36:40 -0500 )edit