cross-track-distance 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b05d000da965d6dfe0265cf0f105433f50544dc1
+  data.tar.gz: 2d35561f38a791992601d71e90f91e5b8277bf0e
+SHA512:
+  metadata.gz: 25b09e56fdd03be848096a1c910efc153febf0b7486b84c55c7bc6eb715a9d3d68393bcd50d13e47aeedb9973a93c3bec4ec4e1f1b834105b727e0c585edaad4
+  data.tar.gz: 2883284b387caaaf2e6cf7bbe89b358f8e3c3c18871c55d63bb0dad90f2a66810c687833dba20c2821aa53ccb6af828798c0bcbb2a12296909701248735f01af

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 merlos
+
+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,55 @@
+# Cross::Track::Distance
+Uber simple gem to calculate the cross track distance (aka cross track error).
+
+Suppose you are proceeding on a great circle route from `start_segment_pt` to `end_segment_pt` but you are at `point`, You can calculate the shortest distance to the segment that conforms the route
+
+```
+  start_segment_pt  * ------+------------------ * end_segment
+                            |
+                            |
+                            * point
+```
+If `start_segment_pt`, `end_segment_pt` and  `point` are given in __latitude and longitude__ (WGS84), and the radius of the great circle is the Earth, you can use this gem to calculate the shortest distance from point to the segment line also called cross track distance or cross track error.
+
+You have more info abou the theory behind the formula in these links:
+
+* This gem is based on http://www.movable-type.co.uk/scripts/latlong.html
+* You also have more information on http://williams.best.vwh.net/avform.htm#XTE
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cross-track-distance'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cross-track-distance
+
+## Usage
+
+```ruby
+require 'cross/track/distance'
+
+segment_start = {lat: 53.3206, lon: -1.7297}
+segment_end = {lat: 53.1887, lon: 0.1334}
+point = {lat: 53.2611, lon: -0.7972}
+
+puts Cross::Track::Distance.cross_track_distance(segment_start,segment_end,point)
+# => -307.549570418756
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/merlos/cross-track-distance.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cross/track/distance"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cross-track-distance.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cross/track/distance/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cross-track-distance"
+  spec.version       = Cross::Track::Distance::VERSION
+  spec.authors       = ["merlos"]
+  spec.email         = ["jmmerlos@merlos.org"]
+  spec.summary       = %q{Cross track error / Cross track distance calculator}
+  spec.description   = %q{Gem to calculate the distance of a point to a segment on a great circle.}
+  spec.homepage      = "http://github.com/merlos/cross-track-distance."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "haversine", "~>0.3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/cross/track/distance.rb

@@ -0,0 +1,85 @@
+require "cross/track/distance/version"
+require "haversine"
+# Based on http://www.movable-type.co.uk/scripts/latlong.html
+#
+
+# helper methods
+class Float
+ def to_rad
+   self*Math::PI/180
+  end
+  def to_deg
+   180*self/Math::PI
+ end
+end
+
+module Cross
+  module Track
+    module Distance
+
+
+
+        # Earth ratio in meters
+        @@R = 6371000
+
+        #
+        # http://www.movable-type.co.uk/scripts/latlong.html
+
+        def self.bearing(from, to)
+          #  see http://mathforum.org/library/drmath/view/55417.html
+          # phi_1 = from.lat to radians
+          # phi_2 = to.lat to radians
+          # delta_lambda = to.lon - from.lon to radians
+          # y = sin(d_lambda) * cos(phi_2)
+          # x = cos(phi_1) * sin(phi_2) - sin(phi_1)*cos(phi_2) * cos(delta_lambda)
+          # thita = atan2(y, x)
+          # (thita to_degrees  + 360) % 360)
+          phi_1 = from[:lat].to_rad
+          phi_2 = to[:lat].to_rad
+          delta_lambda= (to[:lon] - from[:lon]).to_rad
+          y = Math::sin(delta_lambda) * Math::cos(phi_2)
+          x = Math::cos(phi_1) * Math::sin(phi_2) - Math::sin(phi_1) * Math::cos(phi_2) * Math::cos(delta_lambda)
+          thita = Math::atan2(y,x)
+          #puts from
+          #puts to
+          #puts phi_1
+          #puts phi_2
+          #puts delta_lambda
+          #puts y
+          #puts x
+          #puts thita
+          (thita.to_deg + 360) % 360
+        end
+        #
+        #
+        # Calculates the shortest distance from point to the segment line on a great circle.
+        # segment_start_pt is point in which the segment starts. It's a hash with :lat and :lon
+        # segment_end_pt is point in which the segment ends. It's a hash with :lat and :lon
+        # point is the point to calculate the distance to the segment.
+        #
+        # Returns the distance in meters
+        def self.cross_track_distance(segment_start_pt, segment_end_pt, point)
+          #var δ13 = pathStart.distanceTo(this, radius)/radius;
+          #var θ13 = pathStart.bearingTo(this).toRadians();
+          #var θ12 = pathStart.bearingTo(pathEnd).toRadians();
+          #var dxt = Math.asin( Math.sin(δ13) * Math.sin(θ13-θ12) ) * radius;
+
+          #puts segment_start_pt
+          #puts segment_end_pt
+          #puts point
+
+          delta_13 = Haversine.distance(segment_start_pt[:lat],segment_start_pt[:lon],point[:lat],point[:lon]).to_m / @@R
+          thita_13 = Cross::Track::Distance::bearing(segment_start_pt, point).to_rad
+          thita_12 = Cross::Track::Distance::bearing(segment_start_pt, segment_end_pt).to_rad
+
+          #puts delta_13
+          #puts thita_13
+          #puts thita_12
+
+          Math::asin(Math::sin(delta_13) * Math::sin(thita_13 - thita_12) ) * @@R
+
+        end
+      # Your code goes here...
+    end
+  end
+end

data/lib/cross/track/distance/version.rb

@@ -0,0 +1,7 @@
+module Cross
+  module Track
+    module Distance
+      VERSION = "1.0.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: cross-track-distance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- merlos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haversine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Gem to calculate the distance of a point to a segment on a great circle.
+email:
+- jmmerlos@merlos.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cross-track-distance.gemspec
+- lib/cross/track/distance.rb
+- lib/cross/track/distance/version.rb
+homepage: http://github.com/merlos/cross-track-distance.
+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: Cross track error / Cross track distance calculator
+test_files: []