tallakt-gpsspeed 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-02-15
+
+* First working version
+

data/LICENSE

@@ -0,0 +1,24 @@
+
+
+The MIT License
+
+Copyright (c) 2009 Tallak Tveide
+
+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/Manifest.txt

@@ -0,0 +1,17 @@
+bin/gpsspeed
+gpsspeed.gemspec
+History.txt
+lib/gpsspeed/runner.rb
+lib/gpsspeed.rb
+LICENSE
+Manifest.txt
+PostInstall.txt
+Rakefile
+README.rdoc
+script/console
+script/generate
+script/destroy
+test/test_helper.rb
+test/test_gpsspeed.rb
+test/input/test_walk.gpx
+test/input/tracks.gpx

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on gpsspeed, see http://gpsspeed.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,92 @@
+= gpsspeed
+
+http://github.com/tallakt/plcutil
+
+== DESCRIPTION:
+
+GPS Track speed calculation utility
+
+== FEATURES/PROBLEMS:
+
+This utility will take a gpx file as input (created for instance by http://www.easygps.com/)
+and display the statistics for the best speeds of the tracks in the file over a certain 
+distance that may be supplied
+
+== SYNOPSIS:
+
+A starting point for using gpsspeed, try the --help option
+
+  gpsspeed --help
+
+  Usage: gpsspeed [options] <input.gpx>
+      -l, --length DIST                Minimum required length (default 500m)
+                                         Accepts km,m,ft,miles,nm
+      -s, --speed-format FMT           Select speed format (default m/s)
+                                         Accepts knots,mph,m/s,km/h
+      -f, --length-format FMT          Select length format (default m)
+                                         Accepts km,m,ft,miles,nm
+      -h, --help                       Show this message
+
+
+A common usage would be to run the command without any special options
+
+  gpsspeed myfile.gpx
+
+Which gives you an output like this
+
+  Speed [m/s]      #frm       #to        #n            time [s]        Distance [m]
+       1.6411         4         9         6               65.00               106.7
+       1.4037        13        19         7               77.00               108.1
+
+The utility finds the highest speeds in the track file over a
+minimum distance. The best runs are listed in descending order
+(ie. fastest run first). To use a different length, use the -l
+parameter
+
+  gpsspeed -l 200m myfile.gpx
+
+To display the results in different units, use the -s and -f 
+options, like this
+
+  gpsspeed -s knots -f nm
+
+Which gives you a result table like this
+
+Speed [knots]      #frm       #to        #n            time [s]       Distance [nm]
+       3.1901         4         9         6               65.00              0.0576
+       2.7285        13        19         7               77.00              0.0584
+                                   
+                                   
+== REQUIREMENTS:
+
+Requires the gem tallakt-geoutm 
+
+== INSTALL:
+
+  sudo gem sources -a http://gems.github.com
+  sudo gem install tallakt-gpsspeed
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Tallak Tveide
+
+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,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/gpsspeed'
+require 'geoutm'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('gpsspeed', Gpsspeed::VERSION) do |p|
+  p.developer('Tallak Tveide', 'tallak@tveide.net')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['tallakt-geoutm',">= #{::GeoUtm::VERSION}"],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/bin/gpsspeed

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gpsspeed/runner.rb'
+GPSSpeed::Runner.new ARGV

data/gpsspeed.gemspec

@@ -0,0 +1,44 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gpsspeed}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tallak Tveide"]
+  s.date = %q{2009-02-16}
+  s.default_executable = %q{gpsspeed}
+  s.description = %q{GPS Track speed calculation utility}
+  s.email = ["tallak@tveide.net"]
+  s.executables = ["gpsspeed"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["bin/gpsspeed", "gpsspeed.gemspec", "History.txt", "lib/gpsspeed/runner.rb", "lib/gpsspeed.rb", "LICENSE", "Manifest.txt", "PostInstall.txt", "Rakefile", "README.rdoc", "script/console", "script/generate", "script/destroy", "test/test_helper.rb", "test/test_gpsspeed.rb", "test/input/test_walk.gpx", "test/input/tracks.gpx"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tallakt/plcutil}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{gpsspeed}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{GPS Track speed calculation utility}
+  s.test_files = ["test/test_helper.rb", "test/test_gpsspeed.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<tallakt-geoutm>, [">= 0.0.3"])
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<tallakt-geoutm>, [">= 0.0.3"])
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<tallakt-geoutm>, [">= 0.0.3"])
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/lib/gpsspeed.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Gpsspeed
+  VERSION = '0.0.2'
+end

data/lib/gpsspeed/runner.rb

@@ -0,0 +1,159 @@
+require 'rexml/document'
+require 'ostruct'
+require 'geoutm'
+require 'enumerator'
+require 'optparse'
+
+class FloatA # necessary dt rexml bug
+  def each
+  end
+end
+
+module GPSSpeed
+  class Runner
+    DEFAULT_LENGTH = 500
+    DEFAULT_SPEED_FMT = 'm/s'
+    DEFAULT_LENGTH_FMT = 'm'
+
+    LengthUnits = {
+      'm' => 1.0,
+      'ft' => 3.2808399,
+      'km' => 0.001,
+      'miles' => 0.000621371192,
+      'nm' => 0.000539956803
+    }
+
+    SpeedUnits = {
+      'm/s' => 1.0,
+      'knots' => 1.9438612860586,
+      'km/h' => 3.6,
+      'mph' => 2.23693629
+    }
+
+    def initialize(argv)
+      # Command line options
+      @opt = {}
+      parse_options argv
+      @opt[:length] ||= DEFAULT_LENGTH # Minimum required distance 
+      @opt[:speed_fmt] ||= DEFAULT_SPEED_FMT
+      @opt[:length_fmt] ||= DEFAULT_LENGTH_FMT
+
+      filename, = argv
+
+      read_gpx filename
+      list_distance_speeds
+      filter_distance_speeds
+      print_results
+    end
+
+    def parse_length(l)
+      LengthUnits.each do |name, factor|
+        m = l.match /^(\d+(.\d+)?)\s?#{name}$/i
+        return m[1].to_f * factor if m
+      end
+      m = l.match /^(\d+(.\d+)?)$/i
+      throw RuntimeError.new('Illegal length format: ' + l) unless m
+      m[1].to_f
+    end
+
+    def parse_options(argv)
+      OptionParser.new do |op|
+        op.banner = "Usage: gpsspeed [options] <input.gpx>"
+        op.on("-l", "--length DIST", "Minimum required length (default #{DEFAULT_LENGTH}m)",
+                "  Accepts #{LengthUnits.keys.join ','}") do |l|
+          @opt[:length] = parse_length l
+        end
+        op.on("-s", "--speed-format FMT", "Select speed format (default #{DEFAULT_SPEED_FMT})",
+                "  Accepts #{SpeedUnits.keys.join ','}") do |fmt|
+          @opt[:speed_fmt] = fmt
+        end
+        op.on("-f", "--length-format FMT", "Select length format (default #{DEFAULT_LENGTH_FMT})",
+                "  Accepts #{LengthUnits.keys.join ','}") do |fmt|
+          @opt[:length_fmt] = fmt
+        end
+        op.on_tail("-h", "--help", "Show this message") do
+          puts op
+          exit
+        end
+      end.parse! argv
+    end
+
+    def read_gpx filename
+      throw RuntimeError.new("Please specify file name") unless filename
+      doc = nil
+      File.open filename do |f|
+        doc = REXML::Document.new f
+      end
+
+      @points = []
+      REXML::XPath.each doc, '//trkpt' do |trkpt|
+        lat = trkpt.attributes['lat']
+        lon = trkpt.attributes['lon']
+        date_time = DateTime.strptime trkpt.get_elements('time').first.text
+        pp = OpenStruct.new
+        pp.latlon = GeoUtm::LatLon.new lat.to_f, lon.to_f
+        pp.utm = pp.latlon.to_utm GeoUtm::Ellipsoid::lookup(:wgs84), @points.first && @points.first.utm.zone
+        pp.date_time = date_time
+        @points << pp
+      end
+      @points.sort! {|a, b| a.date_time <=> b.date_time }
+      # puts "Read #{@points.size} track points"
+    end
+
+    def list_distance_speeds
+      @dist_speed_list = []
+      (0..(@points.size - 2)).each do |i|
+        ((i + 1)..(@points.size - 1)).each do |j|
+          dist = @points[i].utm.distance_to @points[j].utm
+          next if dist < @opt[:length]
+          ds = OpenStruct.new
+          ds.distance = dist
+          ds.begin = i
+          ds.end = j
+          ds.dt = (@points[j].date_time - @points[i].date_time) * 24.0 * 60.0 * 60.0
+          ds.speed_ms = dist / ds.dt
+          @dist_speed_list << ds
+          break
+        end
+      end
+    end
+
+    def filter_distance_speeds
+      @dist_speed_list.sort! {|a, b| a.speed_ms <=> b.speed_ms }.reverse!
+      @dist_speed_list.reject! do |candidate|
+        intersects_previous candidate
+      end
+    end
+
+    def intersects_previous candidate
+      intersects = nil
+      @dist_speed_list[0...@dist_speed_list.index(candidate)].each do |prev|
+        used = prev.begin..prev.end
+        intersects ||= ((prev.begin..prev.end).to_a & (candidate.begin..candidate.end).to_a).any?
+        break if intersects
+      end
+      intersects
+    end
+
+    def print_results
+      puts '%20s%10s%10s%10s%20s%20s' % 
+        ["Speed [#{@opt[:speed_fmt]}]", '#frm', '#to', '#n', 'time [s]', "Distance [#{@opt[:length_fmt]}]"]
+      (@dist_speed_list[0..39] || []).each do |ds|
+        puts "%20.4f%10i%10i%10i%20.2f#{length_printf_fmt(20)}" % [speed_conv(ds.speed_ms), ds.begin, 
+          ds.end, ds.end - ds.begin + 1, ds.dt, length_conv(ds.distance)]
+      end
+    end
+
+    def speed_conv(speed)
+      speed * SpeedUnits[@opt[:speed_fmt]]
+    end
+
+    def length_conv(length)
+      length * LengthUnits[@opt[:length_fmt]]
+    end
+
+    def length_printf_fmt(width)
+      "%#{width}.#{-Math::log10(LengthUnits[@opt[:length_fmt]]).to_i + 1}f"
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/gpsspeed.rb'}"
+puts "Loading gpsspeed gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)