ruby_marks 0.2.7 → 0.2.8

data/README.md

@@ -162,8 +162,7 @@ flagged_document = recognizer.flag_all_marks
 flagged_document.write(temp_filename)
 ```  
 
-Will return the image below with recognized clock marks in green, the clock_marks_scan_x line in blue and
-each mark position in a red cross:
+Will return the image below:
 
 [![Flagged Document Example](https://raw.github.com/andrerpbts/ruby_marks/master/assets/sheet_demo2_flagged.png)](https://github.com/andrerpbts/ruby_marks/blob/master/assets/sheet_demo2_flagged.png)
 
@@ -252,7 +251,7 @@ config.threshold_level = 60
 # Sets a timeout in seconds, to break long time scans.   
 # The default value is 0 (zero) and means there's no timeout. Any value will quit the scan and raise timed_out_watcher
 
-config.scan_timeou = 0  
+config.scan_timeout = 0  
 ```
 
 ### Expected lines
@@ -265,6 +264,22 @@ config.scan_timeou = 0
 config.default_expected_lines = 20
 ```
 
+
+### Default blocks sizes tolerances
+
+```ruby
+# Defines the tolerance in width and height of the group blocks (in pixels) to compare with de expected block size.
+# This tolerance is intended to make the scan recognizes the correct whole group. The scanned area + this tolerance 
+# should be greater than the expected sizes of the block, in order to consider it. 
+# In small size groups, you should reduce this parameter in order to don't capture weong groups positions, such a 
+# not marked bubble as a group, for example.
+# The default values is 100 for both width and height, and should be adjusted for your documents. 
+
+config.default_block_width_tolerance = 100
+config.default_block_height_tolerance = 100
+```
+
+
 ### Default mark sizes
 
 ```ruby
@@ -280,8 +295,8 @@ config.default_mark_height = 20
 ### Default mark sizes tolerances
 
 ```ruby
-# Defines the tolerance in width and height of the marks (in pixels). With the the mark size, if the recognized 
-# mark exceeds or stricts those values, it will be ignored.
+# Defines the tolerance in width and height of the marks (in pixels). With default_mark_width and default_mark_width
+# size, if the recognized mark exceeds or stricts those values, it will be ignored.
 # The default values is 4 for both width and height. 
 
 config.default_mark_width_tolerance = 4
@@ -321,16 +336,6 @@ config.default_marks_options = %w{A B C D E}
 config.default_distance_between_marks = 25
 ```
 
-###  Adjust bnconsistent bubbles
-  
-```ruby
-# If true, it will perform an analysis in each group in order to see if there's more or less than expected bubbles, 
-# an will try to remove or add these inconsistent marks.
-# The default value is true
-
-config.adjust_inconsistent_bubbles = true
-```
-
 
 Group Configuration Options
 ---------------------------
@@ -346,6 +351,15 @@ when defining a group. So:
 group.expected_coordinates = {x1: 145, y1: 780, x2: 270, y2: 1290}
 ```
 
+### Block sizes tolerances
+
+```ruby
+# It overwrites the default_block_width_tolerance and default_block_height_tolerance values for the group you configure it. 
+
+group.block_width_tolerance  = RubyMarks.default_block_width_tolerance
+group.block_height_tolerance = RubyMarks.default_block_height_tolerance
+```
+
 ### Mark sizes
 
 ```ruby
@@ -355,6 +369,15 @@ group.mark_width  = RubyMarks.default_mark_width
 group.mark_height = RubyMarks.default_mark_height
 ```
 
+### Mark sizes tolerances
+
+```ruby
+# It overwrites the default_mark_width_tolerance and default_mark_height_tolerance values for the group you configure it. 
+
+group.mark_width_tolerance  = RubyMarks.default_mark_width_tolerance
+group.mark_height_tolerance = RubyMarks.default_mark_height_tolerance
+```
+
 ### Marks options
 
 ```ruby

data/lib/ruby_marks/config.rb

@@ -6,8 +6,8 @@ module RubyMarks
     attr_accessor :intensity_percentual, :edge_level, :default_marks_options, :threshold_level, 
                   :default_mark_width, :default_mark_height, :scan_timeout,
                   :default_mark_width_tolerance, :default_mark_height_tolerance,
-                  :default_distance_between_marks, :adjust_inconsistent_bubbles,
-                  :default_expected_lines
+                  :default_distance_between_marks, :default_expected_lines,
+                  :default_block_width_tolerance, :default_block_height_tolerance
 
     
     def initialize(recognizer)
@@ -16,10 +16,11 @@ module RubyMarks
       @edge_level = RubyMarks.edge_level
       @scan_timeout = RubyMarks.scan_timeout
 
-      @adjust_inconsistent_bubbles  = RubyMarks.adjust_inconsistent_bubbles
-
       @intensity_percentual = RubyMarks.intensity_percentual
       
+      @default_block_width_tolerance  = RubyMarks.default_block_width_tolerance
+      @default_block_height_tolerance = RubyMarks.default_block_height_tolerance
+
       @default_mark_width  = RubyMarks.default_mark_width
       @default_mark_height = RubyMarks.default_mark_height
 

data/lib/ruby_marks/group.rb

@@ -4,12 +4,16 @@ module RubyMarks
   class Group
     attr_reader   :label, :recognizer
     attr_accessor :mark_width, :mark_height, :marks_options, :coordinates, :expected_coordinates,
-                  :mark_width_tolerance, :mark_height_tolerance, :marks, :distance_between_marks
+                  :mark_width_tolerance, :mark_height_tolerance, :marks, :distance_between_marks,
+                  :block_width_tolerance, :block_height_tolerance
 
     def initialize(label, recognizer)
       @label = label
       @recognizer = recognizer
 
+      @block_width_tolerance  = @recognizer.config.default_block_width_tolerance
+      @block_height_tolerance = @recognizer.config.default_block_height_tolerance
+
       @mark_width  = @recognizer.config.default_mark_width
       @mark_height = @recognizer.config.default_mark_height
 

data/lib/ruby_marks/recognizer.rb

@@ -128,7 +128,7 @@ module RubyMarks
         line = 0
         group_center = RubyMarks::ImageUtils.image_center(group.expected_coordinates)
 
-        block = find_block_marks(file_str, group_center[:x], group_center[:y], group.expected_coordinates)
+        block = find_block_marks(file_str, group_center[:x], group_center[:y], group)
         if block
           group.coordinates = {x1: block[:x1], x2: block[:x2], y1: block[:y1], y2: block[:y2]}
          
@@ -259,7 +259,8 @@ module RubyMarks
     end
 
 
-    def find_block_marks(image, x, y, expected_coordinates)
+    def find_block_marks(image, x, y, group)
+      expected_coordinates = group.expected_coordinates
       found_blocks = []
       expected_width  = RubyMarks::ImageUtils.calc_width(expected_coordinates[:x1], expected_coordinates[:x2])
       expected_height = RubyMarks::ImageUtils.calc_height(expected_coordinates[:y1], expected_coordinates[:y2]) 
@@ -274,8 +275,8 @@ module RubyMarks
             block[:width]  = RubyMarks::ImageUtils.calc_width(block[:x1], block[:x2]) 
             block[:height] = RubyMarks::ImageUtils.calc_height(block[:y1], block[:y2])                       
 
-            block_width_with_tolerance  = block[:width]  + 100
-            block_height_with_tolerance = block[:height] + 100
+            block_width_with_tolerance  = block[:width]  + group.block_width_tolerance
+            block_height_with_tolerance = block[:height] + group.block_height_tolerance
 
 
             return block if block_width_with_tolerance >= expected_width && 

data/lib/ruby_marks/version.rb

@@ -1,3 +1,3 @@
 module RubyMarks
-  VERSION = "0.2.7".freeze
+  VERSION = "0.2.8".freeze
 end

data/lib/ruby_marks.rb

@@ -15,8 +15,11 @@ module RubyMarks
   mattr_accessor :scan_timeout
   @@scan_timeout = 0
 
-  mattr_accessor :adjust_inconsistent_bubbles
-  @@adjust_inconsistent_bubbles = true
+  mattr_accessor :default_block_width_tolerance
+  @@default_block_width_tolerance = 100
+
+  mattr_accessor :default_block_height_tolerance
+  @@default_block_height_tolerance = 100
 
   mattr_accessor :default_mark_width_tolerance
   @@default_mark_width_tolerance = 4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_marks
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
   prerelease: 
 platform: ruby
 authors:
@@ -37,14 +37,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/ruby_marks/group.rb
-- lib/ruby_marks/watcher.rb
 - lib/ruby_marks/config.rb
-- lib/ruby_marks/version.rb
-- lib/ruby_marks/recognizer.rb
-- lib/ruby_marks/support.rb
+- lib/ruby_marks/group.rb
 - lib/ruby_marks/image_utils.rb
 - lib/ruby_marks/mark.rb
+- lib/ruby_marks/recognizer.rb
+- lib/ruby_marks/support.rb
+- lib/ruby_marks/version.rb
+- lib/ruby_marks/watcher.rb
 - lib/ruby_marks.rb
 - test/ruby_marks/image_utils_test.rb
 - test/ruby_marks/recognizer_test.rb