ropencv 0.0.10 → 0.0.11

data/License.txt

@@ -0,0 +1,25 @@
+Copyright (c) 2013, Alexander Duda All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* The names of its contributors may not be used to endorse or promote products 
+  derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,33 +1,54 @@
-# ffi ruby bindings for OpenCV 
-Automated ffi ruby bindings for OpenCV 2.4.4 and higher. For wrapping
-all marked OpenCV C++ methods the OpenCV hdr parser is used to parse the OpenCV
-header files. From there rbind generates a C interface and ruby classes. The
-ruby classes are using the C interface via ffi to give the user the same object
-oriented experience on the ruby side like he has on the c++ side.
+# Ruby Bindings for OpenCV 
+ROpenCV is a ffi ruby binding for the Open Source Computer Vision Library
+[OpenCV](http://opencv.org/opencv-java-api.html).
+
+Unlike other OpenCV ruby binding projects like
+[ruby-opencv](https://github.com/ruby-opencv/ruby-opencv/) or
+[opencv-ffi](https://github.com/amarburg/opencv-ffi) this binding is
+automatically generated by parsing the OpenCV C++ headers having the following
+advantages:
+
+  * automatically up-to-date
+  * full API coverage
+  * closely match the original C++ interface
 
 ## State:
 - All marked methods in the OpenCV C++ header are wrapped
 - Memory management needs review
 - Currently, no support for multi threading or GPU
 
-## Supported OpenCV versions:
-- 2.4.4
-- 2.4.5
-- 2.4.6
-- 2.4.9
+## License
+ROpenCV is released under a BSD license, it is free for both academic and
+commercial use.
+
+## Compatibility Notes
+ROpenCV should run on any platform which supports Ruby and OpenCV 2.4.4 or
+higher. It has been successfully tested on the following platforms.
 
-# Installation 
-You have to install opencv 2.4.4 - 2.4.6 or 2.4.9 first. Afterward, you can install opencv ruby bindings via:
-- gem install ropencv
+  * Linux with Ruby 1.9.3 and OpenCV 2.4.4 - 2.4.6
+  * Mac OSX with Ruby 1.9.3 and OpenCV 2.4.4 - 2.4.6
 
-# Example1
+## Installation
+After running the following commands, ROpenCV and all the mandatory
+dependencies should be installed:
+
+### Ubuntu / Debian
+  * [Install OpenCV 2.4.4 or newer.](http://opencv.org/downloads.html)
+  * sudo apt-get install ruby rubygems cmake g++
+  * sudo gem install ropencv
+
+### Usage
 
     require 'ropencv'
     include OpenCV
+    m = cv::Mat.new(3,3,cv::CV_64FC1)
 
-    mat = cv::imread("logo.png")
-    cv.blur(mat,mat,cv::Size.new(10,10))
+# Example
 
+    require 'ropencv'
+    include OpenCV
+
+    mat = cv::imread("logo.png")
     detector = cv::FeatureDetector::create("SURF")
     keypoints = Std::Vector.new(cv::KeyPoint)
     detector.detect(mat,keypoints)
@@ -38,33 +59,3 @@ You have to install opencv 2.4.4 - 2.4.6 or 2.4.9 first. Afterward, you can inst
     cv::draw_keypoints(mat,keypoints,mat)
     cv::imshow("key_points",mat)
     cv::wait_key(-1)
-
-# Example2
-
-    require 'ropencv'
-    include OpenCV
-
-    mat1 = cv::imread("image1.png")
-    mat2 = cv::imread("image2.png")
-
-    detector = cv::FeatureDetector::create("SURF")
-    extractor = cv::DescriptorExtractor::create("SURF")
-    matcher = cv::DescriptorMatcher::create("BruteForce")
-
-    features1 = Std::Vector.new(cv::KeyPoint.new)
-    features2 = Std::Vector.new(cv::KeyPoint.new)
-    detector.detect mat1,features1
-    detector.detect mat2,features2
-
-    descriptor1 = cv::Mat.new
-    descriptor2 = cv::Mat.new
-    extractor.compute(mat1,features1,descriptor1)
-    extractor.compute(mat2,features2,descriptor2)
-
-    matches = Std::Vector(cv::DMatch.new)
-    matcher.match(descriptor1,descriptor2,matches)
-
-    result = cv::Mat.new
-    cv::draw_matches(mat_last,features1,mat,features2,matches,result)
-    cv::imshow("result",result)
-    cv::wait_key(-1)

data/ext/opencv.yml

@@ -13723,7 +13723,7 @@ cv::CvMat: |-
   `CV_MAT_ELEM(matrix, type, i, j*nchannels + channel_idx)`.
   
   `CvMat` is now obsolete; consider using :ocvMat instead.
-cv::CvMatND: `CvMatND` is now obsolete; consider using :ocvMat instead.
+cv::CvMatND: CvMatND is now obsolete; consider using :ocvMat instead.
 cv::IplImage: |-
   The `IplImage` is taken from the Intel Image Processing Library, in
   which the format is native. OpenCV only supports a subset of possible

data/ext/rbind.rb

@@ -59,19 +59,28 @@ rbind.parser.type("std::vector<Point3f>")
 rbind.parser.type("std::vector<Point3d>")
 rbind.parser.type("std::vector<Vec4i>")
 
+# add some extra documentation
+rbind.parser.doc = "ROpenCV API Documentation for OpenCV #{opencv_version}"
+rbind.parser.cv.doc = "ROpenCV API Documentation for OpenCV #{opencv_version}"
+
 # add opencv docu
-#@doc = YAML.load(File.open(File.join(File.dirname(__FILE__),'opencv.yml')).read)
-#rbind.parser.each_type do |t|
-#    if @doc.has_key?(t.full_name)
-#        t.doc = @doc[t.full_name]
-#    end
-#    next unless t.is_a?(Rbind::RNamespace)
-#    t.each_operation do |op|
-#        if @doc.has_key?(op.full_name)
-#            op.doc = @doc[op.full_name]
-#        end
-#    end
-#end
+# this is disabled by default because yard takes ages to parse
+# the ruby files
+if ARGV.include?("--doc")
+    Rbind.log.info "processing opencv.yml"
+    @doc = YAML.load(File.open(File.join(File.dirname(__FILE__),'opencv.yml'),"r:ascii").read)
+    rbind.parser.each_type do |t|
+        if @doc.has_key?(t.full_name)
+            t.doc = @doc[t.full_name]
+        end
+        next unless t.is_a?(Rbind::RNamespace)
+        t.each_operation do |op|
+            if @doc.has_key?(op.full_name)
+                op.doc = @doc[op.full_name]
+            end
+        end
+    end
+end
 
 # generate files
 rbind.generator_ruby.file_prefix = "ropencv"

data/ext/src/CMakeLists.txt

@@ -41,9 +41,9 @@ else()
     FIND_PACKAGE(Ruby)
     IF(NOT RUBY_INCLUDE_PATH)
         MESSAGE(STATUS "Ruby library not found. Cannot install ruby extensions")
-    ELSEIF(RUBY_EXTENSIONS_AVAILABLE)
+    ELSE(NOT RUBY_INCLUDE_PATH)
         STRING(REGEX REPLACE ".*lib(32|64)?/?" "lib/" RUBY_LIBRARY_INSTALL_DIR ${RUBY_RUBY_LIB_PATH})
-        INSTALL(DIRECTORY ${ROOT_FOLDER}/lib/ruby/ DESTINATION ${RUBY_LIBRARY_INSTALL_DIR}
+        INSTALL(DIRECTORY ${ROOT_FOLDER}/lib/ DESTINATION ${RUBY_LIBRARY_INSTALL_DIR}
             FILES_MATCHING PATTERN "*.rb")
     ENDIF(NOT RUBY_INCLUDE_PATH)
 endif()

data/lib/ropencv/ropencv_ruby.rb

@@ -7,22 +7,26 @@ module OpenCV
         end
     end
 
-    class Std::Vector::Cv_Mat
-        def self.to_native(obj,context)
-            if obj.is_a?(Vector::Std_Vector_Cv_Point2f)
-                t = Vector::Cv_Mat.new
-                obj.each do |e|
-                    t << cv::Mat.new(e.size,2,cv::CV_32FC1,e.data,cv::Mat::AUTO_STEP)
-                end
-                t.__obj_ptr__
-            elsif obj.is_a?(Vector::Std_Vector_Cv_Point)
-                t = Vector::Cv_Mat.new
-                obj.each do |e|
-                    t << cv::Mat.new(e.size,2,cv::CV_32SC1,e.data,cv::Mat::AUTO_STEP)
+    module Std
+        class Vector
+            class Cv_Mat
+                def self.to_native(obj,context)
+                    if obj.is_a?(Vector::Std_Vector_Cv_Point2f)
+                        t = Vector::Cv_Mat.new
+                        obj.each do |e|
+                            t << cv::Mat.new(e.size,2,cv::CV_32FC1,e.data,cv::Mat::AUTO_STEP)
+                        end
+                        t.__obj_ptr__
+                    elsif obj.is_a?(Vector::Std_Vector_Cv_Point)
+                        t = Vector::Cv_Mat.new
+                        obj.each do |e|
+                            t << cv::Mat.new(e.size,2,cv::CV_32SC1,e.data,cv::Mat::AUTO_STEP)
+                        end
+                        t.__obj_ptr__
+                    else
+                        rbind_to_native(obj,context)
+                    end
                 end
-                t.__obj_ptr__
-            else
-                rbind_to_native(obj,context)
             end
         end
     end
@@ -152,7 +156,7 @@ module OpenCV
                                [obj.size,1,obj.first]
                            end
                     setter,step,type = if e.is_a? Fixnum
-                                           [:put_array_of_uint8,w,CV_8UC1]
+                                           [:put_array_of_int32,4*w,CV_32SC1]
                                        elsif e.is_a? Float
                                            [:put_array_of_float64,8*w,CV_64FC1]
                                        else
@@ -205,8 +209,6 @@ module OpenCV
                     data.get_int32(i*step+j*4)
                 when CV_32F
                     data.get_float32(i*step+j*4)
-                when CV_32F
-                    data.get_float32(i*step+j*4)
                 when CV_64F
                     data.get_float64(i*step+j*8)
                 else
@@ -260,11 +262,11 @@ module OpenCV
                 when CV_8U
                     data.put_uint8(i*step+j,val)
                 when CV_16U
-                    data.put_uint16(i*step+j,val*2)
+                    data.put_uint16(i*step+j*2,val)
                 when CV_16S
-                    data.put_int16(i*step+j,val*2)
+                    data.put_int16(i*step+j*2,val)
                 when CV_32S
-                    data.put_int32(i*step+j,val*4)
+                    data.put_int32(i*step+j*4,val)
                 when CV_32F
                     data.put_float32(i*step+j*4,val)
                 when CV_64F

data/ropencv.gemspec

@@ -1,20 +1,18 @@
 Gem::Specification.new do |s|
     s.name              = 'ropencv'
-    s.version           = '0.0.10'
-    s.date              = '2013-08-15'
+    s.version           = '0.0.11'
+    s.date              = '2013-08-21'
     s.platform          = Gem::Platform::RUBY
     s.authors           = ['Alexander Duda']
     s.email             = ['Alexander.Duda@dfki.de']
-    s.homepage          = 'http://github.com/D-Alex/ropencv'
-    s.summary           = 'Automated ffi-bindings for opencv 2.4.4 and higher'
-    s.description       = 'For wrapping all marked OpenCV C++ methods the OpenCV hdr parser is used to parse the OpenCV '\
-                          'header files. From there rbind generates a C interface and ruby classes. The '\
-                          'ruby classes are using the C interface via ffi to give the user the same object '\
-                          'oriented experience on the ruby side like he has on the c++ side.'
+    s.homepage          = 'http://www.ropencv.aduda.eu'
+    s.summary           = 'Ruby bindings for opencv 2.4.4 and higher'
+    s.description       = 'ROpenCV is a ffi ruby binding for the Open Source Computer Vision Library OpenCV 2.4.4 and higher'
     s.files             = `git ls-files`.split("\n") + ["lib/ropencv/ropencv_types.rb","lib/ropencv/ropencv_ruby.rb"]
     s.require_path      = 'lib'
     s.required_rubygems_version = ">= 1.3.6"
-    s.add_runtime_dependency "rbind", "~> 0.0.17"
+    s.add_runtime_dependency "rbind", "~> 0.0.21"
     s.add_runtime_dependency "ffi", "~> 1.9.0"
     s.extensions = ['ext/extconf.rb']
+    s.license = 'BSD'
 end

metadata

@@ -2,7 +2,7 @@
 name: ropencv
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors: 
 - Alexander Duda
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-15 00:00:00 Z
+date: 2013-08-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rbind
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.0.17
+        version: 0.0.21
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 1.9.0
   type: :runtime
   version_requirements: *id002
-description: For wrapping all marked OpenCV C++ methods the OpenCV hdr parser is used to parse the OpenCV header files. From there rbind generates a C interface and ruby classes. The ruby classes are using the C interface via ffi to give the user the same object oriented experience on the ruby side like he has on the c++ side.
+description: ROpenCV is a ffi ruby binding for the Open Source Computer Vision Library OpenCV 2.4.4 and higher
 email: 
 - Alexander.Duda@dfki.de
 executables: []
@@ -47,6 +47,7 @@ files:
 - .gitignore
 - .yardopts
 - CMakeLists.txt
+- License.txt
 - README.md
 - examples/find_keypoints.rb
 - examples/logo.png
@@ -75,9 +76,9 @@ files:
 - test/test_vec.rb
 - test/test_vector.rb
 - lib/ropencv/ropencv_types.rb
-homepage: http://github.com/D-Alex/ropencv
-licenses: []
-
+homepage: http://www.ropencv.aduda.eu
+licenses: 
+- BSD
 post_install_message: 
 rdoc_options: []
 
@@ -101,7 +102,7 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Automated ffi-bindings for opencv 2.4.4 and higher
+summary: Ruby bindings for opencv 2.4.4 and higher
 test_files: []
 
 has_rdoc: