ruby-opencv 0.0.11 → 0.0.12.pre

data/ext/opencv/cvcapture.h

@@ -21,7 +21,7 @@ __NAMESPACE_BEGIN_CVCAPTURE
 
 VALUE rb_class();
 
-void define_ruby_class();
+void init_ruby_class();
 
 void cvcapture_free(void *ptr);
 VALUE rb_open(int argc, VALUE *argv, VALUE klass);

data/ext/opencv/cvchain.cpp

@@ -11,8 +11,7 @@
 /*
  * Document-class: OpenCV::CvChain
  *
- * Freeman chain code.
- * CvMat#find_contours(:method => :code)
+ * Freeman chain code
  */
 __NAMESPACE_BEGIN_OPENCV
 __NAMESPACE_BEGIN_CVCHAIN
@@ -31,45 +30,19 @@ rb_class()
   return rb_klass;
 }
 
-void
-define_ruby_class()
-{
-  if (rb_klass)
-    return;
-  /* 
-   * opencv = rb_define_module("OpenCV");
-   * cvseq = rb_define_class_under(opencv, "CvSeq");
-   * curve = rb_define_module_under(opencv, "Curve");
-   * note: this comment is used by rdoc.
-   */
-  VALUE opencv = rb_module_opencv();
-  VALUE cvseq = cCvSeq::rb_class();
-  VALUE curve = mCurve::rb_module();
-
-  rb_klass = rb_define_class_under(opencv, "CvChain", cvseq);
-  rb_include_module(rb_klass, curve);
-  VALUE approx_chain_option = rb_hash_new();
-  rb_define_const(rb_klass, "APPROX_CHAIN_OPTION", approx_chain_option); 
-  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("method")), ID2SYM(rb_intern("approx_simple")));
-  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("parameter")), rb_float_new(0));
-  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("minimal_perimeter")), INT2FIX(0));
-  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("recursive")), Qfalse);
-
-  rb_define_private_method(rb_klass, "initialize", RUBY_METHOD_FUNC(rb_initialize), -1);
-  rb_define_method(rb_klass, "origin", RUBY_METHOD_FUNC(rb_origin), 0);
-  rb_define_method(rb_klass, "origin=", RUBY_METHOD_FUNC(rb_set_origin), 1);
-  rb_define_method(rb_klass, "codes", RUBY_METHOD_FUNC(rb_codes), 0);
-  rb_define_method(rb_klass, "points", RUBY_METHOD_FUNC(rb_points), 0);
-  rb_define_method(rb_klass, "approx_chains", RUBY_METHOD_FUNC(rb_approx_chains), -1);
-  rb_define_alias(rb_klass, "approx", "approx_chains");
-}
-
 VALUE
 rb_allocate(VALUE klass)
 {
   return Data_Wrap_Struct(klass, mark_root_object, unregister_object, NULL);
 }
 
+/*
+ * Create a new chain code
+ * @overload new(storage=nil)
+ *   @param storage [CvMemStorage,nil] Sequence location (If storage is nil, allocates a new storage automatically)
+ * @return [CvChain] New CvChain instance
+ * @opencv_func cvCreateSeq (seq_flags=CV_SEQ_ELTYPE_CODE)
+ */
 VALUE
 rb_initialize(int argc, VALUE *argv, VALUE self)
 {
@@ -96,10 +69,9 @@ rb_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   origin -> cvpoint
- *
- * Return Freeman chain code origin.
+ * Returns Freeman chain code origin
+ * @overload origin
+ * @return [CvPoint] Origin of the chain code
  */
 VALUE
 rb_origin(VALUE self)
@@ -108,10 +80,10 @@ rb_origin(VALUE self)
 }
 
 /*
- * call-seq:
- *   origin = point -> self
- *
- * Set Freeman chain code origin.
+ * Set Freeman chain code origin
+ * @overload origin=value
+ *   @param value [CvPoint] Origin of the chain code
+ * @return [CvChain] self
  */
 VALUE
 rb_set_origin(VALUE self, VALUE origin)
@@ -121,10 +93,11 @@ rb_set_origin(VALUE self, VALUE origin)
 }
 
 /*
- * call-seq:
- *   codes -> array(contain fixnum)
- *
- * Return Freeman chain codes.
+ * Returns the chain codes
+ * @overload codes
+ * @return [Array<Fixnum>] Chain codes
+ * @opencv_func cvStartReadChainPoints
+ * @opencv_func CV_READ_SEQ_ELEM
  */
 VALUE
 rb_codes(VALUE self)
@@ -147,10 +120,11 @@ rb_codes(VALUE self)
 }
 
 /*
- * call-seq:
- *   points -> array(contain cvpoint)
- *
- * Return points that represent by Freeman chain code.
+ * Returns the points of the chain codes
+ * @overload points
+ * @return [Array<CvPoint>] Points of the chain codes
+ * @opencv_func cvStartReadChainPoints
+ * @opencv_func CV_READ_CHAIN_POINT
  */
 VALUE
 rb_points(VALUE self)
@@ -174,26 +148,17 @@ rb_points(VALUE self)
 }
 
 /*
- * call-seq:
- *   approx_chains(<i>[approx_chain_option]</i>) -> cvcontour
- *
- * Approximates Freeman chain(s) with polygonal curve.
- * <i>approx_chain_option</i> should be Hash include these keys.
- *   :method - Approximation method.
- *      :approx_none - translate all the points from the chain code into points;
- *      :approx_simple(default) - compress horizontal, vertical, and diagonal segments, that is,
- *                                the function leaves only their ending points.
- *      :approx_tc89_l1
- *      :approx_tc89_kcos - apply one of the flavors of Teh-Chin chain approximation algorithm.
- *      If set the difference between the current pixel and seed pixel is considered,
- *      otherwise difference between neighbor pixels is considered (the range is floating).
- *   :parameter - Method parameter (not used now).
- *   :minimal_perimeter (default 0)
- *      Approximates only those contours whose perimeters are not less than minimal_perimeter. Other chains are removed from the resulting structure.
- *   :recursive (default false)
- *      If not nil or false, the function approximates all chains that access can be obtained to
- *      from self by h_next or v_next links. If 0, the single chain is approximated.
- *
+ * Approximates Freeman chains with a polygonal curve
+ * @overload approx_chain(options)
+ *   @param options [Hash] Parameters
+ *   @option options [Symbol] :method Approximation method (see the description of CvMat#find_contours)
+ *   @option options [Number] :minimal_perimeter Approximates only those contours whose perimeters
+ *     are not less than minimal_perimeter. Other chains are removed from the resulting structure.
+ *   @option options [Boolean] :recursive Recursion flag. If it is true, the function approximates
+ *     all chains that can be obtained from chain by using the h_next or v_next links.
+ *     Otherwise, the single input chain is approximated.
+ * @return [CvSeq<CvPoint>] Polygonal curve
+ * @opencv_func cvApproxChains
  */
 VALUE
 rb_approx_chains(int argc, VALUE *argv, VALUE self)
@@ -229,5 +194,40 @@ new_object()
   return cCvSeq::new_sequence(cCvChain::rb_class(), seq, T_FIXNUM, storage);
 }
 
+void
+init_ruby_class()
+{
+#if 0
+  // For documentation using YARD
+  VALUE opencv = rb_define_module("OpenCV");
+  VALUE cvseq = rb_define_class_under(opencv, "CvSeq");
+  VALUE curve = rb_define_module_under(opencv, "Curve");
+#endif
+
+  if (rb_klass)
+    return;
+
+  VALUE opencv = rb_module_opencv();
+  VALUE cvseq = cCvSeq::rb_class();
+  VALUE curve = mCurve::rb_module();
+
+  rb_klass = rb_define_class_under(opencv, "CvChain", cvseq);
+  rb_include_module(rb_klass, curve);
+  VALUE approx_chain_option = rb_hash_new();
+  rb_define_const(rb_klass, "APPROX_CHAIN_OPTION", approx_chain_option); 
+  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("method")), ID2SYM(rb_intern("approx_simple")));
+  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("parameter")), rb_float_new(0));
+  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("minimal_perimeter")), INT2FIX(0));
+  rb_hash_aset(approx_chain_option, ID2SYM(rb_intern("recursive")), Qfalse);
+
+  rb_define_method(rb_klass, "initialize", RUBY_METHOD_FUNC(rb_initialize), -1);
+  rb_define_method(rb_klass, "origin", RUBY_METHOD_FUNC(rb_origin), 0);
+  rb_define_method(rb_klass, "origin=", RUBY_METHOD_FUNC(rb_set_origin), 1);
+  rb_define_method(rb_klass, "codes", RUBY_METHOD_FUNC(rb_codes), 0);
+  rb_define_method(rb_klass, "points", RUBY_METHOD_FUNC(rb_points), 0);
+  rb_define_method(rb_klass, "approx_chains", RUBY_METHOD_FUNC(rb_approx_chains), -1);
+  rb_define_alias(rb_klass, "approx", "approx_chains");
+}
+
 __NAMESPACE_END_CVCHAIN
 __NAMESPACE_END_OPENCV

data/ext/opencv/cvchain.h

@@ -19,7 +19,7 @@ __NAMESPACE_BEGIN_CVCHAIN
 
 VALUE rb_class();
 
-void define_ruby_class();
+void init_ruby_class();
 
 VALUE rb_allocate(VALUE klass);
 

data/ext/opencv/cvcircle32f.cpp

@@ -26,27 +26,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, "CvCircle32f", rb_cObject);
-  rb_define_alloc_func(rb_klass, rb_allocate);
-  rb_define_method(rb_klass, "center", RUBY_METHOD_FUNC(rb_center), 0);
-  rb_define_method(rb_klass, "radius", RUBY_METHOD_FUNC(rb_radius), 0);
-  rb_define_method(rb_klass, "[]", RUBY_METHOD_FUNC(rb_aref), 1);
-  rb_define_method(rb_klass, "to_ary", RUBY_METHOD_FUNC(rb_to_ary), 0);
-  rb_define_alias(rb_klass, "to_a", "to_ary");
-}
-
 VALUE
 rb_allocate(VALUE klass)
 {
@@ -55,7 +34,9 @@ rb_allocate(VALUE klass)
 }
 
 /*
- * Return parameter on center.
+ * Returns center point of the circle
+ * @overload center
+ * @return [CvPoint2D32f] Center point of the circle
  */
 VALUE
 rb_center(VALUE self)
@@ -64,7 +45,9 @@ rb_center(VALUE self)
 }
 
 /*
- * Return parameter on radius.
+ * Returns radius of the circle
+ * @overload radius
+ * @return [Number] Radius of the circle
  */
 VALUE
 rb_radius(VALUE self)
@@ -73,10 +56,10 @@ rb_radius(VALUE self)
 }
 
 /*
- * call-seq:
- *   [<i>index</i>]
- *
- * Return value of <i>index</i> dimension.
+ * Accesses to parameters of the circle by array-like interface ([X-coordinate, Y-coordinate, radius])
+ * @overload []
+ *   @param index [Integer] Index
+ * @return [Number] X-coordinate, Y-coordinate or radius of the circle
  */
 VALUE
 rb_aref(VALUE self, VALUE index)
@@ -98,6 +81,11 @@ rb_aref(VALUE self, VALUE index)
   return Qnil;
 }
 
+/*
+ * Returns parameters of the circle as an array which contains [center<CvPoint2D32f>, radius<Number>]
+ * @overload to_ary
+ * @return [Array<CvPoint2D32f,Number>] An array which contains [center, radius]
+ */
 VALUE
 rb_to_ary(VALUE self)
 {
@@ -112,5 +100,27 @@ new_object(CvCircle32f circle32f)
   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, "CvCircle32f", rb_cObject);
+  rb_define_alloc_func(rb_klass, rb_allocate);
+  rb_define_method(rb_klass, "center", RUBY_METHOD_FUNC(rb_center), 0);
+  rb_define_method(rb_klass, "radius", RUBY_METHOD_FUNC(rb_radius), 0);
+  rb_define_method(rb_klass, "[]", RUBY_METHOD_FUNC(rb_aref), 1);
+  rb_define_method(rb_klass, "to_ary", RUBY_METHOD_FUNC(rb_to_ary), 0);
+  rb_define_alias(rb_klass, "to_a", "to_ary");
+}
+
 __NAMESPACE_END_CVCIRCLE32F
 __NAMESPACE_END_OPENCV

data/ext/opencv/cvcircle32f.h

@@ -26,7 +26,7 @@ __NAMESPACE_BEGIN_CVCIRCLE32F
 
 VALUE rb_class();
 
-void define_ruby_class();
+void init_ruby_class();
 
 VALUE rb_allocate(VALUE klass);
 VALUE rb_initialize(int argc, VALUE *argv, VALUE self);

data/ext/opencv/cvconnectedcomp.cpp

@@ -10,17 +10,9 @@
 #include "cvconnectedcomp.h"
 /*
  * Document-class: OpenCV::CvConnectedComp
- *
+ * 
+ * Connected component
  * see CvMat#flood_fill
- *
- * C structure is here.
- *   typedef struct CvConnectedComp
- *   {
- *     double area;    
- *     CvScalar value; 
- *     CvRect rect;    
- *     CvSeq* contour;
- *   } CvConnectedComp;
  */
 __NAMESPACE_BEGIN_OPENCV
 __NAMESPACE_BEGIN_CVCONNECTEDCOMP
@@ -33,28 +25,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, "CvConnectedComp", 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, "area", RUBY_METHOD_FUNC(rb_area), 0);
-  rb_define_method(rb_klass, "value", RUBY_METHOD_FUNC(rb_value), 0);
-  rb_define_method(rb_klass, "rect", RUBY_METHOD_FUNC(rb_rect), 0);
-  rb_define_method(rb_klass, "rect=", RUBY_METHOD_FUNC(rb_set_rect), 1);
-  rb_define_method(rb_klass, "contour", RUBY_METHOD_FUNC(rb_contour), 0);
-}
-
 VALUE
 rb_allocate(VALUE klass)
 {
@@ -62,6 +32,15 @@ rb_allocate(VALUE klass)
   return Data_Make_Struct(klass, CvConnectedComp, 0, -1, ptr);
 }
 
+/*
+ * Constructor
+ * @overload new(area = nil, value = nil, rect = nil, contour = nil)
+ *   @param area [Number] Area of the segmented component
+ *   @param value [CvScalar] Average color of the connected component
+ *   @param rect [CvRect] ROI of the segmented component
+ *   @param contour [CvSeq] Optional component boundary
+ * @return [CvConnectedComp] self
+ */
 VALUE
 rb_initialize(int argc, VALUE *argv, VALUE self)
 {
@@ -80,7 +59,9 @@ rb_initialize(int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Return area of connected component.
+ * Returns area of connected component
+ * @overload area
+ * @return [Number] Area of the connected component
  */
 VALUE
 rb_area(VALUE self)
@@ -90,6 +71,8 @@ rb_area(VALUE self)
 
 /*
  * Return average color of the connected component.
+ * @overload value
+ * @return [CvScalar] Average color of the connected component
  */
 VALUE
 rb_value(VALUE self)
@@ -98,7 +81,9 @@ rb_value(VALUE self)
 }
 
 /*
- * Return ROI of the component.
+ * Return ROI of the segmented component
+ * @overload rect
+ * @return [CvRect] ROI of the segmented component
  */
 VALUE
 rb_rect(VALUE self)
@@ -107,7 +92,10 @@ rb_rect(VALUE self)
 }
 
 /*
- * Set ROI of the component.
+ * Set ROI of the segmented component
+ * @overload rect=value
+ *   @param value [CvRect] ROI to set
+ * @return [CvRect] ROI of the segmented component
  */
 VALUE
 rb_set_rect(VALUE self, VALUE rect)
@@ -117,7 +105,9 @@ rb_set_rect(VALUE self, VALUE rect)
 }
 
 /*
- * Return optional component boundary
+ * Returns optional component boundary
+ * @overload contour
+ * @return [CvContour] Optional component boundary
  */
 VALUE
 rb_contour(VALUE self)
@@ -139,5 +129,28 @@ new_object(CvConnectedComp comp)
   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, "CvConnectedComp", 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, "area", RUBY_METHOD_FUNC(rb_area), 0);
+  rb_define_method(rb_klass, "value", RUBY_METHOD_FUNC(rb_value), 0);
+  rb_define_method(rb_klass, "rect", RUBY_METHOD_FUNC(rb_rect), 0);
+  rb_define_method(rb_klass, "rect=", RUBY_METHOD_FUNC(rb_set_rect), 1);
+  rb_define_method(rb_klass, "contour", RUBY_METHOD_FUNC(rb_contour), 0);
+}
+
 __NAMESPACE_END_CVCONNECTEDCOMP
 __NAMESPACE_END_OPENCV