trilateration 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 350d570c17ec97de89bffff8e3757d11dc8262fa
+  data.tar.gz: 73e954901be4f704167e4be47e2e1470ef58dd56
+SHA512:
+  metadata.gz: 11dbff7b5605c81e604ac64e7fd4edc4e39de5bd863e4abfe5a96496e7d3e86081da97b38b8694fb0d5535fc2723adc1f4c81b76cbe55b0616d7592275f1372a
+  data.tar.gz: 818e40d6413fd5960b4bd511eea7bcddb95d7b0668552edc56ea93ae663154725571a0e759bf624e4a25324959ad801a1332048a1a7db7b52827eb84e1247cdd

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 patrickread
+
+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

@@ -0,0 +1,10 @@
+Trilateration calculates the position of an unknown point, using the distance from three known points to it.
+
+Example Usage:
+
+p1 = Trilateration::Point.new(1,2)
+p2 = Trilateration::Point.new(8,6)
+p3 = Trilateration::Point.new(1,6)
+tri = Trilateration::Calculate.new(p1, p2, p3)
+
+output = tri.calculate_from_distances(4.02305854, 4.43677811, 3.87104637)

data/lib/trilateration.rb

@@ -0,0 +1,2 @@
+require 'trilateration/calculate'
+require 'trilateration/point'

data/lib/trilateration/calculate.rb

@@ -0,0 +1,62 @@
+module Trilateration
+  class Calculate
+    attr_accessor :point1, :point2, :point3, :rel_point1, :rel_point2, :rel_point3
+
+    # where point1 is our origin, and p2 and p3 are two other
+    # sensors in which we know the relative positions
+    def initialize p1, p2, p3
+      @point1 = p1
+      @point2 = p2
+      @point3 = p3
+
+      # adjust all the points so that they are relative to p1
+      @rel_point1 = Point.new(0, 0, 0)
+      @rel_point2 = get_relative_point(@point2, @point1)
+      @rel_point3 = get_relative_point(@point3, @point1)
+    end
+
+    # Trilaterating an X,Y coordinate of an object based on its distance 
+    # from three sensor points which are at known coordinate positions
+    # input: target point relative to the first sensor
+    def calculate_from_distances dist1, dist2, dist3
+      x = ((dist1 ** 2) - (dist2 ** 2) + (@rel_point2.x ** 2)) / (2 * @rel_point2.x)
+
+      a = ((dist1 ** 2) - (dist3 ** 2) + (@rel_point3.x ** 2) + (@rel_point3.y ** 2)) / (2 * @rel_point3.y)
+      b = (@rel_point3.x * dist1) / @rel_point3.y
+
+      y = a - b
+
+      z = ((dist1 ** 2) - (x ** 2) - (y ** 2)) ** 0.5
+      
+      Point.new(x, y, z)
+    end
+
+    # used similarly as calculate_from_distances, except this is a test method
+    # input: a target point whose coordinates from @point1 are already known,
+    # in order to test the trilateration algorithm quickly
+    def calculate_from_test_point target_point
+      rel_target_point = get_relative_point(target_point, @point1)
+      dist1 = calculate_dist1(rel_target_point)
+      dist2 = calculate_dist2(rel_target_point)
+      dist3 = calculate_dist3(rel_target_point)
+
+      calculate_from_distances(dist1, dist2, dist3)    
+    end
+
+    def get_relative_point relative_point, origin_point
+      Point.new(relative_point.x - origin_point.x, relative_point.y - origin_point.y, relative_point.z - origin_point.z)
+    end
+
+    def calculate_dist1 target_point
+      ((target_point.x ** 2) + (target_point.y ** 2) + (target_point.z ** 2)) ** 0.5
+    end
+
+    def calculate_dist2 target_point
+      (((target_point.x - @rel_point2.x) ** 2) + (target_point.y ** 2) + (target_point.z ** 2)) ** 0.5
+    end
+
+    def calculate_dist3 target_point
+      (((target_point.x - @rel_point3.x) ** 2) + ((target_point.y - @rel_point3.y) ** 2) + (target_point.z ** 2)) ** 0.5
+    end
+  end
+end

data/lib/trilateration/point.rb

@@ -0,0 +1,24 @@
+module Trilateration
+  class Point
+    attr_accessor :x, :y, :z
+
+    # Third dimension is optional
+    def initialize pointX, pointY, pointZ=0
+      @x = pointX
+      @y = pointY
+      @z = pointZ
+    end
+
+    def x_rounded
+      @x.round(3)
+    end
+
+    def y_rounded
+      @y.round(3)
+    end
+
+    def z_rounded
+      @z.round(3)
+    end
+  end
+end

data/tests/test_trilateration.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require "minitest/autorun"
+require_relative '../lib/trilateration.rb'
+require_relative '../lib/point.rb'
+
+class TrilaterationTest < Minitest::Test
+
+  def test_trilateration
+    p1 = Point.new(1,2)
+    p2 = Point.new(8,6)
+    p3 = Point.new(1,6)
+    tri = Trilateration.new(p1, p2, p3)
+
+    test_output = tri.calculate_from_test_point(Point.new(4.25, 4.15, 1))
+    output = tri.calculate_from_distances(4.02305854, 4.43677811, 3.87104637)
+
+    assert_equal(test_output.x_rounded, output.x_rounded, "X Coordinate is not correct")
+    assert_equal(test_output.y_rounded, output.y_rounded, "Y Coordinate is not correct")
+
+    if (!test_output.z.is_a?(Complex))
+      refute_kind_of(Complex, output.z, "Z Coordinate shouldn't be a Complex")
+      assert_equal(test_output.z_rounded, output.z_rounded, "Z Coordinate is not correct")
+    end
+  end
+end

data/trilateration.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'trilateration'
+  s.version     = '0.0.1'
+  s.date        = '2014-05-29'
+  s.summary     = "Performs a trilateration operation in order to find an unknown point in a Cartesian coordinate system."
+  s.description = "Trilateration calculates the position of an unknown point, using the distance from three known points to it."
+  s.authors     = ["Patrick Read"]
+  s.email       = 'pread13@gmail.com'
+  s.files       = %w(LICENSE README.md trilateration.gemspec)
+  s.files       += Dir.glob('lib/**/*.rb')
+  s.files       += Dir.glob('spec/**/*')
+  s.test_files  = Dir.glob('tests/**/*')
+  s.homepage    = 'https://github.com/patrickread/trilateration'
+  s.license     = 'MIT'
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: trilateration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrick Read
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies: []
+description: Trilateration calculates the position of an unknown point, using the
+  distance from three known points to it.
+email: pread13@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/trilateration.rb
+- lib/trilateration/calculate.rb
+- lib/trilateration/point.rb
+- tests/test_trilateration.rb
+- trilateration.gemspec
+homepage: https://github.com/patrickread/trilateration
+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: Performs a trilateration operation in order to find an unknown point in a
+  Cartesian coordinate system.
+test_files:
+- tests/test_trilateration.rb