visualisation-utils 0.6 → 0.7.0

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in visualisation-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Felix Leipold
+
+MIT License
+
+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/README.md

@@ -41,6 +41,47 @@ This incantation will bring up the gnuplot gui with the following graph:
 
 ![gui](https://raw.github.com/programmiersportgruppe/visualisation-utils/master/doc/gnuplot-gui.png)
 
+time-line
+=========
+
+The `time-line` tool visualises events in a time-line.
+The data is expected in two columns, a timestamp and an
+event name. The default time format is `%Y-%m-%dT%H:%M:%S`.
+
+Here is a simple example:
+
+~~~~
+time-line \
+    --dimensions 1300,600 \
+    -o time-line.png <<'END'
+2015-04-24T12:21:32 A
+2015-04-24T10:42:35 B
+2015-04-23T11:36:26 B
+2015-04-23T11:36:26 C
+2015-04-22T12:38:54 A
+2015-04-22T07:46:29 C
+2015-04-21T18:02:01 B
+2015-04-21T18:02:01 A
+2015-04-17T17:35:21 B
+2015-04-17T12:33:23 A
+2015-04-17T09:04:37 D
+2015-04-17T09:04:37 B
+2015-04-17T08:29:31 D
+2015-04-16T07:03:51 C
+2015-04-15T07:57:23 E
+2015-04-15T07:57:23 B
+2015-04-15T07:04:13 B
+2015-04-14T12:22:07 F
+2015-04-13T09:52:25 C
+END
+~~~~
+
+It yields the following graph:
+
+![](doc/time-line.png)
+
+
+
 heat-map
 ========
 
@@ -76,6 +117,6 @@ TODO
 - [X] Secondary y-axis
 - [ ] Bar chart single series
 - [ ] Bar chart multiple series
-- [ ] Discrete y-values, e.g. to visualise events over time
+- [X] Discrete y-values, e.g. to visualise events over time
 - [ ] Histogram plotting
 

data/bin/heat-map

@@ -1,29 +1,16 @@
 #!/usr/bin/env ruby
 require 'trollop'
-require 'mkmf'
-
-DATA_FILE_NAME="/tmp/plot-"+`date  "+%s"`.strip+".dat"
-PLOT_FILE_NAME="/tmp/plot-"+`date  "+%s"`.strip+".plt"
+require 'visualisation-utils'
 
+parser = VisualisationUtils::BasicParser.new
 
 @opts = Trollop::options do
     banner "heat-map takes comma and newline separated table of coordinate from stdin and renders them using gnuplot"
-    opt :outfile, "Output file name", :type => String, :short => 'o'
-    opt :debug, "debug"
-    opt :title, "Title", :type=> String, :short => 't'
-    opt :font, "Font", :type => String, :short => 'f'
-    opt :extra_header, "Extra commands to be put in the header of the gnuplot file", :type => String
+    parser.standard_opts(self)
 end
 
-title = @opts[:title] || ""
-
-if (!find_executable 'gnuplot')
-    STDERR.puts("This utility depends on gnuplot. Please install gnuplot using your favourite package manager.")
-    exit(1)
-end
+gnu_plot_tool=VisualisationUtils::GnuPlotTool.new(@opts)
 
-
-# TODO I do want to be streamed!
 input = `cat`
 
 freq_list = input.split("\n").map{|line|
@@ -42,62 +29,27 @@ max_val = freq_values.max
 min_val = freq_values.min
 mid_val = (min_val + (max_val - min_val)/2).round(1)
 
-puts "Min. value: #{min_val}, max value: #{max_val}"
+if (gnu_plot_tool.debug?)
+    puts "Min. value: #{min_val}, max value: #{max_val}"
+end
 
 full_map = (-179..179).map{|lon|
    (-89..89).map{|lat|
        key = "#{lat},#{lon}"
-       "#{lat} #{lon} #{freqs[key]||0}"
+       "#{lat} #{lon} #{freqs[key]||"NaN"}"
    }
 }.join("\n")
 
-
+DATA_FILE_NAME="/tmp/plot-"+`date  "+%s"`.strip+".dat"
 File.open(DATA_FILE_NAME, "w"){|f| f.write(full_map)}
-
-font = @opts[:font] || "Futura"
-font_size = "12"
-
-extra_header = @opts[:extra_header] || ""
-
-if (@opts[:outfile])
-    filename = @opts[:outfile]
-    extension = filename.gsub(/[^.]*\./,"")
-    if (extension == "png")
-        terminal=<<EOF
-            set term pngcairo font '#{font},#{font_size}' transparent size 1200,800
-            set output '#{filename}'
-
-EOF
-    elsif (extension == "eps")
-        terminal=<<EOF
-            set term epscairo size 1200,800 font '#{font},#{font_size}'
-            set output '#{filename}'
-EOF
-    elsif (extension == "pdf")
-        terminal=<<EOF
-            set term pdfcairo size 22cm,14cm font '#{font},#{font_size}'
-            set output '#{filename}'
-EOF
-    elsif (extension == "svg")
-        terminal=<<EOF
-            set term svg size 1200,800 font '#{font},#{font_size}'
-            set output '#{filename}'
-EOF
-    else
-        throw "Unknown output format '.#{extension}'."
-    end
-
-
+if (gnu_plot_tool.debug?)
+    STDERR.puts "data file " + DATA_FILE_NAME
 end
 
 
 world_dat=File.join(File.dirname(File.expand_path(__FILE__)), '/../world.dat')
 
-script = <<EOF
-
-#{terminal}
-set title "#{title}"
-
+gnu_plot_tool.plot(<<EOF
 # color definitions
 set border lw 1.5
 set style line 1 lc rgb 'black' lt 1 lw 2
@@ -115,14 +67,4 @@ set palette defined (0 "white",#{min_val} "#00ffff",#{mid_val} "yellow",#{max_va
 plot '#{DATA_FILE_NAME}' u 2:1:3 w image, \
      '#{world_dat}' with lines linestyle 1
 EOF
-
-puts "data file " + DATA_FILE_NAME
-puts "plot file " + PLOT_FILE_NAME
-
-
-
-File.open(PLOT_FILE_NAME, "w"){|f| f.write(script)}
-
-persistent_opt = @opts[:outfile]?"":"-p"
-
-`gnuplot #{persistent_opt} #{PLOT_FILE_NAME}`
+)

data/bin/overlay

@@ -11,6 +11,4 @@ basename="$(basename "$FOREGROUND")"
 SIGNED=`dirname "$FOREGROUND"`"/${basename%.*}.branded.png"
 
 convert  "${FOREGROUND}" "${BACKGROUND}"  -gravity center  -compose DstOver -composite -background white -format png /tmp/output.png
-convert  /tmp/output.png  -background white -flatten -format png "$SIGNED"
-
-
+convert  /tmp/output.png  -background white -flatten -format png "$SIGNED"

data/bin/scatter-plot

@@ -1,33 +1,26 @@
 #!/usr/bin/env ruby
 require 'trollop'
-require 'mkmf'
+require 'visualisation-utils'
+
+parser = VisualisationUtils::BasicParser.new
+
 
 DATA_FILE_NAME="/tmp/plot-"+`date  "+%s"`.strip+".dat"
-PLOT_FILE_NAME="/tmp/plot-"+`date  "+%s"`.strip+".plt"
 
 
 @opts = Trollop::options do
     banner "scatter-plot takes whitespace separated tables from stdin and renders them using gnuplot"
-    opt :outfile, "Output file name", :type => String, :short => 'o'
-    opt :legends, "Legend for columns, pipe separated list", :type => String, :short => 'l'
-    opt :plot_styles, "Style of plot, comma separated list, values as expected by gnuplot, e.g. lines, points, linespoints, defaults to points", :type => String
-    opt :axis_labels,  "Labels for axes, pipe separated list", :type => String
-    opt :axes,  "Axes used for the respective columns, e.g. (1|possible value are ", :type => String
+    parser.standard_opts(self)
+    opt :legends, "Legend for columns, comma-separated list", :type => String, :short => 'l'
+    opt :plot_styles, "Style of plot, comma-separated list, values as expected by gnuplot, e.g. lines, points, linespoints, defaults to points", :type => String
+    opt :axis_labels,  "Labels for axes, pipe-separated list", :type => String
+    opt :axes,  "Y-axes used for the respective columns, pipe-seprated list.", :type => String
     opt :numc, "Number of data columns", :type => Integer, :short => 'c'
-    opt :debug, "debug"
-    opt :title, "Title", :type=> String, :short => 't'
-    opt :font, "Font", :type => String, :short => 'f'
     opt :time, "Time format for time series data, strftime expression", :type => String
-    opt :ranges, "A list comma separated pairs of gnuplot range-expressions, e.g. xrange [-10:10], yrange[0:40], y2range [0:1]", type:String
-    opt :extra_header, "Extra commands to be put in the header of the gnuplot file", :type => String
+    opt :ranges, "A list of comma-separated pairs of gnuplot range-expressions, e.g. xrange [-10:10], yrange[0:40], y2range [0:1]", type:String
 end
 
-title = @opts[:title] || ""
-
-if (!find_executable 'gnuplot')
-    STDERR.puts("This utility depends on gnuplot. Please install gnuplot using your favourite package manager.")
-    exit(1)
-end
+gnu_plot_tool=VisualisationUtils::GnuPlotTool.new(@opts)
 
 # TODO I do want to be streamed!
 input = `cat`
@@ -49,46 +42,11 @@ plot_styles =  @opts[:plot_styles] ? @opts[:plot_styles].strip().split(/,/)  : [
 
 ranges = @opts[:ranges] ? @opts[:ranges].split(",").map{ |r| "set #{r}"}.join("\n") : ""
 
-font = @opts[:font] || "Futura"
-font_size = "12"
 using_list = legends.zip((2..100).to_a, axes, plot_styles).
     map{|text, index, yaxis, plot_style|
         "'#{DATA_FILE_NAME}' using 1:#{index} title \"#{text}\" with #{plot_style} ls #{index-1} axes x1y#{yaxis}"
     }.join(", ")
 
-extra_header = @opts[:extra_header] || ""
-
-if (@opts[:outfile])
-    filename = @opts[:outfile]
-    extension = filename.gsub(/[^.]*\./,"")
-    if (extension == "png")
-        terminal=<<EOF
-            set term pngcairo font '#{font},#{font_size}' transparent size 1200,800
-            set output '#{filename}'
-
-EOF
-    elsif (extension == "eps")
-        terminal=<<EOF
-            set term epscairo size 1200,800 font '#{font},#{font_size}'
-            set output '#{filename}'
-EOF
-    elsif (extension == "pdf")
-        terminal=<<EOF
-            set term pdfcairo size 22cm,14cm font '#{font},#{font_size}'
-            set output '#{filename}'
-EOF
-    elsif (extension == "svg")
-        terminal=<<EOF
-            set term svg size 1200,800 font '#{font},#{font_size}'
-            set output '#{filename}'
-EOF
-    else
-        throw "Unknown output format '.#{extension}'."
-    end
-
-
-end
-
 
 if (@opts[:time])
     timeExpr=@opts[:time]
@@ -103,8 +61,10 @@ else
 end
 
 
-script = <<EOF
-#{terminal}
+STDERR.puts "data file " + DATA_FILE_NAME
+
+
+gnu_plot_tool.plot(<<EOF
 #{axis_labels.map{ | axis | pair=axis.split(":"); "set #{pair[0]}label '#{pair[1]}';"}.join("\n")}
 set key outside
 set key left top
@@ -120,24 +80,11 @@ set tics nomirror
 set style line 12 lc rgb '#808080' lt 0 lw 1
 set grid back ls 12
 set y2tics
-#{extra_header}
 
 #{ranges}
 
-set title "#{title}"
 #{time}
 plot #{using_list}
-
 EOF
+)
 
-
-puts "data file " + DATA_FILE_NAME
-puts "plot file " + PLOT_FILE_NAME
-
-
-
-File.open(PLOT_FILE_NAME, "w"){|f| f.write(script)}
-
-persistent_opt = @opts[:outfile]?"":"-p"
-
-`gnuplot #{persistent_opt} #{PLOT_FILE_NAME}`

data/bin/time-line

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+require 'trollop'
+require 'visualisation-utils'
+
+parser = VisualisationUtils::BasicParser.new
+
+DATA_FILE_NAME="/tmp/plot-"+`date  "+%s"`.strip+".dat"
+
+@opts = Trollop::options do
+    banner "time-line takes whitespace separated tables of timestamps and events (names) from stdin and renders them using gnuplot"
+    parser.standard_opts(self)
+    opt :time, "Format for timestamp, strftime expression", :type => String
+end
+
+gnu_plot_tool=VisualisationUtils::GnuPlotTool.new(@opts)
+
+# TODO I do want to be streamed!
+input = `cat`
+lines = input.split("\n").map{|line| line.split(/\s+/)}
+
+values=lines.map{|line| line[1]}.uniq.sort.reverse
+coords=Hash[values.each_with_index.map { |x,i| [x, i + 0.5] }]
+
+lines_with_y=lines.map{|line| line[0] + " " + coords[line[1]].to_s}
+
+File.open(DATA_FILE_NAME, "w"){|f| f.write(lines_with_y.join("\n"))}
+
+numc_input=input.split(/\n/)[0].split(/\s+/).length - 1
+
+if gnu_plot_tool.debug?
+    STDERR.puts "Detected numc y-columns #{numc_input}"
+end
+
+numc = numc_input
+
+if (numc != 1)
+    STDERR.puts("Expecting 2 cols of input, a timestamp and an event identifier.")
+    exit 1
+end
+
+axis_labels = (@opts[:axis_labels] || " | ").split("|")
+
+legends = (@opts[:legends] ? @opts[:legends].strip().split(/,/) : (1..(numc)).map{|x| ""}).map{|x| x.strip}
+
+axes = @opts[:axes] ? @opts[:axes].split("|") : [1] * legends.length
+
+plot_styles =  @opts[:plot_styles] ? @opts[:plot_styles].strip().split(/,/)  : [ "points" ] * legends.length
+
+using_list = legends.zip((2..100).to_a, axes, plot_styles).
+    map{|text, index, yaxis, plot_style|
+        "'#{DATA_FILE_NAME}' using 1:#{index} title \"#{text}\" with #{plot_style} ls #{index-1} axes x1y#{yaxis}"
+    }.join(", ")
+
+
+timeExpr=@opts[:time]||"%Y-%m-%dT%H:%M:%S"
+
+if gnu_plot_tool.debug?
+    STDERR.puts "data file " + DATA_FILE_NAME
+end
+
+gnu_plot_tool.plot(<<EOF
+#{axis_labels.map{ | axis | pair=axis.split(":"); "set #{pair[0]}label '#{pair[1]}';"}.join("\n")}
+#set key outside
+#set key left top
+#set offsets 1, 1, 1, 0
+set style line 1 lc rgb '#cc0000' pt 4 ps 1 lt 1 lw 3 # --- red
+set style line 2 lc rgb '#4e9a06' pt 6 ps 1 lt 1 lw 3 # --- green
+set style line 3 lc rgb '#3465a4' pt 7 ps 1 lt 1 lw 3 # --- blue
+set style line 4 lc rgb '#f57900' pt 8 ps 1 lt 1 lw 3 # --- orange
+set style line 5 lc rgb '#edd400' pt 9 ps 1 lt 1 lw 3 # --- butter
+set style line 11 lc rgb '#808080' lt 1
+set border 3 back ls 11
+set tics nomirror
+set style line 12 lc rgb '#808080' lt 0 lw 1
+set grid back ls 12
+
+set yrange [0:#{values.length}]
+set lmargin 5
+set rmargin 5
+
+set ytics (#{coords.map{|pair| '"' + pair[0].gsub("_", " ") + '"' + " " + pair[1].to_s}.join(", ") })
+
+set xdata time
+set format x "%d %b %y"
+set timefmt "#{timeExpr}"
+set autoscale x
+
+plot #{using_list}
+EOF
+)
+

data/lib/visualisation-utils/version.rb

@@ -0,0 +1,3 @@
+module VisualisationUtils
+        VERSION = "0.7.0"
+end

data/lib/visualisation-utils.rb

@@ -0,0 +1,96 @@
+require "visualisation-utils/version"
+
+module VisualisationUtils
+
+    class BasicParser
+        def standard_opts(opt)
+            opt.opt :outfile, "Output file name", :type => String, :short => 'o'
+            opt.opt :debug, "debug"
+            opt.opt :title, "Title", :type => String, :short => 't'
+            opt.opt :font, "Font", :type => String, :short => 'f'
+            opt.opt :font_size, "Font size", :type => String
+            opt.opt :dimensions, "Image dimensions", :type => String
+            opt.opt :transparent, "use transparent background"
+            opt.opt :extra_header, "Extra commands to be put in the header of the gnuplot file", :type => String
+        end
+    end
+
+    # Wraps the gnu plot invocation and basic scaffold for shared options
+    # around output format.
+    class GnuPlotTool
+
+        def initialize(opts)
+            @title = opts[:title] || ""
+            @opts = opts
+            @debug = opts[:debug]
+
+            if (! system 'which -s gnuplot')
+                STDERR.puts("This utility depends on gnuplot. Please install gnuplot using your favourite package manager.")
+                exit(1)
+            end
+
+            font = @opts[:font] || "Helvetica"
+            font_size = @opts[:font_size ] || "12"
+
+            @extra_header = @opts[:extra_header] || ""
+
+            dimensions=@opts[:dimensions] || "1200,800"
+
+            if (@opts[:outfile])
+                filename = @opts[:outfile]
+                extension = filename.gsub(/[^.]*\./, "")
+                if (extension == "png")
+                    @terminal=<<EOF
+            set term pngcairo font '#{font},#{font_size}' #{@opts[:transparent]?"transparent":""} size #{dimensions}
+            set output '#{filename}'
+EOF
+                elsif (extension == "eps")
+                    @terminal=<<EOF
+            set term epscairo size #{dimensions} font '#{font},#{font_size}'
+            set output '#{filename}'
+EOF
+                elsif (extension == "pdf")
+                    @terminal=<<EOF
+            set term pdfcairo size 22cm,14cm font '#{font},#{font_size}'
+            set output '#{filename}'
+EOF
+                elsif (extension == "svg")
+                    @terminal=<<EOF
+            set term svg size #{dimensions} font '#{font},#{font_size}'
+            set output '#{filename}'
+EOF
+                else
+                    throw "Unknown output format '.#{extension}'."
+                end
+            end
+        end
+
+        def debug?
+            @debug
+        end
+
+        def plot(script)
+            plot_file_name="/tmp/plot-"+`date  "+%s"`.strip+".plt"
+            full_script=<<EOF
+#{@terminal}
+                set title "#{@title}"
+
+                #{@extra_header}
+
+                #{script}
+EOF
+
+            if (debug?)
+                STDERR.puts "plot file " + plot_file_name
+            end
+
+            File.open(plot_file_name, "w") { |f| f.write(full_script) }
+
+            persistent_opt = @opts[:outfile] ? "" : "-p"
+
+            `gnuplot #{persistent_opt} #{plot_file_name}`
+
+        end
+    end
+
+end

data/visualisation-utils.gemspec

@@ -1,23 +1,22 @@
-Gem::Specification.new do |s|
-  s.name         = 'visualisation-utils'
-  s.summary      = 'utilities for quick visualisation'
-  s.description  = 'visualisation-utils provides a number of utilities
-                    for visualising data from the command line.'
-  s.version      = '0.6'
-  s.platform     = Gem::Platform::RUBY
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'visualisation-utils/version'
 
-  s.files        = ['bin/scatter-plot']
+Gem::Specification.new do |gem|
+  gem.name          = "visualisation-utils"
+  gem.version       = VisualisationUtils::VERSION
+  gem.authors       = ["Felix Leipold"]
+  gem.email         = [""]
+  gem.description   = %q{visualisation-utils provides a number of utilities
+                    for visualising data from the command line.}
+  gem.summary       = %q{utilities for quick visualisation}
+  gem.homepage      = "https://github.com/programmiersportgruppe/visualisation-utils"
 
-  s.bindir = 'bin'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
 
-  s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-
-  s.author      = 'Felix Leipold'
-  s.email       = ''
-  s.homepage    = 'https://github.com/programmiersportgruppe/visualisation-utils'
-  s.license = 'MIT'
-
-  s.add_dependency('trollop')
+  gem.add_dependency('trollop')
 end
-