ruby-opencv 0.0.11 → 0.0.12.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f163ec9f4d2e2965c14628f3e4b1896313d6aab
-  data.tar.gz: bb59169166d93df0586207a896e4a3c81c33b9de
+  metadata.gz: 5d02abda7096be25deaf28aa16aeee36f815ddef
+  data.tar.gz: b42f74d46051e42289131b2fd1b0922c4e1f762d
 SHA512:
-  metadata.gz: 25b5e203c590af55fc5f1fe0fd6e62f2ca62e977306cd789cef78dbd0bf54bab6de192b9a60e8e6738b3c284eee1bb8b57256d70e3d96dcda1debda0ee3531e0
-  data.tar.gz: 70fa2db7c5201ea00a60e8c7d9614fb6cd2c57e0841b908709967589a8e1e94eeb029cb2525a2032256edca36efe8e5c95e14ec3dbb776037f36bd52786add9a
+  metadata.gz: f92654da489e2c7444bb2f8934702cfd69f39f06b004336e423d81e0511ac55cb2ebb6fa67219b1cffdf799d3f63e4780e6de8856ad6c5376581e6299273e607
+  data.tar.gz: 8ca6223922b06bf6bb5f16be6be950f604a8e4e1962e774af44be30f0e2c02be67431751b17f1c8b6b24502c646fcd2eda31a23706fa5c8753ae2aaf5dfa366b

data/.gitignore

@@ -21,6 +21,8 @@ log.txt
 videowriter_result.avi
 examples/contours/rotated-boxes-with-detected-bounding-rectangles.jpg
 Gemfile.lock
+.yardoc
 .RUBYLIBDIR.*
 .RUBYARCHDIR.*
+.bundle
 

data/.yardopts

@@ -0,0 +1,3 @@
+--load yard_extension.rb
+ext/opencv/*.cpp
+

data/Gemfile

@@ -4,5 +4,6 @@ group :development do
   gem "hoe"
   gem "hoe-gemspec"
   gem "rake-compiler"
+  gem "yard"
 end
 

data/Manifest.txt

@@ -1,4 +1,5 @@
 .gitignore
+.yardopts
 DEVELOPERS_NOTE.md
 Gemfile
 History.txt
@@ -34,12 +35,6 @@ examples/images/tiffany.jpg
 examples/inpaint.rb
 examples/match_kdtree.rb
 examples/match_template.rb
-examples/matching_to_many_images/matching_to_many_images.rb
-examples/matching_to_many_images/query.png
-examples/matching_to_many_images/train/1.png
-examples/matching_to_many_images/train/2.png
-examples/matching_to_many_images/train/3.png
-examples/matching_to_many_images/train/trainImages.txt
 examples/paint.rb
 examples/snake.rb
 ext/opencv/algorithm.cpp
@@ -56,8 +51,6 @@ ext/opencv/cvchain.cpp
 ext/opencv/cvchain.h
 ext/opencv/cvcircle32f.cpp
 ext/opencv/cvcircle32f.h
-ext/opencv/cvcondensation.cpp
-ext/opencv/cvcondensation.h
 ext/opencv/cvconnectedcomp.cpp
 ext/opencv/cvconnectedcomp.h
 ext/opencv/cvcontour.cpp
@@ -82,8 +75,6 @@ ext/opencv/cvline.cpp
 ext/opencv/cvline.h
 ext/opencv/cvmat.cpp
 ext/opencv/cvmat.h
-ext/opencv/cvmatnd.cpp
-ext/opencv/cvmatnd.h
 ext/opencv/cvmemstorage.cpp
 ext/opencv/cvmemstorage.h
 ext/opencv/cvmoments.cpp
@@ -106,8 +97,6 @@ ext/opencv/cvsize2d32f.cpp
 ext/opencv/cvsize2d32f.h
 ext/opencv/cvslice.cpp
 ext/opencv/cvslice.h
-ext/opencv/cvsparsemat.cpp
-ext/opencv/cvsparsemat.h
 ext/opencv/cvsurfparams.cpp
 ext/opencv/cvsurfparams.h
 ext/opencv/cvsurfpoint.cpp
@@ -148,7 +137,6 @@ ext/opencv/window.h
 images/CvMat_sobel.png
 images/CvMat_sub_rect.png
 images/CvSeq_relationmap.png
-images/face_detect_from_lena.jpg
 lib/opencv.rb
 lib/opencv/psyched_yaml.rb
 lib/opencv/version.rb
@@ -222,7 +210,6 @@ test/test_cvmat.rb
 test/test_cvmat_drawing.rb
 test/test_cvmat_dxt.rb
 test/test_cvmat_imageprocessing.rb
-test/test_cvmat_matching.rb
 test/test_cvmoments.rb
 test/test_cvpoint.rb
 test/test_cvpoint2d32f.rb
@@ -249,3 +236,4 @@ test/test_pointset.rb
 test/test_preliminary.rb
 test/test_trackbar.rb
 test/test_window.rb
+yard_extension.rb

data/README.md

@@ -3,7 +3,7 @@
 An OpenCV wrapper for Ruby.
 
 * Web site: <https://github.com/ruby-opencv/ruby-opencv>
-* Ruby 1.9.3, 2.0.0 and OpenCV 2.4.7 are supported.
+* Ruby 1.9.3, 2.0.0, 2.1.0 and OpenCV 2.4.8 are supported.
 
 ## Requirement
 

data/Rakefile

@@ -6,6 +6,9 @@ require 'hoe'
 require 'rake/extensiontask'
 require 'fileutils'
 require './lib/opencv/psyched_yaml'
+require 'yard'
+require 'yard/rake/yardoc_task'
+require './yard_extension'
 
 SO_FILE = 'opencv.so'
 
@@ -27,7 +30,7 @@ hoespec = Hoe.spec 'ruby-opencv' do |s|
   s.test_globs = ['test/test_*.rb']
   s.urls = ['https://github.com/ruby-opencv/ruby-opencv/']
 
-  s.extra_dev_deps << ['rake-compiler', '>= 0'] << ['hoe-gemspec']
+  s.extra_dev_deps << ['rake-compiler', '~> 0'] << ['hoe-gemspec', '~> 0']
 
   Rake::ExtensionTask.new('opencv', spec) do |ext|
     ext.lib_dir = 'lib'
@@ -87,4 +90,10 @@ task 'gem:precompile' => ['gem'] do
   FileUtils.rm_rf tmp_dir
 end
 
+# yard
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'ext/**/*.cpp']
+end
+
 # vim: syntax=ruby
+

data/examples/facerec/facerec_lbph.rb

@@ -97,7 +97,7 @@ model.set_double('threshold', 0.0);
 
 # Now the threshold of this model is set to 0.0. A prediction
 # now returns -1, as it's impossible to have a distance below it
-predicted_label = model.predict(test_sample)
+predicted_label, predicted_confidence = model.predict(test_sample)
 puts "Predicted class = #{predicted_label}"
 
 # Show some informations about the model, as there's no cool

data/ext/opencv/algorithm.cpp

@@ -252,8 +252,13 @@ rb_name(VALUE self)
 }
 
 void
-define_ruby_class()
+init_ruby_class()
 {
+#if 0
+  // For documentation using YARD
+  VALUE opencv = rb_define_module("OpenCV");
+#endif
+
   if (rb_klass)
     return;
   /* 

data/ext/opencv/algorithm.h

@@ -20,7 +20,7 @@ __NAMESPACE_BEGIN_ALGORITHM
 
 VALUE rb_class();
 
-void define_ruby_class();
+void init_ruby_class();
 
 __NAMESPACE_END_ALGORITM
 

data/ext/opencv/curve.cpp

@@ -11,7 +11,7 @@
 /*
  * Document-class: OpenCV::Curve
  *
- * Curve sequence.
+ * Curve sequence
  */
 __NAMESPACE_BEGIN_OPENCV
 __NAMESPACE_BEGIN_CURVE
@@ -24,27 +24,11 @@ rb_module()
   return module;
 }
 
-void
-define_ruby_module()
-{
-  if (module)
-    return;
-  /* 
-   * opencv = rb_define_module("OpenCV");
-   *
-   * note: this comment is used by rdoc.
-   */
-  VALUE opencv = rb_module_opencv();
-  module = rb_define_module_under(opencv, "Curve");
-  rb_define_method(module, "closed?", RUBY_METHOD_FUNC(rb_closed_q), 0);
-  rb_define_method(module, "convex?", RUBY_METHOD_FUNC(rb_convex_q), 0);
-  rb_define_method(module, "hole?", RUBY_METHOD_FUNC(rb_hole_q), 0);
-  rb_define_method(module, "simple?", RUBY_METHOD_FUNC(rb_simple_q), 0);
-  rb_define_method(module, "arc_length", RUBY_METHOD_FUNC(rb_arc_length), -1);
-}
-
 /*
- * If curve is closed, return true. Otherwise return false.
+ * If the curve is closed, return true. Otherwise return false.
+ * @overload closed?
+ * @return [Boolean] Closed or not
+ * @opencv_func CV_IS_SEQ_CLOSED
  */
 VALUE
 rb_closed_q(VALUE self)
@@ -53,7 +37,10 @@ rb_closed_q(VALUE self)
 }
 
 /*
- * If curve is convex, return true. Otherwise return false.
+ * If the curve is convex, return true. Otherwise return false.
+ * @overload convex?
+ * @return [Boolean] Convex or not
+ * @opencv_func CV_IS_SEQ_CONVEX
  */
 VALUE
 rb_convex_q(VALUE self)
@@ -62,7 +49,10 @@ rb_convex_q(VALUE self)
 }
 
 /*
- * If curve is hole(inner contour), return true. Otherwise return false.
+ * If the curve is hole(inner contour), return true. Otherwise return false.
+ * @overload hole?
+ * @return [Boolean] Hole or not
+ * @opencv_func CV_IS_SEQ_HOLE
  */
 VALUE
 rb_hole_q(VALUE self)
@@ -71,7 +61,10 @@ rb_hole_q(VALUE self)
 }
 
 /*
- * no idia.
+ * If the curve is simple, return true. Otherwise return false.
+ * @overload simple?
+ * @return [Boolean] Simple or not
+ * @opencv_func CV_IS_SEQ_SIMPLE
  */
 VALUE
 rb_simple_q(VALUE self)
@@ -80,15 +73,17 @@ rb_simple_q(VALUE self)
 }
 
 /*
- * call-seq:
- *   arc_length(<i>[slice = nil][,is_closed = nil]</i>) -> float
- *
- * Calculates contour perimeter or curve length.
- * <i>slice</i> is starting and ending points of the curve.
- * <i>is_closed</i> is indicates whether the curve is closed or not. There are 3 cases:
- * * is_closed = true  - the curve is assumed to be unclosed.
- * * is_closed = false - the curve is assumed to be closed.
- * * is_closed = nil (default) use self#close?
+ * Calculates length of a curve
+ * @overload arc_length(slice = nil, is_closed = nil)
+ *   @param slice [Range,CvSlice,nil] Starting and ending points of the curve.
+ *     By default, the whole curve length is calculated.
+ *   @param is_closed [Boolean,nil] Indicates whether the curve is closed or not.
+ *     There are 3 cases:
+ *     * is_closed = true  - the curve is assumed to be unclosed.
+ *     * is_closed = false - the curve is assumed to be closed.
+ *     * is_closed = nil (default) use self#closed?
+ * @return [Number] Length of the curve
+ * @opencv_func cvArcLength
  */
 VALUE
 rb_arc_length(int argc, VALUE *argv, VALUE self)
@@ -107,6 +102,26 @@ rb_arc_length(int argc, VALUE *argv, VALUE self)
   return rb_float_new(length);
 }
 
+void
+init_ruby_module()
+{
+#if 0
+  // For documentation using YARD
+  VALUE opencv = rb_define_module("OpenCV");
+#endif
+
+  if (module)
+    return;
+
+  VALUE opencv = rb_module_opencv();
+  module = rb_define_module_under(opencv, "Curve");
+  rb_define_method(module, "closed?", RUBY_METHOD_FUNC(rb_closed_q), 0);
+  rb_define_method(module, "convex?", RUBY_METHOD_FUNC(rb_convex_q), 0);
+  rb_define_method(module, "hole?", RUBY_METHOD_FUNC(rb_hole_q), 0);
+  rb_define_method(module, "simple?", RUBY_METHOD_FUNC(rb_simple_q), 0);
+  rb_define_method(module, "arc_length", RUBY_METHOD_FUNC(rb_arc_length), -1);
+}
+
 __NAMESPACE_END_CURVE
 __NAMESPACE_END_OPENCV
 

data/ext/opencv/curve.h

@@ -20,7 +20,7 @@ __NAMESPACE_BEGIN_CURVE
 
 VALUE rb_module();
 
-void define_ruby_module();
+void init_ruby_module();
 
 VALUE rb_closed_q(VALUE self);
 VALUE rb_convex_q(VALUE self);

data/ext/opencv/cvavgcomp.cpp

@@ -11,13 +11,7 @@
 /*
  * Document-class: OpenCV::CvAvgComp
  *
- * CvRect with parameter "neighbors".
- * CvHaarClassifierCascade#detect_object. 
- *
- *   typedef struct CvAvgComp {
- *     CvRect rect;
- *     int neighbors;
- *   }
+ * CvRect with parameter "neighbors"
  */
 __NAMESPACE_BEGIN_OPENCV
 __NAMESPACE_BEGIN_AVGCOMP
@@ -30,23 +24,6 @@ rb_class()
   return rb_klass;
 }
 
-void
-define_ruby_class()
-{
-  if (rb_klass)
-    return;
-  /* 
-   * opencv = rb_define_module("OpenCV");
-   * cvrect = rb_define_class_under(opencv, "CvRect", rb_cObject);
-   *
-   * note: this comment is used by rdoc.
-   */
-  VALUE opencv = rb_module_opencv(), cvrect = cCvRect::rb_class();
-  rb_klass = rb_define_class_under(opencv, "CvAvgComp", cvrect);
-  rb_define_alloc_func(rb_klass, rb_allocate);
-  rb_define_method(rb_klass, "neighbors", RUBY_METHOD_FUNC(rb_neighbors), 0);
-}
-
 VALUE
 rb_allocate(VALUE klass)
 {
@@ -55,7 +32,9 @@ rb_allocate(VALUE klass)
 }
 
 /*
- * Return neighbors.
+ * Return neighbors
+ * @overload neighbors
+ * @return [Integer] neighbors
  */
 VALUE
 rb_neighbors(VALUE self)
@@ -63,5 +42,23 @@ rb_neighbors(VALUE self)
   return INT2NUM(CVAVGCOMP(self)->neighbors);
 }
 
+void
+init_ruby_class()
+{
+#if 0
+  // For documentation using YARD
+  VALUE opencv = rb_define_module("OpenCV");
+  VALUE cvrect = rb_define_class_under(opencv, "CvRect", rb_cObject);
+#endif
+
+  if (rb_klass)
+    return;
+
+  VALUE opencv = rb_module_opencv(), cvrect = cCvRect::rb_class();
+  rb_klass = rb_define_class_under(opencv, "CvAvgComp", cvrect);
+  rb_define_alloc_func(rb_klass, rb_allocate);
+  rb_define_method(rb_klass, "neighbors", RUBY_METHOD_FUNC(rb_neighbors), 0);
+}
+
 __NAMESPACE_END_AVGCOMP
 __NAMESPACE_END_OPENCV

data/ext/opencv/cvavgcomp.h

@@ -20,7 +20,7 @@ __NAMESPACE_BEGIN_AVGCOMP
 
 VALUE rb_class();
 
-void define_ruby_class();
+void init_ruby_class();
 
 VALUE rb_allocate(VALUE klass);
 VALUE rb_neighbors(VALUE self);

data/ext/opencv/cvbox2d.cpp

@@ -11,12 +11,7 @@
 /*
  * Document-class: OpenCV::CvBox2D
  *
- * C structure is here.
- *   typdef struct CvBox2D {
- *     CvPoint2D32f center; // center of the box.
- *     CvSize2D32f size;    // box width and length
- *     float angle;         // angle between the horizonal axis and the first side (i.e length) in radians
- *   } CvBox2D;
+ * Stores coordinates of a rotated rectangle.
  */
 __NAMESPACE_BEGIN_OPENCV
 __NAMESPACE_BEGIN_CVBOX2D
@@ -29,29 +24,6 @@ rb_class()
   return rb_klass;
 }
 
-void
-define_ruby_class()
-{
-  if (rb_klass)
-    return;
-  /* 
-   * opencv = rb_define_module("OpenCV");
-   * 
-   * note: this comment is used by rdoc.
-   */
-  VALUE opencv = rb_module_opencv();
-  rb_klass = rb_define_class_under(opencv, "CvBox2D", rb_cObject);
-  rb_define_alloc_func(rb_klass, rb_allocate);
-  rb_define_private_method(rb_klass, "initialize", RUBY_METHOD_FUNC(rb_initialize), -1);
-  rb_define_method(rb_klass, "center", RUBY_METHOD_FUNC(rb_center), 0);
-  rb_define_method(rb_klass, "center=", RUBY_METHOD_FUNC(rb_set_center), 1);
-  rb_define_method(rb_klass, "size", RUBY_METHOD_FUNC(rb_size), 0);
-  rb_define_method(rb_klass, "size=", RUBY_METHOD_FUNC(rb_set_size), 1);
-  rb_define_method(rb_klass, "angle", RUBY_METHOD_FUNC(rb_angle), 0);
-  rb_define_method(rb_klass, "angle=", RUBY_METHOD_FUNC(rb_set_angle), 1);
-  rb_define_method(rb_klass, "points", RUBY_METHOD_FUNC(rb_points), 0);
-}
-
 VALUE
 rb_allocate(VALUE klass)
 {
@@ -59,11 +31,13 @@ rb_allocate(VALUE klass)
   return Data_Make_Struct(klass, CvBox2D, 0, -1, ptr);
 }
 
-/* 
- * call-seq:
- *   CvBox2D.new(<i>[center][, size][, angle]</i>) -> cvbox2d
- *
+/*
  * Create a box
+ * @overload new(center=nil, size=nil, angle=nil)
+ *   @param center [CvPoint2D32f,nil] Center of the box
+ *   @param size [CvSize,nil] Size of the box
+ *   @param angle [Number,nil] Angle between the horizontal axis and the first side in degrees
+ * @return [CvBox2D] New box
  */
 VALUE
 rb_initialize(int argc, VALUE *argv, VALUE self)
@@ -84,9 +58,9 @@ rb_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   center -> cvpoint2d32f
- * Return center point of box as CvPoint2D32f.
+ * Returns center point of the box
+ * @overload center
+ * @return [CvPoint2D32f] Center of the box
  */
 VALUE
 rb_center(VALUE self)
@@ -95,10 +69,10 @@ rb_center(VALUE self)
 }
 
 /*
- * call-seq:
- *   center = <i>value</i>
- *
- * Set center to <i>value</i>
+ * Set center point of the box
+ * @overload center=value
+ *   @param value [CvPoint2D32f] Center of the box
+ * @return [CvBox2D] self
  */
 VALUE
 rb_set_center(VALUE self, VALUE value)
@@ -108,9 +82,9 @@ rb_set_center(VALUE self, VALUE value)
 }
 
 /*
- * call-seq:
- *   size -> cvsize2d32f
- * Return size of box as CvSize2D32f.
+ * Returns size of the box
+ * @overload size
+ * @return [CvSize2D32f] Size of the box
  */
 VALUE
 rb_size(VALUE self)
@@ -119,10 +93,10 @@ rb_size(VALUE self)
 }
 
 /*
- * call-seq:
- *   size = <i>value</i>
- *
- * Set size to <i>value</i>
+ * Set size of the box
+ * @overload size=value
+ *   @param value [CvSize2D32f] Size of the box
+ * @return [CvBox2D] self
  */
 VALUE
 rb_set_size(VALUE self, VALUE value)
@@ -132,10 +106,9 @@ rb_set_size(VALUE self, VALUE value)
 }
 
 /*
- * call-seq:
- *   angle -> float
- *
- * Return angle of box as Float.
+ * Returns angle of the box
+ * @overload angle
+ * @return [Float] Angle of the box
  */
 VALUE
 rb_angle(VALUE self)
@@ -144,10 +117,10 @@ rb_angle(VALUE self)
 }
 
 /*
- * call-seq:
- *   angle = <i>value</i>
- *
- * Set angle to <i>value</i>
+ * Set angle of the box
+ * @overload angle=value
+ *   @param value [Number] Angle of the box
+ * @return [CvBox2D] self
  */
 VALUE
 rb_set_angle(VALUE self, VALUE value)
@@ -157,9 +130,10 @@ rb_set_angle(VALUE self, VALUE value)
 }
 
 /*
- * call-seq:
- *   points -> array(include cvpoint2d32f)
- * Find box vertices. Return Array contain 4 CvPoint2D32f.
+ * Find box vertices
+ * @overload points
+ * @return [Array<CvPoint2D32f>] Vertices of the box
+ * @opencv_func cvBoxPoints
  */
 VALUE
 rb_points(VALUE self)
@@ -193,5 +167,29 @@ new_object(CvBox2D box)
   return object;
 }
 
+void
+init_ruby_class()
+{
+#if 0
+  // For documentation using YARD
+  VALUE opencv = rb_define_module("OpenCV");
+#endif
+
+  if (rb_klass)
+    return;
+
+  VALUE opencv = rb_module_opencv();
+  rb_klass = rb_define_class_under(opencv, "CvBox2D", rb_cObject);
+  rb_define_alloc_func(rb_klass, rb_allocate);
+  rb_define_method(rb_klass, "initialize", RUBY_METHOD_FUNC(rb_initialize), -1);
+  rb_define_method(rb_klass, "center", RUBY_METHOD_FUNC(rb_center), 0);
+  rb_define_method(rb_klass, "center=", RUBY_METHOD_FUNC(rb_set_center), 1);
+  rb_define_method(rb_klass, "size", RUBY_METHOD_FUNC(rb_size), 0);
+  rb_define_method(rb_klass, "size=", RUBY_METHOD_FUNC(rb_set_size), 1);
+  rb_define_method(rb_klass, "angle", RUBY_METHOD_FUNC(rb_angle), 0);
+  rb_define_method(rb_klass, "angle=", RUBY_METHOD_FUNC(rb_set_angle), 1);
+  rb_define_method(rb_klass, "points", RUBY_METHOD_FUNC(rb_points), 0);
+}
+
 __NAMESPACE_END_CVBOX2D
 __NAMESPACE_END_OPENCV