geospatial 0.0.1 → 1.0.0

data/spec/geospatial/index_spec.rb

@@ -0,0 +1,113 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'geospatial/index'
+require_relative 'sorted'
+
+RSpec.shared_context "hilbert index" do
+	it "computes the correct hash" do
+		coordinates.each do |coordinate, encoded|
+			index = Geospatial::OrdinalIndex.new(coordinate, bits)
+			
+			# puts "c: #{coordinate} i: #{index.inspect} h: #{index.to_hilbert.inspect} #{index.to_hilbert.to_i} == #{encoded}"
+			
+			expect(index.to_hilbert.to_i).to be == encoded
+		end
+	end
+	
+	it "computes the correct unhash" do
+		coordinates.each do |coordinate, encoded|
+			index = Geospatial::HilbertIndex.from_integral(encoded, coordinate.size, bits)
+			
+			expect(index.to_ordinal.axes).to be == coordinate
+		end
+	end
+end
+
+RSpec.describe "order=0 n=2" do
+	let(:coordinates) {
+		{
+			#y, x
+			[0, 0] => 0b00,
+			[0, 1] => 0b01,
+			[1, 1] => 0b10,
+			[1, 0] => 0b11
+		}
+	}
+	
+	let(:bits) {1}
+	
+	it_behaves_like "hilbert index"
+end
+
+RSpec.describe "order=0 n=3" do
+	let(:coordinates) {
+		{
+			# The sequence on the left walks through the hilbert curve in 3-space, while on the right is stepping incrementally through the curve.
+			[0, 0, 0] => 0b000,
+			[0, 0, 1] => 0b001,
+			[0, 1, 1] => 0b010,
+			[0, 1, 0] => 0b011,
+			[1, 1, 0] => 0b100,
+			[1, 1, 1] => 0b101,
+			[1, 0, 1] => 0b110,
+			[1, 0, 0] => 0b111,
+		}
+	}
+	
+	let(:bits) {1}
+	
+	it_behaves_like "hilbert index"
+end
+
+RSpec.describe "order=1 n=2" do
+	# Curves of odd order, move on the most significant axis first (so that their top level motion is equivalent)
+	let(:coordinates) {
+		{
+			# Lower left quadrant
+			[0, 0] => 0b0000,
+			[1, 0] => 0b0001,
+			[1, 1] => 0b0010,
+			[0, 1] => 0b0011,
+			
+			# Lower right quadrant
+			[0, 2] => 0b0100,
+			[0, 3] => 0b0101,
+			[1, 3] => 0b0110,
+			[1, 2] => 0b0111,
+			
+			# Upper right quadrant
+			[2, 2] => 0b1000,
+			[2, 3] => 0b1001,
+			[3, 3] => 0b1010,
+			[3, 2] => 0b1011,
+			
+			# Upper left quadrant
+			[3, 1] => 0b1100,
+			[2, 1] => 0b1101,
+			[2, 0] => 0b1110,
+			[3, 0] => 0b1111,
+		}
+	}
+	
+	let(:bits) {2}
+	
+	it_behaves_like "hilbert index"
+end

data/spec/{geoquery → geospatial}/location_spec.rb

@@ -22,11 +22,11 @@ require 'geospatial/location'
 
 module Geospatial::LocationSpec
 	describe Geospatial::Location do
+		let(:lake_tekapo) {Geospatial::Location.new(170.53, -43.89)}
+		let(:lake_alex) {Geospatial::Location.new(170.45, -43.94)}
+		
 		it "compute the correct distance between two points" do
-			lake_tekapo = Geospatial::Location.new(-43.883, 170.516)
-			lake_alex = Geospatial::Location.new(-43.95, 170.45)
-			
-			expect(lake_alex.distance_from(lake_tekapo)).to be_within(10).of(9_130)
+			expect(lake_alex.distance_from(lake_tekapo)).to be_within(100).of(8_500)
 		end
 	end
 end

data/spec/geospatial/map_index_spec.rb

@@ -0,0 +1,41 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'geospatial/map/index'
+
+RSpec.describe Geospatial::Map::Index do
+	let(:map) {Geospatial::Map.for_earth(30)}
+	let(:subject) {map.index}
+	
+	let(:lake_alex) {Geospatial::Location.new(170.45, -43.94)}
+	let(:point) {map.point_for_coordinates(lake_alex.to_a)}
+	
+	it "should dump to hash" do
+		expect(subject.dump(point)).to be == point.hash
+	end
+	
+	it "should load hash" do
+		truncated_point = subject.load(point.hash)
+		distance = Geospatial::Location.new(*truncated_point.coordinates).distance_from(lake_alex)
+		
+		# The distance between the truncated point and the original point should be < 10 meters.
+		expect(distance).to be < 10
+	end
+end

data/spec/geospatial/map_spec.rb

@@ -0,0 +1,71 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'geospatial/hilbert'
+require 'geospatial/map'
+
+require_relative 'visualization'
+
+RSpec.describe Geospatial::Map.for_earth do
+	let(:lake_tekapo) {Geospatial::Location.new(170.53, -43.89)}
+	let(:lake_alex) {Geospatial::Location.new(170.45, -43.94)}
+	let(:sydney) {Geospatial::Location.new(151.21, -33.85)}
+	
+	let(:new_zealand) {Geospatial::Box.from_bounds(Vector[166.0, -48.0], Vector[180.0, -34.0])}
+	let(:australia) {Geospatial::Box.from_bounds(Vector[112.0, -45.0], Vector[155.0, -10.0])}
+	
+	it "can generate visualisation" do
+		Geospatial::Visualization.for_map(subject) do |pdf, origin|
+			size = australia.size
+			top_left = (origin + australia.min) + Vector[0, size[1]]
+			pdf.rectangle(top_left.to_a, *size.to_a)
+			
+			pdf.fill
+			
+			subject.traverse(australia, depth: subject.order - 10) do |child, prefix, order|
+				size = child.size
+				top_left = (origin + child.min) + Vector[0, size[1]]
+				pdf.rectangle(top_left.to_a, *size.to_a)
+			end
+			
+			pdf.fill_and_stroke
+		end.render_file "map.pdf"
+	end
+	
+	it "should add points" do
+		subject << lake_tekapo
+		subject << lake_alex
+		
+		subject.sort!
+		
+		expect(subject.count).to be == 2
+		expect(subject.points[0].hash).to be <= subject.points[1].hash
+	end
+	
+	it "should find points in New Zealand" do
+		subject << lake_tekapo << lake_alex << sydney
+		
+		subject.sort!
+		
+		points = subject.query(new_zealand, depth: 10)
+		expect(points).to include(lake_tekapo, lake_alex)
+		expect(points).to_not include(sydney)
+	end
+end

data/spec/geospatial/polygon_spec.rb

@@ -0,0 +1,96 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'geospatial/polygon'
+
+require_relative 'visualization'
+
+RSpec.shared_context "kaikoura region" do
+	let(:region) do
+		Geospatial::Polygon[
+			Vector[173.7218528654108, -42.32817252073923],
+			Vector[173.6307775307161, -42.32729039137249],
+			Vector[173.5400659958715, -42.39758413896335],
+			Vector[173.5446498680837, -42.43847509799515],
+			Vector[173.6833471779081, -42.44870319335309],
+			Vector[173.7608096128163, -42.42144813099029],
+			Vector[173.7218528654108, -42.32817252073923],
+		]
+	end
+	
+	let(:filter) {subject.filter_for(region)}
+	let(:kaikoura) {Geospatial::Location.new(173.6814, -42.4008)}
+end
+
+RSpec.describe Geospatial::Polygon.new([Vector[0.0, 0.0], Vector[1.0, 0.0], Vector[0.0, 1.0]]) do
+	it "should intersect point on edge" do
+		is_expected.to be_include_point(Vector[0.0, 0.0])
+	end
+	
+	it "should not intersect point outside" do
+		is_expected.to_not be_include_point(Vector[1.0, 0.5])
+	end
+	
+	it "should intersect point inside" do
+		is_expected.to be_include_point(Vector[0.2, 0.2])
+	end
+end
+
+RSpec.describe Geospatial::Map.for_earth(22) do
+	include_context "kaikoura region"
+	
+	it "should contain some prefixes" do
+		expect(filter.ranges).to_not be_empty
+	end
+	
+	it "should contain kaikoura" do
+		point = subject.point_for_object(kaikoura)
+		expect(filter).to include(point)
+	end
+end
+
+RSpec.describe Geospatial::Polygon do
+	include_context "kaikoura region"
+	
+	it "can generate visualisation" do
+		map = Geospatial::Map.for_earth
+		
+		map << kaikoura
+		
+		Geospatial::Visualization.for_map(map) do |pdf, origin|
+			region.edges do |pa, pb|
+				pdf.line (origin + pa).to_a, (origin + pb).to_a
+			end
+			
+			#count = 0
+			map.traverse(region, depth: map.order - 15) do |child, prefix, order|
+				#count += 1
+				size = child.size
+				top_left = (origin + child.min) + Vector[0, size[1]]
+				pdf.rectangle(top_left.to_a, *size.to_a)
+				# puts "#{top_left.to_a} #{size.to_a}"
+			end
+			
+			#puts "count=#{count}"
+			
+			pdf.fill_and_stroke
+		end.render_file "polygon.pdf"
+	end
+end

data/spec/geospatial/sorted.rb

@@ -0,0 +1,6 @@
+
+module Enumerable
+	def sorted?
+		each_cons(2).all?{|a,b| (a <=> b) <= 0}
+	end
+end

data/spec/geospatial/visualization.rb

@@ -0,0 +1,46 @@
+
+require 'geospatial/map'
+require 'prawn'
+
+module Geospatial
+	module Visualization
+		def self.for_map(map)
+			margin = 10
+			scale = 16.0
+			size = map.bounds.size.to_a
+			half_size = size.map{|i| i.to_f / 2}
+			origin = [size[0] / 2, size[1] / 2]
+			
+			pdf = Prawn::Document.new(
+				page_size: [(size[0] + 40) * scale, (size[1] + 40) * scale],
+				margin: 20,
+			)
+			
+			pdf.line_width 0.001
+			pdf.scale(scale)
+			
+			world_path = File.expand_path("world.png", __dir__)
+			pdf.image world_path, :at => [0, 180], width: 360, height: 180
+			
+			pdf.stroke_axis(step_length: 45)
+			
+			pdf.transparent(0.3, 0.9) do
+				pdf.stroke_color "000000"
+				pdf.fill_color "00abcc"
+				
+				yield pdf, Vector[*origin]
+			
+				pdf.fill_color "00ff00"
+				
+				map.points.each do |point|
+					center =  [origin[0] + point[0], origin[1] + point[1]]
+					pdf.circle center, 0.1
+				end
+				
+				pdf.fill
+			end
+			
+			return pdf
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geospatial
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,13 +66,36 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- australia.png
 - geospatial.gemspec
 - lib/geospatial.rb
+- lib/geospatial/box.rb
+- lib/geospatial/circle.rb
+- lib/geospatial/dimensions.rb
+- lib/geospatial/filter.rb
 - lib/geospatial/hilbert.rb
+- lib/geospatial/hilbert/curve.rb
+- lib/geospatial/hilbert/traverse.rb
+- lib/geospatial/index.rb
+- lib/geospatial/interleave.rb
 - lib/geospatial/location.rb
+- lib/geospatial/map.rb
+- lib/geospatial/map/index.rb
+- lib/geospatial/polygon.rb
 - lib/geospatial/version.rb
-- spec/geoquery/hilbert_spec.rb
-- spec/geoquery/location_spec.rb
+- spec/geospatial/box_spec.rb
+- spec/geospatial/circle_spec.rb
+- spec/geospatial/dimensions_spec.rb
+- spec/geospatial/hilbert_curve_spec.rb
+- spec/geospatial/hilbert_traverse_spec.rb
+- spec/geospatial/index_spec.rb
+- spec/geospatial/location_spec.rb
+- spec/geospatial/map_index_spec.rb
+- spec/geospatial/map_spec.rb
+- spec/geospatial/polygon_spec.rb
+- spec/geospatial/sorted.rb
+- spec/geospatial/visualization.rb
+- spec/geospatial/world.png
 homepage: https://github.com/ioquatix/geospatial
 licenses:
 - MIT
@@ -93,10 +116,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Provides abstractions for dealing with geographical locations efficiently
 test_files:
-- spec/geoquery/hilbert_spec.rb
-- spec/geoquery/location_spec.rb
+- spec/geospatial/box_spec.rb
+- spec/geospatial/circle_spec.rb
+- spec/geospatial/dimensions_spec.rb
+- spec/geospatial/hilbert_curve_spec.rb
+- spec/geospatial/hilbert_traverse_spec.rb
+- spec/geospatial/index_spec.rb
+- spec/geospatial/location_spec.rb
+- spec/geospatial/map_index_spec.rb
+- spec/geospatial/map_spec.rb
+- spec/geospatial/polygon_spec.rb
+- spec/geospatial/sorted.rb
+- spec/geospatial/visualization.rb
+- spec/geospatial/world.png

data/spec/geoquery/hilbert_spec.rb

@@ -1,72 +0,0 @@
-# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require 'geospatial/hilbert'
-
-module Geospatial::HilbertSpec
-	describe Geospatial::Hilbert do
-		it "base case should be identity" do
-			# The base case for our coordinate system:
-			expect(Geospatial::Hilbert.rotate(0, 0)).to be == 0
-			expect(Geospatial::Hilbert.rotate(0, 1)).to be == 1
-			expect(Geospatial::Hilbert.rotate(0, 2)).to be == 2
-			expect(Geospatial::Hilbert.rotate(0, 3)).to be == 3
-		end
-		
-		it "rotation is self-inverting" do
-			4.times do |rotation|
-				4.times do |quadrant|
-					# rotate(rotation, rotate(rotation, quadrant)) == quadrant
-					rotated = Geospatial::Hilbert.rotate(rotation, quadrant)
-					expect(Geospatial::Hilbert.rotate(rotation, rotated)).to be == quadrant
-				end
-			end
-		end
-		
-		it "compute the correct hash of order=0" do
-			expect(Geospatial::Hilbert.hash(0, 0, 0)).to be == 0
-			expect(Geospatial::Hilbert.hash(1, 0, 0)).to be == 1
-			expect(Geospatial::Hilbert.hash(1, 1, 0)).to be == 2
-			expect(Geospatial::Hilbert.hash(0, 1, 0)).to be == 3
-		end
-		
-		it "compute the correct hash of order=1" do
-			expect(Geospatial::Hilbert.hash(0, 0, 1)).to be == 0
-			expect(Geospatial::Hilbert.hash(1, 0, 1)).to be == 1
-			expect(Geospatial::Hilbert.hash(1, 1, 1)).to be == 2
-			expect(Geospatial::Hilbert.hash(0, 1, 1)).to be == 3
-			
-			expect(Geospatial::Hilbert.hash(0, 2, 1)).to be == 4
-			expect(Geospatial::Hilbert.hash(0, 3, 1)).to be == 5
-			expect(Geospatial::Hilbert.hash(1, 3, 1)).to be == 6
-			expect(Geospatial::Hilbert.hash(1, 2, 1)).to be == 7
-			
-			expect(Geospatial::Hilbert.hash(2, 2, 1)).to be == 8
-			expect(Geospatial::Hilbert.hash(2, 3, 1)).to be == 9
-			expect(Geospatial::Hilbert.hash(3, 3, 1)).to be == 10
-			expect(Geospatial::Hilbert.hash(3, 2, 1)).to be == 11
-			
-			expect(Geospatial::Hilbert.hash(3, 1, 1)).to be == 12
-			expect(Geospatial::Hilbert.hash(2, 1, 1)).to be == 13
-			expect(Geospatial::Hilbert.hash(2, 0, 1)).to be == 14
-			expect(Geospatial::Hilbert.hash(3, 0, 1)).to be == 15
-		end
-	end
-end