grada 1.1.1

data/lib/grada.rb

@@ -0,0 +1,241 @@
+require 'gnuplot'
+
+class Grada
+  # Not valid the format of the object to construct the graph
+  #
+  class NotValidArrayError < RuntimeError; end
+
+  # Not valid the content of the array you're passing to build the graph
+  #
+  class NotValidDataError < RuntimeError; end
+
+  # Can't build the plot
+  #
+  class NoPlotDataError < RuntimeError; end
+
+  attr_reader :x
+  attr_reader :y
+
+  DEFAULT_OPTIONS = {width: 1600,
+                     height: 400,
+                     title: "Graph",
+                     x_label: "X",
+                     y_label: "Y",
+                     with: 'lines',
+                     graph_type: :default}
+  
+  # Hello GraDA
+  #
+
+  def self.hi
+    puts "Hello GraDA"
+  end
+    
+  # Initialize object with the data you want to plot. 
+  # It can vary depending on the type of graph.
+  # The second argument is optional.
+  #
+  # Example:
+  #   >> radiation_levels_median_per_day = [0.001,0.01,1,10,1000]
+  #   >> radiation_days = [0,1,2,3,4]
+  #   >> grada = Grada.new(radiation_days, radiation_levels_median_per_day)
+  #   => #<Grada:0x007f962a8dc9b8 @x=[0, 1, 2, 3, 4], @y=[0.001, 0.01, 1, 10, 1000]>
+  # Arguments:
+  #   x: (Array)
+  #   y: (Array) *optional*
+  
+  def initialize(x, y = nil)
+
+    @x = validate(x)
+    @y = y.nil? ? y : validate(y)  
+  end
+ 
+  # Displays a graph in a window. 
+  # You can specify all the options that you need:
+  # *width* (Integer)
+  # *height* (Integer)
+  # *title* (Integer)
+  # *x_label* (String)
+  # *y_label* (String)
+  # *graph_type* (:histogram, :heatmap) default: :default
+  # *with* ('points', 'linespoints') default: 'lines'
+  #
+  #
+  # Example:
+  #   >> grada.display
+  #   => ""
+  #   >> grada.display({ title: 'Atomic Device X', x_label: 'Day', y_label: 'smSv', with: 'points' })
+  #   => ""
+  # Arguments:
+  #   opts: (Hash) *optional*
+
+  def display(opts = {})
+    @opts = DEFAULT_OPTIONS.merge(opts)
+    
+    if @opts[:graph_type] == :histogram
+      population_data?(@x)
+      
+      plot_histogram do |plot|
+        plot.set "terminal x11 size #{@opts[:width]},#{@opts[:height]}"
+      end
+    elsif @opts[:graph_type] == :heatmap
+      Matrix.columns(@x) rescue raise NoPlotDataError
+      @opts[:with] = 'image'
+      
+      plot_heat_map
+    else
+      raise NoPlotDataError if @y.nil?
+      
+      plot_and do |plot|
+        plot.set "terminal x11 size #{@opts[:width]},#{@opts[:height]}"
+      end
+    end
+  end
+
+  # Save the graph in a png file. 
+  # You can specify all the options that you need as _display_ but also need to specify the file
+  #
+  # Example:
+  #   >> grada.save({ filename: 'secret/radiation_levels/ffa/zonex/devicex/radiation_level_malaga.png' ,title: 'Atomic Device X', x_label: 'Day', y_label: 'smSv', with: 'points' }) 
+  #   => ""
+  # Arguments:
+  #   opts: (Hash) *optional*
+  
+  def save(opts = {})
+    @opts = DEFAULT_OPTIONS.merge(opts)
+    
+    return nil if @opts[:filename].nil?
+    
+    if @opts[:graph_type] == :histogram
+      population_data?(@x)
+      
+      plot_histogram do |plot|
+        plot.output @opts[:filename]
+        plot.set "terminal x11 size #{@opts[:width]},#{@opts[:height]}"
+        plot.terminal 'png'
+      end
+    elsif @opts[:graph_type] == :heatmap
+      Matrix.columns(@x) rescue raise NoPlotDataError
+      @opts[:with] = 'image'
+      
+      plot_heat_map do |plot|
+        plot.output @opts[:filename]
+        plot.terminal 'png'
+      end
+    else
+      raise NoPlotDataError if @y.nil?
+      
+      plot_and do |plot|
+        plot.output @opts[:filename]
+        plot.set "terminal x11 size #{@opts[:width]*10},#{@opts[:height]}"
+        plot.terminal 'png'
+      end
+    end
+  end
+  
+  private
+  
+  def validate(l)
+    raise NotValidArrayError if ! l.is_a?(Array)
+
+    l.each do |elem|
+      raise NotValidDataError if ! ( elem.is_a?(Float) || elem.is_a?(Integer) || elem.is_a?(Array) || elem.is_a?(Hash))
+    end
+  end
+  
+  def population_data?(l)
+    raise NotValidArrayError if ! l.is_a?(Array)
+
+    l.each do |elem|
+      raise NotValidDataError if ! ( elem.is_a?(Float) || elem.is_a?(Integer))
+    end
+  end
+  
+  def multiple_data?(l)
+    if l.is_a?(Array)
+      l.each do |elem|
+        return false if !  elem.is_a?(Hash)
+      end
+
+      return true
+    end
+    
+    false
+  end
+  
+  def plot_and(&block)
+    ::Gnuplot.open do |gp|
+      ::Gnuplot::Plot.new(gp) do |plot|
+        block[plot] if block
+
+        plot.title @opts[:title]
+        
+        plot.xlabel @opts[:x_label]
+        plot.ylabel @opts[:y_label]
+
+        if multiple_data?(@y)
+          @y.each do |dic|
+            dic.each do |k, v|
+              if k.to_sym != :with
+                raise NoPlotDataError if ! v.nil? && @x.size != v.size
+            
+                plot.data << ::Gnuplot::DataSet.new([@x,v]) do |ds|
+                  ds.with = dic[:with] || @opts[:with]
+                  ds.title = "#{k}"
+                end
+              end
+            end
+          end
+        else
+          raise NoPlotDataError if ! @y.nil? && @x.size != @y.size
+          
+          plot.data << ::Gnuplot::DataSet.new([@x,@y]) do |ds|
+            ds.with = @opts[:with] 
+          end
+        end
+      end
+    end
+  end
+  
+  def plot_histogram(&block)
+    ::Gnuplot.open do |gp|
+      ::Gnuplot::Plot.new(gp) do |plot|
+        block[plot] if block
+
+        plot.title @opts[:title]
+        
+        plot.set "style data histogram"
+        plot.xlabel @opts[:x_label]
+        plot.ylabel "Frecuency"
+
+        x = @x.sort.group_by { |xi| xi }.map{|k,v| v.count }
+        
+        plot.data << ::Gnuplot::DataSet.new(x) do |ds|
+          ds.with = @opts[:with] 
+        end
+      end
+    end
+  end
+  
+  def plot_heat_map(&block)
+    ::Gnuplot.open do |gp|
+      ::Gnuplot::Plot.new(gp) do |plot|
+        block[plot] if block
+        
+        plot.set "pm3d map"
+        plot.set "palette color"
+        plot.set "xrange [0:#{@x.size-1}]"
+        plot.set "yrange [0:#{@x.size-1}]"
+        plot.set "cbrange [#{@opts[:min]}:#{@opts[:max]}]"
+        plot.set "cblabel \"#{@opts[:x_label]}\""
+        plot.set "palette model RGB"
+        plot.set "palette define"
+       
+        plot.title @opts[:title]
+        plot.data = [::Gnuplot::DataSet.new(Matrix.columns(@x)) do |ds|
+          ds.with = @opts[:with] 
+        end]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: grada
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Enrique Figuerola
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gnuplot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+description: Graphic Data Analysis gem
+email: hard_rock15@msn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/grada.rb
+homepage: https://github.com/emfigo/grada
+licenses: []
+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
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: GraDA
+test_files: []