technical_graph 0.3.2 → 0.4.0

data/DOCUMENTATION.md

@@ -2,6 +2,8 @@
 
 Options Hash
 
+    options[:drawer_class] = :rasem (default) or :rmagick
+
 Default ranges:
 
     options[:x_min]
@@ -38,6 +40,13 @@ Labels has truncate string to define precision. Default it is "%.2f".
 
     options[:truncate_string] = "%.2f"
 
+Draw axis labels, and labels for zero axis
+
+    options[:axis_value_and_param_labels] = true
+    options[:axis_zero_labels] = true
+
+
+
 Graph image size:
 
     options[:width]
@@ -49,13 +58,13 @@ Possible #RRGGBB or color names (ex. 'white').
 
     options[:background_color] - background color of image
     options[:background_hatch_color] - background hatch color
-    options[:axis_color] - color of axis
+    options[:axis_color] - color of axis, default #000000
 
 Anti-aliasing:
 
-    options[:axis_antialias] - use anti-aliasing for axis, default false
-    options[:layers_antialias] - use anti-aliasing for data layers, default false, can be override using layer option
-    options[:font_antialias] - use anti-aliasing for all fonts, default false
+    options[:antialias] - draw axis using antialias
+    # options[:layers_antialias] - use anti-aliasing for data layers, default false, can be override using layer option
+    # options[:font_antialias] - use anti-aliasing for all fonts, default false
 
 Font size:
 
@@ -91,3 +100,4 @@ Layer options Hash
     layer_options[:noise_removal] - enable removal of noises/peaks, default false
     layer_options[:noise_removal_level] - tolerance level, higher - less points will be removes, default 3
     layer_options[:noise_removal_window_size] - how many near values check for determining what is noise, default 10
+    layer_options[:perform_parameter_uniq] - it takes some time and rarely usable, so it is turned off by default

data/DOCUMENTATION.textile

@@ -359,9 +359,76 @@ file_name = 'samples/readme/08b_truncate_string.png'
 !https://github.com/akwiatkowski/technical_graph/raw/master/samples/readme/08b_truncate_string.png((08b) displaying float numbers)!
 
 
+
+
+
+
+h2. Graph image size
+
+p. It would be very silly if this library had hard coded image size. You can change it using options[:width] and options[:height].
+
+<pre>
+<code>
+@simple_data_array = [
+  { :x => 0, :y => 0 },
+  { :x => 1, :y => 1 },
+  { :x => 2, :y => 2 },
+  { :x => 3, :y => 2 },
+  { :x => 4, :y => 1 },
+  { :x => 5, :y => 0 },
+]
+
+@tg = TechnicalGraph.new(
+  {
+    :width => 600,
+    :height => 300
+  })
+@tg.add_layer(@simple_data_array)
+@tg.render
+file_name = 'samples/readme/09_image_size.png'
+@tg.image_drawer.save_to_file(file_name)
+</code>
+</pre>
+
+!https://github.com/akwiatkowski/technical_graph/raw/master/samples/readme/09_image_size.png((09) image size)!
+
+
+
+h2. Colours
+
+p. If you think you have better artistic taste feel free to change colours used in graph :)
+
+<pre>
+<code>
+@simple_data_array = [
+  { :x => 0, :y => 0 },
+  { :x => 1, :y => 1 },
+  { :x => 2, :y => 2 },
+  { :x => 3, :y => 2 },
+  { :x => 4, :y => 1 },
+  { :x => 5, :y => 0 },
+]
+
+@tg = TechnicalGraph.new(
+  {
+    :width => 600,
+    :height => 300
+  })
+@tg.add_layer(@simple_data_array, @layer_params)
+@tg.render
+file_name = 'samples/readme/09_image_size.png'
+@tg.image_drawer.save_to_file(file_name)
+</code>
+</pre>
+
+!https://github.com/akwiatkowski/technical_graph/raw/master/samples/readme/09_image_size.png((09) image size)!
+
+
+
+
+
 h2. TODO
 
-# Graph image size
 # Graph colors: background, hatch (option to turn it off?), axis
 # Anti-aliasing: image size comparison, layer antialiases
 # Font sizes

data/Gemfile

@@ -1,6 +1,7 @@
 source "http://rubygems.org"
 
 gem 'rmagick'
+gem 'rasem'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.

data/Gemfile.lock

@@ -8,6 +8,7 @@ GEM
       git (>= 1.2.5)
       rake
     rake (0.9.2)
+    rasem (0.6.1)
     rcov (0.9.10)
     rmagick (2.13.1)
     rspec (2.6.0)
@@ -26,6 +27,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0.0)
   jeweler
+  rasem
   rcov
   rmagick
   rspec

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/lib/technical_graph/array.rb

@@ -11,4 +11,29 @@ class Array
   def float_mean
     float_sum / size
   end
+
+  # Create partial array and fill with border values if needed
+  def clone_partial_w_fill(_from, _to)
+    part_array = Array.new
+    # border = false
+
+    (_from.._to).each do |current_i|
+      # outside ranges
+      if current_i < 0
+        part_array << self.first
+        # border = true
+        next
+      end
+
+      if self.size <= current_i
+        part_array << self.last
+        # border = true
+        next
+      end
+
+      part_array << self[current_i]
+    end
+
+    return part_array
+  end
 end

data/lib/technical_graph/data_layer.rb

@@ -10,7 +10,23 @@ require 'technical_graph/data_layer_processor'
 
 class DataLayer
 
-  def initialize(d = [], options = { })
+  # Use global logger for technical_graph or create new
+  def logger
+    return @logger if not @logger.nil?
+
+    if not @technical_graph.nil?
+      @logger = @technical_graph.logger
+    else
+      @logger = Logger.new(STDOUT)
+    end
+
+    @logger
+  end
+
+  def initialize(d = [], options = { }, technical_graph = nil)
+    # used for accessing logger
+    @technical_graph = technical_graph
+
     @data_params = options
 
     @data_params[:color] ||= GraphColorLibrary.instance.get_color
@@ -42,10 +58,14 @@ class DataLayer
     if data_array.kind_of? Array
       # append as DataPoint
       # convert to DataPoints, which has more specialized methods
+
+      t = Time.now
       data_array.each do |d|
         @data << DataPoint.new(d)
       end
-      
+      logger.debug "appending data, size #{data_array.size}"
+      logger.debug " TIME COST #{Time.now - t}"
+
       # sort, clean bad records
       process_data_internal
 
@@ -72,8 +92,11 @@ class DataLayer
 
   # Run external processor (smoothing, ...)
   def process!
+    t = Time.now
     @processed_data = @data.clone
     @processed_data = @processor.process
+    logger.debug "processed data using external processor"
+    logger.debug " TIME COST #{Time.now - t}"
   end
 
   # Additional parameters
@@ -84,10 +107,6 @@ class DataLayer
     return @data_params[:color]
   end
 
-  def antialias
-    return @data_params[:antialias]
-  end
-
   def label
     return @data_params[:label]
   end
@@ -116,6 +135,10 @@ class DataLayer
     return @data_params[:simple_smoother_x]
   end
 
+  def perform_parameter_uniq
+    return @data_params[:perform_parameter_uniq] == true
+  end
+
   # Clear data
   def clear_data
     @data = Array.new
@@ -123,12 +146,24 @@ class DataLayer
 
   # Clean and process data used for drawing current data layer
   def process_data_internal
+    t = Time.now
+
     # delete duplicates
-    @data = @data.inject([]) { |result, d| result << d unless result.select { |r| r.x == d.x }.size > 0; result }
+    if perform_parameter_uniq
+      @data = @data.inject([]) { |result, d| result << d unless result.select { |r| r.x == d.x }.size > 0; result }
+    end
+
+    logger.debug "internal processor - deleting duplicates"
+    logger.debug " TIME COST #{Time.now - t}"
+    t = Time.now
 
     @data.delete_if { |d| d.x.nil? or d.y.nil? }
     @data.sort! { |d, e| d.x <=> e.x }
 
+    logger.debug "internal processor - deleting nils and sorting"
+    logger.debug " TIME COST #{Time.now - t}"
+    t = Time.now
+
     # default X values, if data is not empty
     if @data.size > 0
       @data_params[:x_min] = @data.first.x || @options[:default_x_min]
@@ -139,6 +174,9 @@ class DataLayer
       @data_params[:y_min] = y_sort.first.y || @options[:default_y_min]
       @data_params[:y_max] = y_sort.last.y || @options[:@default_y_max]
     end
+
+    logger.debug "internal processor - setting min and max"
+    logger.debug " TIME COST #{Time.now - t}"
   end
 
   def x_min

data/lib/technical_graph/data_layer_processor.rb

@@ -9,6 +9,10 @@ class DataLayerProcessor
   include DataLayerProcessorSimpleSmoother
   include DataLayerProcessorNoiseRemoval
 
+  def logger
+    @data_layer.logger
+  end
+
   def initialize(data_layer)
     @data_layer = data_layer
     simple_smoother_initialize(data_params)
@@ -33,7 +37,6 @@ class DataLayerProcessor
     simple_smoother_initialize(data_params)
     noise_removal_initialize(data_params)
 
-    # TODO add in options array to choose order of these methods
     noise_removal_process
     simple_smoother_process
     

data/lib/technical_graph/data_layer_processor_noise_removal.rb

@@ -23,7 +23,7 @@ module DataLayerProcessorNoiseRemoval
 
     @noises_removed_count = 0
 
-    puts "Noise removal started"
+    logger.debug "Noise removal started"
 
     (0...data.size).each do |i|
       if not noise?(i)
@@ -33,7 +33,8 @@ module DataLayerProcessorNoiseRemoval
       end
     end
 
-    puts "Noise removal completed, removed #{@noises_removed_count}, time #{Time.now - t}"
+    logger.debug "Noise removal completed, removed #{@noises_removed_count}"
+    logger.debug " TIME COST #{Time.now - t}"
 
     @data = new_data
     return new_data
@@ -52,27 +53,7 @@ module DataLayerProcessorNoiseRemoval
     i_from = noise_removal_window_from(i)
     i_to = noise_removal_window_to(i)
 
-    # create partial array, TODO move it somewhere else
-    part_array = Array.new
-    border = false
-
-    (i_from..i_to).each do |current_i|
-      # outside ranges
-      if current_i < 0
-        part_array << data.first
-        border = true
-        next
-      end
-
-      if data.size <= current_i
-        part_array << data.last
-        border = true
-        next
-      end
-
-      part_array << data[current_i]
-
-    end
+    part_array = data.clone_partial_w_fill(i_from, i_to)
     y_mean = part_array.collect { |p| p.y }.float_mean
 
     # another algorithm

data/lib/technical_graph/data_layer_processor_simple_smoother.rb

@@ -72,7 +72,8 @@ module DataLayerProcessorSimpleSmoother
 
     # pre-processing, distance
     if simple_smoother_x == true
-      puts "X axis distance smoothing enabled"
+      logger.debug "X axis distance smoothing enabled"
+      t = Time.now
 
       (0...old_data.size).each do |i|
         new_data << DataPoint.xy(old_data[i].x, process_part(old_data, i, false))
@@ -80,15 +81,20 @@ module DataLayerProcessorSimpleSmoother
 
       old_data = new_data
       new_data = Array.new
+
+      logger.debug "X axis distance smoothing completed"
+      logger.debug " TIME COST #{Time.now - t}"
     end
 
-    puts "Y axis distance smoothing"
+    logger.debug "Y axis distance smoothing"
+    t = Time.now
 
     (0...old_data.size).each do |i|
       new_data << DataPoint.xy(old_data[i].x, process_part(old_data, i))
     end
 
-    puts "Smoothing completed, simple_smoother_level #{simple_smoother_level}, data size #{old_data.size}, time #{Time.now - t}"
+    logger.debug "Y axis Smoothing completed, simple_smoother_level #{simple_smoother_level}, data size #{old_data.size}"
+    logger.debug " TIME COST #{Time.now - t}"
 
     @data = new_data
     return new_data