gnuplot 2.3.6 → 2.4.0

data/ChangeLog

@@ -1,3 +1,6 @@
+2.4.0
+ * Allow for 3D plots, fix examples. Thanks everybody!
+
 2.3.6
  * Cleanup readme (thanks blambeau again, really, for the snippets)
 

data/README.textile

@@ -1,199 +1,202 @@
-h1.  Ruby Gnuplot - How To 
-
-p=. 
-      ["ChangeLog":ChangeLog]
-      ["Authors":AUTHORS.txt]
-      ["License":LICENSE.txt]
-    
-h2.  History and Background 
-
-      Gnuplot is a program that has a rich language for the generation of
-      plots.  It has a unique place in academia as it was one of the first
-      freely available programs for plot generation.  I started using gnuplot
-      over 10 years ago while pursuing my Master's degree in Physics and have
-      been using it actively ever since. Now rdp maintains it.
-      See also the changelog for more detail.
-    
-h2.  Ruby Gnuplot Concepts 
-
-      Gnuplot has a very simple conceptual model.  Calls to _Set_ are
-      made to set parameters and either _Plot_ or _Splot_ is
-      called to generate the actual plot.  The _dataset_ to be 
-      plotted can be specified in a number of ways, contained in a seperate
-      file, generated from a function, read from standard input, or read
-      immediately after the plot command.
-    
-
-      The object model for the Ruby gnuplot wrapper directly mimics this
-      layout and flow.  The following are the standard steps for generating a
-      plot:
-    
-    
-p.  Instantiate a Plot or Splot object and set parameters by gnuplot variable name. 
-p. Instantiate DataSet objects and attach Ruby objects containing
-	  the data to be plotted to the DataSet. Attach properties that modify
-	  the plot command using the modifier name.
-      
-p. Send the Plot/Splot object to a Gnuplot instance for
-	  plotting.  
-
-      The Version 2.0 interface makes very heavy use of blocks leading to very
-      readable code.
-    
-Gnuplot.open 
-
-
-bq. 
-      Instantiates a new Gnuplot process.  The path to the executable is
-      determined on a Unix or MacOSX system using the which command.  Windows
-      users, I have no idea what to do.
-      If a block is given to the function the opened process is passed into
-      the block.  This mimics the most common usage of the File.open method.
-    
-Plot.new 
-
-
-SPlot.new
- 
-bq. 
-      Create a new Plot or Splot object.  DataSets are attached to the object
-      to specify the data and its properties. 
-      If a block is given to the function, the plot object is passed into the
-      block.
-    
-DataSet.new
-
-bq. 
-      Associates a Ruby object containing the data to plot with the properties
-      that will be passed to the plot command for that dataset.  Any Ruby
-      object can be associated with a DataSet as long as it understands the
-      to_gplot method.
-    
- to_gplot 
- 
-bq. 
-      Within Gnuplot, plot data is read in very simple formats.  The
-      to_gplot method is expected to write the data of the object in a format
-      that is understandable by Gnuplot.  One of the many great things about
-      Ruby is that methods can be added after the original declaration.  The
-      gnuplot module defines the to_gplot method on the following classes:
-      Array, String, and Matrix.
-      Simply define a to_gplot method on your own class to tie the class into
-      gnuplot.
-    
-h2.  Examples 
-
-
-h3.  Simple sin wave 
-
-bq. The following example simply plots the value of sin(x) between the
-      ranges of -10 and 10.  A few points to notice:
-    
-p.  The code uses nested blocks to construct the plot.  The newly
-	  created object is passed to the block so it can be modified in
-	  place.
-      
-p.  Each of the gnuplot plot variables are modified using the 
-	  variable name as a method name on the plot object or on the dataset
-	  object.  The wrapper also takes care of the single quoting that is
-	  required on some of the variables like title, ylabel, and xlabel.
-	
-      
-p.  The plot object simply has an array of DataSets.  The
-	  constructor initializes this empty array before yielding to the
-	  block.  This method uses the << operator to add the DataSet to
-	  the plot.
-	
-      
-p.  When the plot block ends, if an IO object is given to the Plot
-	  constructor, the plot commands will be written to the IO object.
-	  Any object can be passed to the constructor as long as it
-	  understands the << operator.
-	  
-<pre>
-Gnuplot.open do |gp|
-  Gnuplot::Plot.new( gp ) do |plot|
-  
-    plot.xrange "[-10:10]"
-    plot.title  "Sin Wave Example"
-    plot.ylabel "x"
-    plot.xlabel "sin(x)"
-    
-    plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
-      ds.with = "lines"
-      ds.linewidth = 4
-    end
-    
-  end
-  
-end
-</pre>
-
-Or you can write it out to a file (the above snippet displays the graph, in Linux, but in windows you'd need to write it to a file).
-See the file examples/output_image_file.rb.
-
-h3. Plotting discrete points
-
-Array data can be plotted quite easily since Arrays have a defined to_gplot method.
-
-Simply pass an array of data to the constructor of the DataSet object or set the data property of the DataSet. In this example, because there are two arrays, each array will be a single column of data to the gnuplot process.
-
-<pre>
-Gnuplot.open do |gp|
-  Gnuplot::Plot.new( gp ) do |plot|
-  
-    plot.title  "Array Plot Example"
-    plot.ylabel "x"
-    plot.xlabel "x^2"
-    
-    x = (0..50).collect { |v| v.to_f }
-    y = x.collect { |v| v ** 2 }
-
-    plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
-      ds.with = "linespoints"
-      ds.notitle
-    end
-  end
-end
-</pre>
-    
-h3. Multiple Data Sets
-
-As many data sets as are desired can be attached to a plot. Each of these can have their own plot modifiers. Notice in this example how the data array is explicitly set instead of using the << operator.
-
-Also in this example, the commands are not written to the Gnuplot process but are instead written to a File called gnuplot.dat. This file can later be run directly by a gnuplot process as it contains only the gnuplot commands.
-
-<pre>
-File.open( "gnuplot.dat", "w") do |gp|
-  Gnuplot::Plot.new( gp ) do |plot|
-  
-    plot.xrange "[-10:10]"
-    plot.title  "Sin Wave Example"
-    plot.ylabel "x"
-    plot.xlabel "sin(x)"
-    
-    x = (0..50).collect { |v| v.to_f }
-    y = x.collect { |v| v ** 2 }
-
-    plot.data = [
-      Gnuplot::DataSet.new( "sin(x)" ) { |ds|
-        ds.with = "lines"
-        ds.title = "String function"
-    	  ds.linewidth = 4
-      },
-    
-      Gnuplot::DataSet.new( [x, y] ) { |ds|
-        ds.with = "linespoints"
-        ds.title = "Array data"
-      }
-    ]
-
-  end
-end
-</pre>    
-
-You can also add arbitrary lines to the output 
-
-<pre>
-plot.arbitrary_lines << "set ylabel \"y label" font \"Helvetica,20\""
-</pre>
+h1.  Ruby Gnuplot - How To 
+
+p=. 
+      ["ChangeLog":/ChangeLog]
+      ["Authors":AUTHORS.txt]
+      ["License":LICENSE.txt]
+    
+h2.  History and Background 
+
+      Gnuplot is a program that has a rich language for the generation of
+      plots.  It has a unique place in academia as it was one of the first
+      freely available programs for plot generation.  I started using gnuplot
+      over 10 years ago while pursuing my Master's degree in Physics and have
+      been using it actively ever since. Now rdp maintains it.
+      See also the changelog for more detail.
+    
+h2.  Ruby Gnuplot Concepts 
+
+      Gnuplot has a very simple conceptual model.  Calls to _Set_ are
+      made to set parameters and either _Plot_ or _Splot_ is
+      called to generate the actual plot.  The _dataset_ to be 
+      plotted can be specified in a number of ways, contained in a seperate
+      file, generated from a function, read from standard input, or read
+      immediately after the plot command.
+    
+
+      The object model for the Ruby gnuplot wrapper directly mimics this
+      layout and flow.  The following are the standard steps for generating a
+      plot:
+    
+    
+p.  Instantiate a Plot or Splot object and set parameters by gnuplot variable name. 
+p. Instantiate DataSet objects and attach Ruby objects containing
+	  the data to be plotted to the DataSet. Attach properties that modify
+	  the plot command using the modifier name.
+      
+p. Send the Plot/Splot object to a Gnuplot instance for
+	  plotting.  
+
+      The Version 2.0 interface makes very heavy use of blocks leading to very
+      readable code.
+    
+Gnuplot.open 
+
+
+bq. 
+      Instantiates a new Gnuplot process.  The path to the executable is
+      determined on a Unix or MacOSX system using the which command.  Windows
+      users, I have no idea what to do.
+      If a block is given to the function the opened process is passed into
+      the block.  This mimics the most common usage of the File.open method.
+    
+Plot.new 
+
+
+SPlot.new
+ 
+bq. 
+      Create a new Plot or Splot object.  DataSets are attached to the object
+      to specify the data and its properties. 
+      If a block is given to the function, the plot object is passed into the
+      block.
+    
+DataSet.new
+
+bq. 
+      Associates a Ruby object containing the data to plot with the properties
+      that will be passed to the plot command for that dataset.  Any Ruby
+      object can be associated with a DataSet as long as it understands the
+      to_gplot method.
+    
+ to_gplot 
+ 
+bq. 
+      Within Gnuplot, plot data is read in very simple formats.  The
+      to_gplot method is expected to write the data of the object in a format
+      that is understandable by Gnuplot.  One of the many great things about
+      Ruby is that methods can be added after the original declaration.  The
+      gnuplot module defines the to_gplot method on the following classes:
+      Array, String, and Matrix.
+      Simply define a to_gplot method on your own class to tie the class into
+      gnuplot.
+    
+h2.  Examples 
+
+
+h3.  Simple sin wave 
+
+bq. The following example simply plots the value of sin(x) between the
+      ranges of -10 and 10.  A few points to notice:
+    
+p.  The code uses nested blocks to construct the plot.  The newly
+	  created object is passed to the block so it can be modified in
+	  place.
+      
+p.  Each of the gnuplot plot variables are modified using the 
+	  variable name as a method name on the plot object or on the dataset
+	  object.  The wrapper also takes care of the single quoting that is
+	  required on some of the variables like title, ylabel, and xlabel.
+	
+      
+p.  The plot object simply has an array of DataSets.  The
+	  constructor initializes this empty array before yielding to the
+	  block.  This method uses the << operator to add the DataSet to
+	  the plot.
+	
+      
+p.  When the plot block ends, if an IO object is given to the Plot
+	  constructor, the plot commands will be written to the IO object.
+	  Any object can be passed to the constructor as long as it
+	  understands the << operator.
+	  
+<pre>
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    plot.xrange "[-10:10]"
+    plot.title  "Sin Wave Example"
+    plot.ylabel "x"
+    plot.xlabel "sin(x)"
+    
+    plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
+      ds.with = "lines"
+      ds.linewidth = 4
+    end
+    
+  end
+  
+end
+</pre>
+
+Or you can write it out to a file (the above snippet displays the graph, in Linux, but in windows you'd need to write it to a file).
+See the file examples/output_image_file.rb.
+
+h3. Plotting discrete points
+
+Array data can be plotted quite easily since Arrays have a defined to_gplot method.
+
+Simply pass an array of data to the constructor of the DataSet object or set the data property of the DataSet. In this example, because there are two arrays, each array will be a single column of data to the gnuplot process.
+
+<pre>
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    plot.title  "Array Plot Example"
+    plot.ylabel "x"
+    plot.xlabel "x^2"
+    
+    x = (0..50).collect { |v| v.to_f }
+    y = x.collect { |v| v ** 2 }
+
+    plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+      ds.with = "linespoints"
+      ds.notitle
+    end
+  end
+end
+</pre>
+    
+h3. Multiple Data Sets
+
+As many data sets as are desired can be attached to a plot. Each of these can have their own plot modifiers. Notice in this example how the data array is explicitly set instead of using the << operator.
+
+Also in this example, the commands are not written to the Gnuplot process but are instead written to a File called gnuplot.dat. This file can later be run directly by a gnuplot process as it contains only the gnuplot commands.
+
+<pre>
+File.open( "gnuplot.dat", "w") do |gp|
+  Gnuplot::Plot.new( gp ) do |plot|
+  
+    plot.xrange "[-10:10]"
+    plot.title  "Sin Wave Example"
+    plot.ylabel "x"
+    plot.xlabel "sin(x)"
+    
+    x = (0..50).collect { |v| v.to_f }
+    y = x.collect { |v| v ** 2 }
+
+    plot.data = [
+      Gnuplot::DataSet.new( "sin(x)" ) { |ds|
+        ds.with = "lines"
+        ds.title = "String function"
+    	  ds.linewidth = 4
+      },
+    
+      Gnuplot::DataSet.new( [x, y] ) { |ds|
+        ds.with = "linespoints"
+        ds.title = "Array data"
+      }
+    ]
+
+  end
+end
+</pre>    
+
+You can also add arbitrary lines to the output 
+
+<pre>
+plot.arbitrary_lines << "set ylabel \"y label" font \"Helvetica,20\""
+</pre>
+
+See more in the examples folder.  Also since this is basically just a wrapper for gnuplot itself, you should be able to do anything that it can do (demos: 
+http://gnuplot.sourceforge.net/demo_4.4/ ) 

data/Rakefile

@@ -1,13 +1,9 @@
-begin
-  require 'psych' # boo
-rescue ::LoadError
-end
-
 require 'jeweler'
 Jeweler::Tasks.new do |s|
   s.name = 'gnuplot'
-  s.description = s.summary = "Utility library to aid in interacting with gnuplot"
-  s.version = "2.3.6"
+  s.description = s.summary = "Utility library to aid in interacting with gnuplot from ruby"
+  s.version = "2.4.0"
+  s.authors='roger pack'
   s.autorequire = 'gnuplot.rb'
   s.email = "rogerpack2005@gmail.com"
   s.homepage = "http://github.com/rdp/ruby_gnuplot/tree/master"

data/examples/3d_surface_plot.rb

@@ -0,0 +1,14 @@
+require "gnuplot"
+
+Gnuplot.open do |gp|
+  Gnuplot::SPlot.new( gp ) do |plot|
+    plot.grid
+
+    plot.data = [
+      Gnuplot::DataSet.new( "x**2+y**2" ) do |ds|
+    	ds.with = "pm3d"
+      end
+    ]
+  end
+  sleep 10
+end

data/examples/discrete_points.rb

@@ -4,8 +4,8 @@ Gnuplot.open do |gp|
   Gnuplot::Plot.new( gp ) do |plot|
   
     plot.title  "Array Plot Example"
-    plot.ylabel "x"
-    plot.xlabel "x^2"
+    plot.ylabel "x^2"
+    plot.xlabel "x"
     
     x = (0..50).collect { |v| v.to_f }
     y = x.collect { |v| v ** 2 }
@@ -14,6 +14,5 @@ Gnuplot.open do |gp|
       ds.with = "linespoints"
       ds.notitle
     end
-
   end
 end

data/examples/histogram.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require "gnuplot"
+Gnuplot.open do |gp|
+  Gnuplot::Plot.new(gp) do |plot|
+  
+    plot.title  "Histogram example"
+    plot.style  "data histograms"
+    plot.xtics  "nomirror rotate by -45"
+    
+    titles = %w{decade Austria Hungary  Belgium} 
+    data = [
+      ["1891-1900",  234081,  181288,  18167],    
+      ["1901-1910",  668209,  808511,  41635],   
+      ["1911-1920",  453649,  442693,  33746],   
+      ["1921-1930",  32868,   30680,   15846],    
+      ["1931-1940",  3563,    7861,    4817],     
+      ["1941-1950",  24860,   3469,    12189],   
+      ["1951-1960",  67106,   36637,   18575],  
+      ["1961-1970",  20621,   5401,    9192],
+    ]
+    
+    x = data.collect{|arr| arr.first}
+    (1..3).each do |col|  
+      y = data.collect{|arr| arr[col]}
+      plot.data << Gnuplot::DataSet.new( [x, y] ) do |ds|
+        ds.using = "2:xtic(1)"
+        ds.title = titles[col]
+      end
+    end
+  
+  end
+end

data/examples/multiple_data_sets.rb

@@ -5,8 +5,8 @@ Gnuplot.open do |gp|
   
     plot.xrange "[-10:10]"
     plot.title  "Sin Wave Example"
-    plot.ylabel "x"
-    plot.xlabel "sin(x)"
+    plot.ylabel "sin(x)"
+    plot.xlabel "x"
     
     x = (0..50).collect { |v| v.to_f }
     y = x.collect { |v| v ** 2 }

data/examples/output_image_file.rb

@@ -15,13 +15,13 @@ Gnuplot.open do |gp|
     # for a list of recognized terminals.
     #
     plot.terminal "gif"
-    plot.output   File.expand_path("../sin_wave.gif", __FILE__)
+    plot.output File.expand_path("../sin_wave.gif", __FILE__)
   
     # see sin_wave.rb
     plot.xrange "[-10:10]"
     plot.title  "Sin Wave Example"
-    plot.ylabel "x"
-    plot.xlabel "sin(x)"
+    plot.ylabel "sin(x)"
+    plot.xlabel "x"
     
     plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
       ds.with = "lines"
@@ -30,3 +30,4 @@ Gnuplot.open do |gp|
     
   end
 end
+puts 'created sin_wave.gif'

data/examples/sin_wave.rb

@@ -5,8 +5,8 @@ Gnuplot.open do |gp|
   
     plot.xrange "[-10:10]"
     plot.title  "Sin Wave Example"
-    plot.ylabel "x"
-    plot.xlabel "sin(x)"
+    plot.ylabel "sin(x)"
+    plot.xlabel "x"
     
     plot.data << Gnuplot::DataSet.new( "sin(x)" ) do |ds|
       ds.with = "lines"
@@ -14,4 +14,5 @@ Gnuplot.open do |gp|
     end
     
   end
+  sleep 10
 end

data/lib/gnuplot.rb

@@ -55,7 +55,7 @@ module Gnuplot
   # 
   # Return the path to the gnuplot executable or nil if one cannot be found.
   def Gnuplot.gnuplot( persist = true )
-    cmd = which( ENV['RB_GNUPLOT'] || 'gnuplot' )
+    cmd = '"' + which( ENV['RB_GNUPLOT'] || 'gnuplot' ) + '"'
     raise 'gnuplot executable not found' unless cmd
     cmd += " -persist" if persist
     cmd
@@ -91,8 +91,12 @@ module Gnuplot
       @arbitrary_lines = []
       @data = []
       yield self if block_given?
-      puts "writing this to gnuplot:\n" + to_gplot + "\n" if $VERBOSE    
-      io << to_gplot if io
+      puts "writing this to gnuplot:\n" + to_gplot + "\n" if $VERBOSE
+
+      if io    
+        io << to_gplot
+        io << store_datasets
+      end
     end
     attr_accessor :arbitrary_lines
 
@@ -137,14 +141,18 @@ module Gnuplot
       @sets.each { |var, val| io << "set #{var} #{val}\n" }
       @arbitrary_lines.each{|line| io << line << "\n" }
 
-      if @data.size > 0 then
+      io
+    end
+
+    def store_datasets (io = "")
+      if @data.size > 0
         io << @cmd << " " << @data.collect { |e| e.plot_args }.join(", ")
         io << "\n"
 
         v = @data.collect { |ds| ds.to_gplot }
       	io << v.compact.join("e\n")
       end
-
+      
       io
     end
   end
@@ -158,16 +166,6 @@ module Gnuplot
     def to_gplot (io = "")
       @sets.each { |var, val| io << "set #{var} #{val}\n" }
 
-      if @data.size > 0 then
-        io << @cmd << " " 
-        io << @data.collect { |e| e.plot_args }.join(", ")
-        io << "\n"
-
-        @data.each do |ds| 
-          io << ds.to_gsplot << "e\n"
-        end
-      end
-
       io
     end
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: gnuplot
 version: !ruby/object:Gem::Version
-  version: 2.3.6
-  prerelease: 
+  prerelease:
+  version: 2.4.0
 platform: ruby
-authors: []
+authors:
+- roger pack
 autorequire: gnuplot.rb
 bindir: bin
 cert_chain: []
-date: 2011-03-03 00:00:00.000000000 -07:00
-default_executable: 
+date: 2012-03-20 00:00:00.000000000 Z
 dependencies: []
-description: Utility library to aid in interacting with gnuplot
+description: Utility library to aid in interacting with gnuplot from ruby
 email: rogerpack2005@gmail.com
 executables: []
 extensions: []
@@ -26,7 +26,9 @@ files:
 - README.textile
 - Rakefile
 - examples/.gitignore
+- examples/3d_surface_plot.rb
 - examples/discrete_points.rb
+- examples/histogram.rb
 - examples/multiple_data_sets.rb
 - examples/output_image_file.rb
 - examples/sin_wave.rb
@@ -36,38 +38,31 @@ files:
 - test/multtest.rb
 - test/sinwave.rb
 - test/test_gnuplot.rb
-has_rdoc: true
 homepage: http://github.com/rdp/ruby_gnuplot/tree/master
 licenses: []
-post_install_message: 
+post_install_message:
 rdoc_options: []
 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
+      version: !binary |-
+        MA==
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: !binary |-
+        MA==
+  none: false
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.6.0
-signing_key: 
+rubyforge_project:
+rubygems_version: 1.8.19
+signing_key:
 specification_version: 3
-summary: Utility library to aid in interacting with gnuplot
-test_files:
-- examples/discrete_points.rb
-- examples/multiple_data_sets.rb
-- examples/output_image_file.rb
-- examples/sin_wave.rb
-- test/arrtest.rb
-- test/histtest.rb
-- test/multtest.rb
-- test/sinwave.rb
-- test/test_gnuplot.rb
+summary: Utility library to aid in interacting with gnuplot from ruby
+test_files: []
+...