geospatial 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a5d010173b1e91d60be3e2c07e0e89a95ccb000
+  data.tar.gz: 5df99174a2639bc48dca1b84f26a149e2c8b3e92
+SHA512:
+  metadata.gz: c4eb89aa1b47b77313d8c68abaa95d2d83660b040dead60be19823d69fc5aeb0b4c67d529caf573e677ab4eba7496673c3859797bafc2f0ba0cec3fd52bc31c9
+  data.tar.gz: 3177ebab37d176ec50b98db396ce0cb964a071e5f8994ae2d14f1da00d0ca4023a7aac13126cfaca96c5870cbae02d5b0544f321b79bde38793521edaf2057f8

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color 
+--format documentation 

data/.simplecov

@@ -0,0 +1,9 @@
+
+SimpleCov.start do
+	add_filter "/spec/"
+end
+
+if ENV['TRAVIS']
+	require 'coveralls'
+	Coveralls.wear!
+end

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+env: COVERAGE=true

data/Gemfile

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

data/README.md

@@ -0,0 +1,57 @@
+# Geospatial
+
+Geospatial provides abstractions for dealing with geographical locations efficiently.
+
+[![Build Status](https://secure.travis-ci.org/ioquatix/geospatial.png)](http://travis-ci.org/ioquatix/geospatial)
+[![Code Climate](https://codeclimate.com/github/ioquatix/geospatial.png)](https://codeclimate.com/github/ioquatix/geospatial)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/geospatial/badge.svg)](https://coveralls.io/r/ioquatix/geospatial)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'geospatial'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geospatial
+
+## Usage
+
+...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT license.
+
+Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
+end
+
+task :default => :spec

data/geospatial.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geospatial/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "geospatial"
+	spec.version       = Geospatial::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.summary       = %q{Provides abstractions for dealing with geographical locations efficiently}
+	spec.homepage      = "https://github.com/ioquatix/geospatial"
+	spec.license       = "MIT"
+
+	spec.files         = `git ls-files -z`.split("\x0")
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "rspec", "~> 3.1.0"
+
+	spec.add_development_dependency "bundler", "~> 1.6"
+	spec.add_development_dependency "rake"
+end

data/lib/geospatial/hilbert.rb

@@ -0,0 +1,106 @@
+
+module Geospatial
+	class Hilbert
+		# Quadrants are numbered 0 to 3, and are in the following order:
+		# y
+		# 1 | 3 | 2 |
+		# 0 | 0 | 1 |
+		#     0   1  x
+		# The origin is in the lower left, and the most rapidly changing value is along the x axis for the initial rotation.
+		
+		# Four quadrants/rotations, the direction indicates the axis of the final two coordinates (e.g. 2 -> 3) and is for informal use only.
+		A = 0 # LEFT
+		# | 3 | 2 |
+		# | 0 | 1 |
+		
+		B = 1 # DOWN
+		# | 1 | 2 |
+		# | 0 | 3 |
+		
+		C = 2 # RIGHT
+		# | 1 | 0 |
+		# | 2 | 3 |
+		
+		D = 3 # UP
+		# | 3 | 0 |
+		# | 2 | 1 |
+		
+		# This maps the identity rotation/quadrants into their prefix quadrant. The prefix quadrant is the 2 bit number (0 to 3) which identifies along the curve which quadrant the value falls into. This can be computed by looking at how the curve for a given rotation and looking at the correspondence between the identity quadrants and the curve's traversal.
+		ROTATE = [
+			[A, B, C, D], # A is the identity
+			[A, D, C, B], # Map A onto B.
+			[C, D, A, B], # Map A onto C.
+			[C, B, A, D], # Map A onto D.
+		].freeze
+		
+		# Rotate quadrant by rotation. The provided quadrant is with respect to the Up rotation.
+		# Note that this function is self-inverting in the sense that rotate(r, rotate(r, x)) == x.
+		def self.rotate(rotation, quadrant)
+			ROTATE[rotation][quadrant]
+		end
+		
+		# These prefixes are generated by the following graph:
+		# Rotation | 0 1 2 3 (Prefix)
+		#        A | B A A D
+		#        B | A B B C
+		#        C | D C C B
+		#        D | C D D A
+		# We can compute this matrix by looking how the given prefix quadrant maps onto a curve one level down the tree, given the current rotation. We identify that colums 1 and 2 are the same as the input so we take advantage of this by mapping only the columns which are different, i.e. for prefix 0 and 3.
+		
+		PREFIX0 = [B, A, D, C].freeze
+		PREFIX3 = [D, C, B, A].freeze
+		
+		# Given the current rotation and the prefix quadrant, compute the next rotation one level down the tree.
+		def self.next_rotation(rotation, prefix)
+			if prefix == 0
+				PREFIX0[rotation]
+			elsif prefix == 3
+				PREFIX3[rotation]
+			else
+				rotation
+			end
+		end
+		
+		# Compute which quadrant this bit is in.
+		def self.normalized_quadrant(x, y, bit_offset)
+			mask = 1 << bit_offset
+			
+			if (y & mask) == 0
+				if (x & mask) == 0
+					return 0
+				else
+					return 1
+				end
+			else
+				if (x & mask) == 0
+					return 3
+				else
+					return 2
+				end
+			end
+		end
+		
+		def self.hash(x, y, order)
+			result = 0
+			# The initial rotation depends on the order:
+			rotation = order.even? ? A : B
+			
+			order.downto(0) do |i|
+				# This computes the normalized quadrant for the ith bit of x, y:
+				quadrant = self.normalized_quadrant(x, y, i)
+				
+				# Given the normalised quadrant, compute the prefix bits for the given quadrant for the given hilbert curve rotation:
+				prefix = rotate(rotation, quadrant)
+				
+				# These both do the same thing, not sure which one is faster:
+				result = (result << 2) | prefix
+				#result |= (rotated << (i * 2))
+				
+				# Given the current rotation and the prefix for the hilbert curve, compute the next rotation one level in:
+				rotation = next_rotation(rotation, prefix)
+			end
+			
+			return result
+		end
+	end
+end

data/lib/geospatial/location.rb

@@ -0,0 +1,134 @@
+
+module Geospatial
+	# This location is specifically relating to a WGS84 coordinate on Earth.
+	class Location
+		# WGS 84 semi-major axis constant in meters
+		WGS84_A = 6378137.0
+		# WGS 84 semi-minor axis constant in meters
+		WGS84_B = 6356752.3
+		
+		EARTH_RADIUS = (WGS84_A + WGS84_B) / 2.0
+		
+		# WGS 84 eccentricity
+		WGS84_E = 8.1819190842622e-2
+
+		# Radians to degrees multiplier
+		R2D = (180.0 / Math::PI)
+		D2R = (Math::PI / 180.0)
+
+		MIN_LATITUDE = -90.0 * D2R
+		MAX_LATITUDE = 90 * D2R
+		VALID_LATITUDE = MIN_LATITUDE...MAX_LATITUDE
+		
+		MIN_LONGITUDE = -180 * D2R
+		MAX_LONGITUDE = 180 * D2R
+		VALID_LONGITUDE = MIN_LONGITUDE...MAX_LONGITUDE
+		
+		def initialize(latitude, longitude, altitude = 0)
+			@latitude = latitude
+			@longitude = longitude
+			@altitude = altitude
+		end
+		
+		def valid?
+			VALID_LATITUDE.include? latitude and VALID_LONGITUDE.include? longitude
+		end
+		
+		def to_s
+			"#<Location latitude=#{@latitude} longitude=#{@longitude.to_f} altitude=#{@altitude.to_f}>"
+		end
+		
+		alias inspect to_s
+		
+		attr :latitude
+		attr :longitude
+		attr :altitude
+		
+		# http://janmatuschek.de/LatitudeLongitudeBoundingCoordinates
+		def bounding_box(distance, radius = EARTH_RADIUS)
+			raise ArgumentError.new("Invalid distance or radius") if distance < 0 or radius < 0
+
+			# angular distance in radians on a great circle
+			angular_distance = distance / (radius + self.altitude)
+
+			min_latitude = (self.latitude * D2R) - angular_distance
+			max_latitude = (self.latitude * D2R) + angular_distance
+
+			if min_latitude > MIN_LAT and max_latitude < MAX_LAT
+				longitude_delta = Math::asin(Math::sin(angular_distance) / Math::cos(self.latitude * D2R))
+				
+				min_longitude = (self.longitude * D2R) - longitude_delta
+				min_longitude += 2.0 * Math::PI if (min_longitude < MIN_LON)
+				
+				max_longitude = (self.longitude * D2R) + longitude_delta;
+				max_longitude -= 2.0 * Math::PI if (max_longitude > MAX_LON)
+			else
+				# a pole is within the distance
+				min_latitude = [min_latitude, MIN_LAT].max
+				max_latitude = [max_latitude, MAX_LAT].min
+				
+				min_longitude = MIN_LON
+				max_longitude = MAX_LON
+			end
+			
+			return {
+				:latitude => Range.new(min_latitude * R2D, max_latitude * R2D),
+				:longitude => Range.new(min_longitude * R2D, max_longitude * R2D),
+			}
+		end
+		
+		# Converts latitude, longitude to ECEF coordinate system
+		def to_ecef(alt)
+			clat = Math::cos(lat * D2R)
+			slat = Math::sin(lat * D2R)
+			clon = Math::cos(lon * D2R)
+			slon = Math::sin(lon * D2R)
+		
+			n = WGS84_A / Math::sqrt(1.0 - WGS84_E * WGS84_E * slat * slat)
+		
+			x = (n + alt) * clat * clon
+			y = (n + alt) * clat * slon
+			z = (n * (1.0 - WGS84_E * WGS84_E) + alt) * slat
+	
+			return x, y, z
+		end
+	
+		def self.from_ecef(x, y, z)
+			# Constants (WGS ellipsoid)
+			a = WGS84_A
+			e = WGS84_E
+	
+			b = Math::sqrt((a*a) * (1.0-(e*e)))
+			ep = Math::sqrt(((a*a)-(b*b))/(b*b))
+			
+			p = Math::sqrt((x*x)+(y*y))
+			th = Math::atan2(a*z, b*p)
+			
+			lon = Math::atan2(y, x)
+			lat = Math::atan2((z+ep*ep*b*(Math::sin(th) ** 3)), (p-e*e*a*(Math::cos(th)**3)))
+			
+			n = a / Math::sqrt(1.0-e*e*(Math::sin(lat) ** 2))
+			alt = p / Math::cos(lat)-n
+	
+			return self.new(lat*R2D, lon*R2D, alt)
+		end
+		
+		# calculate distance in metres between us and something else
+		# ref: http://codingandweb.blogspot.co.nz/2012/04/calculating-distance-between-two-points.html
+		def distance_from(other_position)
+			rlat1 = self.latitude * D2R 
+			rlong1 = self.longitude * D2R 
+			rlat2 = other_position.latitude * D2R 
+			rlong2 = other_position.longitude * D2R 
+			
+			dlon = rlong1 - rlong2
+			dlat = rlat1 - rlat2
+			
+			a = Math::sin(dlat/2) ** 2 + Math::cos(rlat1) * Math::cos(rlat2) * Math::sin(dlon/2) ** 2
+			c = 2 * Math::atan2(Math::sqrt(a), Math::sqrt(1-a))
+			d = EARTH_RADIUS * c
+			
+			return d
+		end
+	end
+end

data/lib/geospatial/version.rb

@@ -0,0 +1,3 @@
+module Geospatial
+	VERSION = "0.0.1"
+end

data/lib/geospatial.rb

@@ -0,0 +1,4 @@
+require "geospatial/version"
+
+module Geospatial
+end

data/spec/geoquery/hilbert_spec.rb

@@ -0,0 +1,72 @@
+# 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

data/spec/geoquery/location_spec.rb

@@ -0,0 +1,32 @@
+# 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/location'
+
+module Geospatial::LocationSpec
+	describe Geospatial::Location do
+		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)
+		end
+	end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: geospatial
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- geospatial.gemspec
+- lib/geospatial.rb
+- lib/geospatial/hilbert.rb
+- lib/geospatial/location.rb
+- lib/geospatial/version.rb
+- spec/geoquery/hilbert_spec.rb
+- spec/geoquery/location_spec.rb
+homepage: https://github.com/ioquatix/geospatial
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.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