scbi_plot 0.0.4

data/History.txt

@@ -0,0 +1,7 @@
+=== 0.0.4 2011-05-31
+
+Fixed vertical lines
+
+=== 0.0.1 2011-04-07
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/scbi_plot.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_scbi_plot.rb
+lib/scbi_plot/plot.rb
+lib/scbi_plot/histogram.rb
+lib/scbi_plot/lines.rb
+lib/scbi_plot.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on scbi_plot, see http://scbi_plot.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,99 @@
+= scbi_plot
+
+* http://www.scbi.uma.es/downloads
+
+== DESCRIPTION:
+
+scbi_plot is a simplified wrapper to create plots with gnuplot.
+
+== FEATURES/PROBLEMS:
+
+* Create histogram plots with numeric or string x axis
+* Create line and related plots (linespoints, points, impulses, etc...)
+
+== SYNOPSIS:
+
+=== Histogram plot:
+
+  # create Histogram
+  p=ScbiPlot::Histogram.new('with_string_axis.png','title')
+
+  # add x axis data
+  p.add_x(['a','b','c'])
+
+  # add y axis data
+  p.add_y([10,20,30])
+
+  # generate graph
+  p.do_graph
+
+=== Line plot:
+
+  # Create lines plot
+  p=ScbiPlot::Lines.new('lines.png','title')
+
+  # create some random data
+  x=[]
+  y1=[]
+  y2=[]
+  y3=[]
+
+  10.times do |i|
+    x.push i*10
+    y1.push i+(rand*50).to_i
+    y2.push i+(rand*50).to_i
+    y3.push i+(rand*50).to_i
+  end
+
+
+  # add x data
+  p.add_x(x)
+
+  # add a series
+  p.add_series('serie0', y1)
+
+  # draw another series with points
+  p.add_series('serie1', y2, 'points')
+
+  # add a third series with impulses of width 4
+  p.add_series('serie2', y3,'impulses',4)
+
+  # add a vertical line at pos 5
+  p.add_vertical_line('label',5)
+
+  # create graph
+  p.do_graph
+
+== REQUIREMENTS:
+
+* gnuplot binary
+* gnuplot gem
+
+== INSTALL:
+
+* gem install scbi_plot
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Dario Guerrero
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/scbi_plot'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'scbi_plot' do
+  self.developer 'Dario Guerrero Fernandez', 'dariogf@gmail.com'
+  # self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+  self.extra_deps = [['gnuplot','>= 2.3.0']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+task :default => [:spec, :features, :redocs]

data/lib/scbi_plot/histogram.rb

@@ -0,0 +1,128 @@
+require 'gnuplot'
+
+# = scbi_plot - Ploting utilities
+#
+# Plots a graph using gnuplot.
+#
+# =Usage:
+# p=ScbiPlot::Histogram.new('few_strings.png','titulo')
+#
+# p.add_x(['a','b','c'])
+# p.add_y([10,20,30])
+#
+# p.do_graph
+#
+# =Tips
+# * scbi_plot can handle integer and string values in x row
+# * If x and y are integer values, the graph is sorted by x (ascendent values from left to right)
+# * When x contains strings:
+#     -if number of elements in x is greater than x_limit (by default 20), values are sorted in descendant order, and only @x_limit values are plotted
+#     -if number of elements is below x_limit, then values are shown as an histogram
+module ScbiPlot
+
+  class Histogram < ScbiPlot::Plot
+
+
+    def initialize(file_name,title=nil)
+      super
+      @line_width=4
+      @show_leyend=false
+    end
+
+    def do_graph
+      setup_data
+      # $VERBOSE=false
+
+      Gnuplot.open do |gp|
+        # histogram
+        Gnuplot::Plot.new( gp ) do |plot|
+
+          if !title
+            title=file_name
+          end
+
+          plot.title "#{@title}"
+          plot.xlabel @x_label
+          plot.ylabel @y_label
+
+          if !@show_leyend
+            plot.set "key off" #leyend
+          end
+
+          # x values are integers
+          if !contains_strings?(@x)
+
+            plot.style "fill  pattern 22  border -1"
+            plot.set "boxwidth 0.2" # Probably 3-5.
+
+            plot.data << Gnuplot::DataSet.new( [@x, @y] ) do |ds|
+              ds.with=  " imp lw #{@line_width}"
+            end
+
+          else #graph with strings in X axis
+            # $VERBOSE=true
+            plot.xlabel ""
+
+            plot.set "style fill solid 1.00 border -1"
+            plot.set "style histogram clustered gap 1 title offset character 0, 0, 0"
+            plot.set "style data histogram"
+            plot.set "boxwidth 0.2 absolute"
+            if @x.count>4 then
+              plot.set "xtics offset 0,graph 0 rotate 90"
+            end
+
+            plot.data << Gnuplot::DataSet.new( [@x,@y] ) do |ds|
+              ds.using = "2:xticlabels(1)"   #show the graph and use labels at x
+            end
+
+          end
+
+          if !file_name.nil?
+            plot.terminal "png size 800,600"
+            plot.output "#{@file_name}"
+          end
+        end
+      end
+    end
+
+
+
+  #   def setup_data
+  #     if @x.length != @y.length
+  #       raise "Variables x and y have different sizes"
+  # 
+  #     else
+  # 
+  #       hash=xy_to_hash(@x,@y)
+  #       # puts hash
+  #       # sort integer data
+  #       if !contains_strings?(@x)
+  # 
+  #         @x.sort!
+  #         @y=[]
+  # 
+  #         @x.each do |v|
+  #           @y.push hash[v].to_i
+  #         end
+  # 
+  # 
+  #       else # there are strings in X
+  #         @x=[]
+  #         @y=[]
+  # 
+  #         # save quoted values
+  #         hash.keys.each do |v|
+  #           @x.push "\"#{v.gsub('\"','').gsub('\'','')}\""
+  #           @y.push hash[v.to_s]
+  #         end
+  # 
+  #         # check if there is a lot of string data
+  #         check_data_limit
+  # 
+  #       end
+  #     end
+  #   end
+  # 
+  # 
+    end
+end

data/lib/scbi_plot/lines.rb

@@ -0,0 +1,117 @@
+require 'gnuplot'
+
+# = scbi_plot - Ploting utilities
+#
+# Plots a graph using gnuplot.
+#
+# =Usage:
+# p=ScbiPlot::Histogram.new('few_strings.png','titulo')
+#
+# p.add_x(['a','b','c'])
+# p.add_y([10,20,30])
+#
+# p.do_graph
+#
+# =Tips
+# * scbi_plot can handle integer and string values in x row
+# * If x and y are integer values, the graph is sorted by x (ascendent values from left to right)
+# * When x contains strings:
+#     -if number of elements in x is greater than x_limit (by default 20), values are sorted in descendant order, and only @x_limit values are plotted
+#     -if number of elements is below x_limit, then values are shown as an histogram
+module ScbiPlot
+
+  class Lines < ScbiPlot::Plot
+
+
+    def initialize(file_name,title=nil)
+      super
+      @series=[]
+      @line_width=2
+      @show_leyend=true
+      @vertical_lines=[]
+
+
+
+    end
+
+    def add_series(title, y_data, graph_type ='lines',line_width=nil)
+      @series << {:title => title, :data=> y_data, :graph_type=>graph_type, :line_width=>(line_width || @line_width)}
+    end
+
+    def add_vertical_line(title,x_value)
+      @vertical_lines << {:title => title, :x_value=> x_value}
+    end
+
+    def do_graph
+      setup_data
+      # $VERBOSE=true
+
+      Gnuplot.open do |gp|
+        # histogram
+        Gnuplot::Plot.new( gp ) do |plot|
+
+          if !title
+            title=file_name
+          end
+
+          plot.title "#{@title}"
+          plot.xlabel @x_label
+          plot.ylabel @y_label
+          plot.xrange "[#{@x.min}:#{@x.max}]"
+          plot.x2range "[#{@x.min}:#{@x.max}]"
+          # plot.x2range "auto"
+
+          if !@show_leyend
+            plot.set "key off" #leyend
+          end
+
+          # x values are integers
+          if contains_strings?(@x)
+            raise "Line plots cannot have strings in x axis"
+          end
+
+          # plot.style "fill pattern 22 border -1"
+          # plot.set "boxwidth 0.2" # Probably 3-5.
+          if !@vertical_lines.empty?
+            x2ticks =[]
+            @vertical_lines.each do |v_line|
+
+              x2ticks << "'#{v_line[:title]} (#{v_line[:x_value]})' #{v_line[:x_value]}"
+            end
+
+            plot.set "x2tics (#{x2ticks.join(', ')})"
+            plot.set 'grid noxtics x2tics lt rgb "green"'
+          end
+
+          @series.each do |series|
+            plot.data << Gnuplot::DataSet.new( [@x, series[:data]] ) do |ds|
+
+              ds.with =  series[:graph_type]
+              ds.linewidth = series[:line_width]
+              ds.title = series[:title]
+
+            end
+
+          end
+
+          if !file_name.nil?
+            plot.terminal "png size 800,600"
+            plot.output "#{@file_name}"
+          end
+        end
+      end
+    end
+
+
+
+    def setup_data
+      @series.each do |series|
+        if @x.length != series[:data].length
+          raise "Variables x and y have different sizes in serie #{series[:name]}"
+        end
+      end
+    end
+
+
+  end
+end

data/lib/scbi_plot/plot.rb

@@ -0,0 +1,220 @@
+require 'gnuplot'
+
+# = scbi_plot - Ploting utilities
+#
+# Plots an histogram using gnuplot.
+#
+# =Usage:
+# p=Plot.new('few_strings.png','titulo')
+#
+# p.add_x(['a','b','c'])
+# p.add_y([10,20,30])
+#
+# p.do_graph
+#
+# =Tips
+# * scbi_plot can handle integer and string values in x row
+# * If x and y are integer values, the graph is sorted by x (ascendent values from left to right)
+# * When x contains strings:
+#     -if number of elements in x is greater than x_limit (by default 20), values are sorted in descendant order, and only @x_limit values are plotted
+#     -if number of elements is below x_limit, then values are shown as an histogram
+module ScbiPlot
+
+  class Plot
+
+    attr_accessor :title,:file_name,:x_label,:y_label,:x_limit,:x, :y, :line_width
+
+    def initialize(file_name,title=nil)
+
+      @x=[]
+      @y=[]
+      @x_label='x'
+      @y_label='y'
+
+      @title=title
+      @file_name=file_name
+
+      if @title.nil?
+        @title=file_name
+      end
+
+      @x_limit=20
+      @line_width=1
+
+    end
+
+    def add_x(x)
+      @x=x
+    end
+
+    def add_y(y)
+      @y=y
+    end
+
+
+    def add_xy(data)
+      @x=[]
+      @y=[]
+
+      if data.is_a?(Array)
+
+        data.each do |e|
+          @x.push e[0]
+          @y.push e[1]
+        end
+
+      elsif data.is_a?(Hash)
+
+        data.each do |k,v|
+          @x.push k
+          @y.push v
+        end
+
+      end
+    end
+
+
+    # def do_graph
+    #   setup_data
+    #   $VERBOSE=false
+    # 
+    #   Gnuplot.open do |gp|
+    #     # histogram
+    #     Gnuplot::Plot.new( gp ) do |plot|
+    # 
+    #       if !title
+    #         title=file_name
+    #       end
+    # 
+    #       plot.title "#{@title}"
+    #       plot.xlabel @x_label
+    #       plot.ylabel @y_label
+    # 
+    #       if !@show_leyend
+    #         plot.set "key off" #leyend
+    #       end
+    # 
+    #       # x values are integers
+    #       if !contains_strings?(@x)
+    #         plot.style "fill  pattern 22  border -1"
+    #         plot.set "boxwidth 0.2" # Probably 3-5.
+    # 
+    #         plot.data << Gnuplot::DataSet.new( [@x, @y] ) do |ds|
+    #           ds.with=  " imp lw 4"
+    #         end
+    # 
+    #       else #graph with strings in X axis
+    #         plot.xlabel ""
+    # 
+    #         plot.set "style fill solid 1.00 border -1"
+    #         plot.set "style histogram clustered gap 1 title offset character 0, 0, 0"
+    #         plot.set "style data histogram"
+    #         plot.set "boxwidth 0.2 absolute"
+    # 
+    #         if @x.count>4 then
+    #           plot.set "xtics offset 0,graph 0 rotate 90"
+    #         end
+    # 
+    #         plot.data << Gnuplot::DataSet.new( [@x,@y] ) do |ds|
+    #           ds.using = "2:xticlabels(1)"   #show the graph and use labels at x
+    #         end
+    # 
+    #       end
+    # 
+    #       if !file_name.nil?
+    #         plot.terminal "png size 800,600"
+    #         plot.output "#{@file_name}"
+    #       end
+    #     end
+    #   end
+    # end
+
+
+    def xy_to_hash(x,y)
+      h={}
+
+      x.each_with_index do |x1,i|
+        h[x1]=y[i]
+      end
+
+      return h
+
+    end
+
+    def check_data_limit
+      # if more than 20 strings, then keep greater ones
+      if @x.count>@x_limit
+        h = xy_to_hash(@x,@y)
+
+        @x=[]
+        @y=[]
+
+        @x_limit.times do
+          ma=h.max_by{|k,v| v}
+          if ma
+            @x.push ma[0]
+            @y.push ma[1]
+            h.delete(ma[0])
+          end
+        end
+
+      end
+
+    end
+
+    def setup_data
+      if @x.length != @y.length
+        raise "Variables x and y have different sizes"
+
+      else
+
+        hash=xy_to_hash(@x,@y)
+        # puts hash
+        # sort integer data
+        if !contains_strings?(@x)
+
+          @x.sort!
+          @y=[]
+
+          @x.each do |v|
+            @y.push hash[v].to_i
+          end
+
+
+        else # there are strings in X
+          @x=[]
+          @y=[]
+
+          # save quoted values
+          hash.keys.each do |v|
+            # @x.push "\"#{v.gsub('\"','').gsub('\'','')}\""
+            @x.push "#{v.gsub('\"','').gsub('\'','')}"
+            # puts 
+            @y.push hash[v.to_s]
+          end
+
+          # check if there is a lot of string data
+          check_data_limit
+
+        end
+      end
+    end
+
+    def contains_strings?(x)
+      contains_strings=false
+
+      x.each do |v|
+        begin
+          r=Integer(v)
+        rescue
+          contains_strings=true
+          break
+        end
+      end
+
+      return contains_strings
+    end
+
+
+  end
+end

data/lib/scbi_plot.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'scbi_plot/plot'
+require 'scbi_plot/histogram'
+require 'scbi_plot/lines'
+
+
+module ScbiPlot
+   VERSION = '0.0.4'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/scbi_plot.rb'}"
+puts "Loading scbi_plot gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/scbi_plot'

data/test/test_scbi_plot.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'scbi_plot/plot'
+
+class TestScbiPlot < Test::Unit::TestCase
+
+  def setup
+        
+  end
+  
+  def test_few_strings
+    p=ScbiPlot::Histogram.new('few_strings.png','titulo')
+    
+    p.add_x(['a','b','c'])
+    p.add_y([10,20,30])
+    
+    p.do_graph
+
+    assert(File.exists?('few_strings.png'))
+  end
+  
+  def test_lot_of_strings
+    p=ScbiPlot::Histogram.new('lot_of_strings.png','titulo')
+    
+    p.add_x(('a'..'z').to_a)
+    p.add_y((1..p.x.length).to_a)
+    
+    p.do_graph
+
+    assert(File.exists?('lot_of_strings.png'))
+  end
+  
+  def test_histogram
+    p=ScbiPlot::Histogram.new('histogram.png','titulo')
+    
+    x=[]
+    y=[]
+    
+    1000.times do |i|
+      x.push i
+      y.push i+(rand*50).to_i
+    end
+    
+    p.add_x(x)
+    p.add_y(y)
+    
+    p.do_graph
+
+    assert(File.exists?('histogram.png'))
+  end
+
+  def test_lines
+    p=ScbiPlot::Lines.new('lines.png','titulo')
+    
+    x=[]
+    y=[]
+    y2=[]
+    y3=[]
+    
+    10.times do |i|
+      x.push i*10
+      y.push i+(rand*50).to_i
+      y2.push i+(rand*50).to_i
+      y3.push i+(rand*50).to_i
+    end
+    
+    p.add_x(x)
+    # p.add_y(y)
+    p.add_series('serie0', y)
+    p.add_series('serie1', y2, 'points')
+    p.add_series('serie2', y3,'impulses',4)
+    
+    p.add_vertical_line('pos',5)
+    
+    p.do_graph
+
+    assert(File.exists?('lines.png'))
+  end
+
+  
+  
+  def test_sizes
+    p=ScbiPlot::Histogram.new('bad.png','titulo')
+    
+    p.add_x([4,3])
+    p.add_y([10,20,30])
+
+    assert_raise( RuntimeError ) { p.do_graph }
+
+    assert(!File.exists?('bad.png'))
+    
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: scbi_plot
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Dario Guerrero Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gnuplot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id002
+description: scbi_plot is a simplified wrapper to create plots with gnuplot.
+email: 
+- dariogf@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/scbi_plot.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_scbi_plot.rb
+- lib/scbi_plot/plot.rb
+- lib/scbi_plot/histogram.rb
+- lib/scbi_plot/lines.rb
+homepage: http://www.scbi.uma.es/downloads
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: scbi_plot
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: scbi_plot is a simplified wrapper to create plots with gnuplot.
+test_files: 
+- test/test_helper.rb
+- test/test_scbi_plot.rb