basis-processing 0.5.8 → 0.5.9

data/README

@@ -1,8 +1,18 @@
+Please send bug reports to (avishek.sen.gupta at gmail.com)
+
 **NOTE: Starting from version 0.5.1, Basis has been ported to Ruby 1.9.2, because of the kd-tree library dependency. Currently, there are no plans of maintaining Basis compatibility with Ruby 1.8.x.**
 
 **Basis** provides a set of classes for easily plotting and transforming arbitrary 2D coordinate systems by specifying their basis vectors. Originally developed to work with Ruby-Processing, it now supports any class which supports Processing-like semantics.
 
-Starting from version 0.5.0, experimental support has been added for mouseover interactivity without (too much) extra effort on your part. This is still a work in progress, though.
+UPDATE: Starting from version 0.5.9, you can turn grid lines on or off.
+
+UPDATE: Starting from version 0.5.8, you can customise axis labels, draw arbitrary shapes/text/plot custom graphics at any point in your coordinate system. See below for more details.
+
+UPDATE: With version 0.5.7, experimental support has been added for drawing objects which aren’t points. Interactions with such objects is currently not supported. Additional support for drawing markers/highlighting in custom bases is now in.
+
+UPDATE: Starting from version 0.5.1, Basis has been ported to Ruby 1.9.2, because of the kd-tree library dependency. Currently, there are no plans of maintaining Basis compatibility with Ruby 1.8.x. As an aside, I personally recommend using RVM to manage the mess of Ruby/JRuby installations that you’re likely to have on your machine.
+
+UPDATE: Basis has hit version 0.5.0 with experimental support for mouseover interactivity. More work is incoming, but the demo code below is up-to-date, for now. Starting from version 0.5.0, experimental support has been added for mouseover interactivity without (too much) extra effort on your part. This is still a work in progress, though.
 
 ## Installation
 
@@ -247,7 +257,21 @@ The other interesting thing about the above code will become evident if we speci
 
 The box plot in this modified basis acquires the properties of skewness, rotation, etc. of the host coordinate system. This lets you get on with drawing the object without really worrying about the specific properties of the coordinate space you are plotting in.
 
-## Convenience methods for setting up default CoordinateSystem
+The other variation you can use is the at() method of a Screen object. at() behaves like plot(), except that it never plots anything by itself, instead deferring full control to the block that you pass to it. Think of it as a simple way of accessing any point in your custom coordinate system, without having to perform any of the messy transformations yourself. So, for example, the following code fragment, puts some text at whichever point on screen corresponds to (some_x, some_y) in your custom basis.
+
+	@screen.at({:x => some_x, :y => some_y}) {|o,m,s| text(o[:y], m[:x] + 5, m[:y] + 14)}
+
+## Axis drawing options
+
+Starting from version 0.5.8, you can customise labels, if you pass two blocks to the draw_axes() method, one for the x-axis, the other for the y-axis. For example, in the fragment below, we're not outputting anything for the x-axis labels (returning an empty string), and converting the y-axis value to an integer.
+
+	@screen.draw_axes(10, 10, :x => ->(p){''}, :y => ->(p){p.to_i})
+
+Grid lines are drawn by default. To turn them off, set the :gridlines key to false in the call to draw_axes(), like so:
+
+	@screen.draw_axes(10, 10, :x => ->(p){''}, :y => ->(p){p.to_i}, :gridlines => false)
+
+## Convenience method for setting up default CoordinateSystem
 
 If you're doing a simple plot, with standard basis vectors with no transformations, you can use the convenience method in CoordinateSystem to set up a default system.
 

data/basis.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s| 
   s.name = "basis-processing"
-  s.version = "0.5.8"
+  s.version = "0.5.9"
   s.add_dependency('knnball', '>= 0.0.6')
   s.author = "Avishek Sen Gupta"
   s.email = "avishek.sen.gupta@gmail.com"

data/lib/basis_processing.rb

@@ -1,6 +1,6 @@
 require 'transform.rb'
 require 'ranges.rb'
-require 'matrix_operations.rb'
+require 'matrix_extensions.rb'
 require 'coordinate_system.rb'
 require 'screen.rb'
 require 'interactive'

data/lib/coordinate_system.rb

@@ -1,7 +1,7 @@
 require 'ranges'
 require 'ruby-processing'
-require 'matrix_operations'
 require 'hash_vector'
+require 'matrix_extensions'
 
 include Math
 
@@ -16,8 +16,6 @@ end
 class CoordinateSystem
 	CROSSHAIR_SCALE = 5000
 	UNIT_TRANSFORM = [[1,0],[0,1]]
-
-	include MatrixOperations
 	attr_accessor :x_basis_vector, :y_basis_vector, :basis_matrix
 
 	def self.standard(x_range, y_range, artist)
@@ -36,27 +34,21 @@ class CoordinateSystem
 		@y_axis = y_axis
 		@x_basis_vector = x_axis.basis_vector
 		@y_basis_vector = y_axis.basis_vector
-		@basis_transform = transform
-		@basis_matrix = 
+		@basis_transform = Matrix.rows(transform)
+		@basis_matrix = Matrix.rows(
 				[
 					[@x_basis_vector[:x],@y_basis_vector[:x]],
 					[@x_basis_vector[:y],@y_basis_vector[:y]]
-				]
-
-		d = @basis_matrix[0][0]*@basis_matrix[1][1] - @basis_matrix[0][1]*@basis_matrix[1][0]
-		@inverse_basis = 
-				[
-					[@basis_matrix[1][1]/d, -@basis_matrix[0][1]/d],
-					[-@basis_matrix[1][0]/d, @basis_matrix[0][0]/d]
-				]
+				])
 
-		@standard_transform = MatrixOperations::into2Dx2D(MatrixOperations::into2Dx2D(@basis_matrix, @basis_transform), @inverse_basis)
+		@inverse_basis = @basis_matrix.inverse
+		@standard_transform = @basis_matrix*@basis_transform*@inverse_basis
 	end
 
 	def tick_vectors
 		{
-			:x_tick_vector => MatrixOperations::into2Dx1D(rotation(-90),@x_basis_vector),
-			:y_tick_vector => MatrixOperations::into2Dx1D(rotation(90),@y_basis_vector)
+			:x_tick_vector => (rotation(-90)*@x_basis_vector).as_hash,
+			:y_tick_vector => (rotation(90)*@y_basis_vector).as_hash
 		}
 	end
 
@@ -82,29 +74,20 @@ class CoordinateSystem
 
 	def rotation(angle)
 		radians = angle * PI/180.0
-		[[cos(radians), -sin(radians)],[sin(radians),cos(radians)]]
+		Matrix.rows([[cos(radians), -sin(radians)],[sin(radians),cos(radians)]])
 	end
 
 
 	def standard_basis(point)
-		basis_matrix =
-		[
-			[@x_basis_vector[:x], @y_basis_vector[:x]],
-			[@x_basis_vector[:y], @y_basis_vector[:y]]
-		]
-		standard_point = MatrixOperations::into2Dx1D(basis_matrix, point)
-
-		MatrixOperations::into2Dx1D(@standard_transform, standard_point)
+		standard_point = @basis_matrix* point
+		r = @standard_transform * standard_point
+		{:x => r[0,0], :y => r[1,0]}
 	end
 
 	def original(onscreen_point)
-		p1 = MatrixOperations::into2Dx1D(MatrixOperations::inverse2D(@standard_transform), onscreen_point)
-		basis_matrix =
-		[
-			[@x_basis_vector[:x], @y_basis_vector[:x]],
-			[@x_basis_vector[:y], @y_basis_vector[:y]]
-		]
-		MatrixOperations::into2Dx1D(MatrixOperations::inverse2D(basis_matrix), p1)
+		p1 = @standard_transform.inverse * onscreen_point
+		o = @basis_matrix.inverse* p1
+		{:x => o[0][0], :y => o[1][0]}
 	end
 	
 	def crosshairs(p)

data/lib/demo.rb

@@ -39,7 +39,7 @@ class Demo < Processing::App
 
 		screen_transform = Transform.new({:x => 2, :y => -2}, {:x => 300, :y => 900})
 		@screen = Screen.new(screen_transform, self, @basis)
-		@screen.draw_axes(10,10)
+		@screen.draw_axes(10,10, :gridlines => false)
 		stroke(1,1,0,1)
 		fill(1,1,0)
 		rect_mode(CENTER)

data/lib/hash_vector.rb

@@ -1,9 +1,16 @@
+require 'matrix'
+
 class Hash
 	def *(scalar)
 		{:x => self[:x] * scalar.to_f, :y => self[:y] * scalar.to_f}
 	end
 	def +(vector)
-		{:x => self[:x] + vector[:x], :y => self[:y] + vector[:y]}
+		return {:x => self[:x] + vector[:x], :y => self[:y] + vector[:y]} if vector.kind_of? Hash
+		{:x => self[:x] + vector[0,0], :y => self[:y] + vector[1,0]}
+	end
+
+	def as_matrix
+		Matrix.columns([[self[:x], self[:y]]])
 	end
 end
 

data/lib/matrix_extensions.rb

@@ -0,0 +1,14 @@
+require 'matrix'
+
+class Matrix
+	alias_method :multiply, :*
+	def *(another)
+		return multiply(Matrix.columns([[another[:x], another[:y]]])) if another.kind_of? Hash
+		multiply(another)
+	end
+	
+	def as_hash
+		{:x => self[0,0], :y => self[1,0]}
+	end
+end
+

data/lib/screen.rb

@@ -19,9 +19,9 @@ class Screen
 		@points = []
 		@data = []
 		@output = output
-		@transform_matrix = [[@transform.scale[:x], 0],[0, @transform.scale[:y]]]
-		nhm = MatrixOperations::into2Dx2D(@transform_matrix, @basis.basis_matrix)
-		@affine_transform = PMatrix2D.new(nhm[0][0],nhm[0][1],@transform.origin[:x],nhm[1][0],nhm[1][1],@transform.origin[:y])
+		@transform_matrix = Matrix.rows([[@transform.scale[:x], 0],[0, @transform.scale[:y]]])
+		nhm = @transform_matrix* @basis.basis_matrix
+		@affine_transform = PMatrix2D.new(nhm[0,0],nhm[0,1],@transform.origin[:x],nhm[1,0],nhm[1,1],@transform.origin[:y])
 		@inverse_affine_transform = @affine_transform.get
 		@inverse_affine_transform.invert
 	end
@@ -111,7 +111,7 @@ class Screen
 		{:x => 5*vector[:x]/magnitude, :y => 5*vector[:y]/magnitude}
 	end
 
-	def draw_axes(x_interval, y_interval, labelling_blocks = {})
+	def draw_axes(x_interval, y_interval, options = {})
 		f = @artist.createFont("Georgia", 24, true);
 		@artist.text_font(f,16)
 		axis_screen_transform = Transform.new({:x => 800, :y => -800}, @transform.origin)
@@ -129,10 +129,11 @@ class Screen
 		@artist.line(x_ticks.first[:from][:x],x_ticks.first[:from][:y],x_ticks.last[:from][:x],x_ticks.last[:from][:y])
 		@artist.line(y_ticks.first[:from][:x],y_ticks.first[:from][:y],y_ticks.last[:from][:x],y_ticks.last[:from][:y])
 
-		draw_ticks(x_ticks, {:x => 0, :y => 20}, labelling_blocks[:x])
-		draw_ticks(y_ticks, {:x => -50, :y => 0}, labelling_blocks[:y])
+		draw_ticks(x_ticks, {:x => 0, :y => 20}, options[:x])
+		draw_ticks(y_ticks, {:x => -50, :y => 0}, options[:y])
 		
 		@artist.stroke(0.4, 1.0, 0.5, 0.2)
+		return if !options[:gridlines].nil? && options[:gridlines] == false
 		grid_lines = @basis.grid_lines(x_interval, y_interval).collect {|gl| {:from => @transform.apply(gl[:from]), :to => @transform.apply(gl[:to])}}
 		grid_lines.each do |l|
 			@artist.line(l[:from][:x],l[:from][:y],l[:to][:x],l[:to][:y])

data/redeploy.sh

@@ -0,0 +1,3 @@
+gem build basis.gemspec
+sudo /home/avishek/jruby/jruby-1.6.4/bin/jruby -S gem uninstall basis-processing
+sudo /home/avishek/jruby/jruby-1.6.4/bin/jruby -S gem install basis-processing-0.5.9.gem

metadata

@@ -1,34 +1,47 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: basis-processing
-version: !ruby/object:Gem::Version
-  version: 0.5.8
+version: !ruby/object:Gem::Version 
+  hash: 25
   prerelease: 
+  segments: 
+  - 0
+  - 5
+  - 9
+  version: 0.5.9
 platform: ruby
-authors:
+authors: 
 - Avishek Sen Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-11 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-10-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: knnball
-  requirement: &17679680 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 0
+        - 6
         version: 0.0.6
   type: :runtime
-  prerelease: false
-  version_requirements: *17679680
-description: Basis provides a set of classes for easily plotting and transforming
-  arbitrary 2D coordinate systems by specifying their basis vectors in Ruby-Processing.
+  version_requirements: *id001
+description: Basis provides a set of classes for easily plotting and transforming arbitrary 2D coordinate systems by specifying their basis vectors in Ruby-Processing.
 email: avishek.sen.gupta@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - README
 - basis.gemspec
@@ -40,34 +53,44 @@ files:
 - lib/demo.rb
 - lib/hash_vector.rb
 - lib/interactive.rb
-- lib/matrix_operations.rb
+- lib/matrix_extensions.rb
 - lib/ranges.rb
 - lib/screen.rb
 - lib/text_output.rb
 - lib/transform.rb
+- redeploy.sh
 homepage: http://avishek.net/blog
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Basis provides a set of classes for easily plotting and transforming arbitrary
-  2D coordinate systems by specifying their basis vectors in Ruby-Processing.
+summary: Basis provides a set of classes for easily plotting and transforming arbitrary 2D coordinate systems by specifying their basis vectors in Ruby-Processing.
 test_files: []
+

data/lib/matrix_operations.rb

@@ -1,24 +0,0 @@
-module MatrixOperations
-	def MatrixOperations.into2Dx2D(first, second)
-		[
-			[second[0][0]*first[0][0] + second[1][0]*first[0][1], second[0][1]*first[0][0] + second[1][1]*first[0][1]],
-			[second[0][0]*first[1][0] + second[1][0]*first[1][1], second[0][1]*first[1][0] + second[1][1]*first[1][1]]
-		]
-	end
-
-	def MatrixOperations.into2Dx1D(transform, point)
-		{
-			:x => transform[0][0]*point[:x] + transform[0][1]*point[:y], 
-			:y => transform[1][0]*point[:x] + transform[1][1]*point[:y]
-		}
-	end
-
-	def MatrixOperations.inverse2D(m)
-		determinant = (m[0][0]*m[1][1] - m[0][1]*m[1][0]).to_f;
-		[
-			[m[1][1]/determinant, -m[0][1]/determinant],
-			[-m[1][0]/determinant, m[0][0]/determinant]
-		]
-	end
-end
-