swissgrid 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NGEzZjZhYjc0ZTA4NmVkOTNjNGRlNGY0ZDc4ZjcxZmMwYTJjZWIyYQ==
-  data.tar.gz: !binary |-
-    YzNhYTA1MDZlMmZkZDg0NzI0OWI3YTRmYjU3YmMxNzZiMDFjYWI5NQ==
+SHA1:
+  metadata.gz: d90a1c3df85723960dc4bd5e3f2d3f7004ff9218
+  data.tar.gz: 9614ca7c3e477e9711ba47d975c55f4e2c662fb4
 SHA512:
-  metadata.gz: !binary |-
-    OGMwN2E5YjVkN2UwZmRlZDE3YWQwNDA3N2YzNjNiZGQxZTA3MWU3MzQ4Njdk
-    NGRmNzVlY2M1YWQ2OWNlMGY0ZDdjOTU2ZWQwZTBiYWQxNzhkM2YxY2I3Y2M2
-    NTNkZWI2NzAxNTgxODBiOGI2NDk1OGM1NGIzZDA3NWIyYTMyZjM=
-  data.tar.gz: !binary |-
-    YjVkNzA4MmUwMzNjNzc1NTIyNDlkN2IzYWY3NTMxMTZlZWMzZGRjMjQwNDFk
-    NDM0MWZiMzFkMmM1MTRkMjc1ZmY3NWI1YTUxYTgyMDAwNWRiNjFlNTQ1NDZm
-    NGFlZDNmY2Y1ZGQ2OGIzNTE0MDhhYjVhMDMyOTE5OWE5OGEyNzI=
+  metadata.gz: f4480b2a45b6d3687870e4aa660e4d2ce9de59bbbdad8f46d003382e480a2ff70e82dc2c8f840ed7f4d43637e747427f74ae1d4d59fd6941f342fe7731530f76
+  data.tar.gz: 65350e51fe8b301e4169798a97b8f27325fd4f554b8eb8bd471158aed440d1b5a790aa672ef0203b503677aa0a29ee24dd6393baabdc8bc0e21a842679db97e8

data/README.md

@@ -25,15 +25,42 @@ Require the swissgrid library as follows:
 ```ruby
 require 'swissgrid'
 ```
+
+###Swissgrid
+The swissgird library has currently two modules:
+
+ * CH1903 - responsible for CH1903 conversions
+ * WGS84 - responsible for WGS84 conversions
+ 
+If other conversions are needed just create an issue or make a pull request :-).
+
 ###From WGS84(GPS) to CH1903
+A WGS84 point can easily be converted to a CH1903 point as follows:
+
+```ruby
+ wgs84_point = [46.951082877, 7.438632495] # [lat, lon] Bern, The building of exact sciences.
+ ch1903_coord = Swissgrid::CH1903.from_wgs84(wgs84_point)
+```
+
+Or just use the following shortcut:
 
 ```ruby
- gps_point = [46.881908, 7.471829] # [lat, lon] Bern
- swiss_coord = Swissgrid::CH1903(gps_point)
+ wgs84_point = [46.951082877, 7.438632495] # [lat, lon] Bern, The building of exact sciences.
+ ch1903_coord = Swissgrid::CH1903(wgs84_point)
 ```
 ###From CH1903 to WGS84(GPS)
+The same way a CH1903 point can be converted to a WGS84 point:
+
+```
+ ch1903_point = [600_000, 200_000] # [y, x] Bern, The building of exact sciences.
+ wgs84_coord =  Swissgrid::WGS84.from_ch1903(ch1903_point)
+```
+
+
+Or just use the following shortcut:
+
 ```ruby
- ch1903_point = [600000, 200000] # [y, x] Bern
+ ch1903_point = [600_000, 200_000] # [y, x] Bern, The building of exact sciences.
  wgs84_coord =  Swissgrid::WGS84(ch1903_point)
 ```
 
@@ -49,6 +76,10 @@ require 'swissgrid'
 ```
 
 ##Changelog
+ * 0.1.1
+    * Refactor tests and codebase
+    * Update Readme
+    * Add comments
  * 0.1.0
     * Fix ch1903 to wgs84 conversion bug. Thanks @christianmeichtry.
  * 0.0.3

data/lib/swissgrid.rb

@@ -4,10 +4,21 @@ require 'swissgrid/wgs84'
 
 module Swissgrid
 
+
+  # Converts a WGS84 point to a CH1903 point.
+  #
+  # @param a_point [List] the WGS84 point to be converted.
+  # @return [List] the converted WGS84 point as CH1903 point.
+  #
   def self.CH1903(a_point)
-    Ch1903.from_wgs84(a_point)
+    CH1903.from_wgs84(a_point)
   end
 
+  # Converts a CH1903 point to a WGS84 point.
+  #
+  # @param a_point [List] the CH1903 point to be converted.
+  # @return [List] the converted CH1903 point as WGS84 point.
+  #
   def self.WGS84(a_point)
     WGS84.from_ch1903(a_point)
   end

data/lib/swissgrid/ch1903.rb

@@ -1,41 +1,58 @@
 module Swissgrid
 
-  module Ch1903
+  module CH1903
 
-    PHI_BERN = 169028.66
-    LAMBDA_BERN = 26782.5
-    SCALE = 10000
+    # Projection centre Bern
+    PHI_BERN = 169_028.66 # in meters
+    LAMBDA_BERN = 26_782.5 # in meters
+    SCALE = 10_000 # scale to unit 10000"
 
+
+    # Converts a CH1903 point to a WGS84 point.
+    #
+    # @param a_point [List] the CH1903 point to be converted.
+    # @return [List] the converted CH1903 point as WGS84 point.
+    #
     def self.from_wgs84(a_point)
       lat, lon, z = a_point
-      phi_sec = to_sexagesimal(lat)
-      lambda_sec = to_sexagesimal(lon)
+      phi_sec = to_arc_seconds(lat)
+      lambda_sec = to_arc_seconds(lon)
       lambda_prime = (lambda_sec - LAMBDA_BERN) / SCALE.to_f
       phi_prime = (phi_sec - PHI_BERN) / SCALE.to_f
+
+      # compute WGS84 point
       convert(lambda_prime, phi_prime, z)
     end
 
+
     private
 
+
+    # Computes the WGS84 point by means of the auxiliary parameters lambda', phi' and height h.
+    #
+    # @param lambda_prime [Float] auxiliary parameter lambda'.
+    # @param phi_prime [Float] auxiliary parameter phi'.
+    # @param h [Float] height h.
+    #
     def self.convert(lambda_prime, phi_prime, h)
       y = [
-          600072.37,
-          211455.93 * lambda_prime,
-          -10938.51 * lambda_prime * phi_prime,
+          600_072.37,
+          211_455.93 * lambda_prime,
+          -10_938.51 * lambda_prime * phi_prime,
           -0.36 * lambda_prime * (phi_prime ** 2),
           -44.54 * (lambda_prime ** 3)
       ].reduce(:+)
 
       x = [
-          200147.07,
-          308807.95 * phi_prime,
-          3745.25 * (lambda_prime ** 2),
+          200_147.07,
+          308_807.95 * phi_prime,
+          3_745.25 * (lambda_prime ** 2),
           76.63 * (phi_prime ** 2),
           -194.56 * (lambda_prime ** 2) * phi_prime,
           119.79 * (phi_prime ** 3)
       ].reduce(:+)
 
-      z = if h.nil?
+      z = if h.nil? # if nil do nothing
             h
           else
             [
@@ -45,22 +62,35 @@ module Swissgrid
             ].reduce(:+)
           end
 
-      z.nil? ? [y, x] : [y, x, z]
+      z.nil? ? [y, x] : [y, x, z] # if z is nil, remove z component
     end
 
 
-    def self.to_gps_triple(dec_degress)
-      degrees = dec_degress.to_i
-      minutes = (60*(dec_degress - degrees)).to_i
-      seconds = (60*(dec_degress - degrees) - minutes) * 60
+    # Converts decimal degrees to a DMS triple that consists of the parts degree, minutes and seconds.
+    #
+    # @param dec_degrees [Float] decimal degrees to be converted.
+    # @return [List] a triple [degree, minutes, seconds].
+    #
+    def self.to_dms_triple(dec_degrees)
+      degrees = dec_degrees.to_i
+      minutes = (60*(dec_degrees - degrees)).to_i
+      seconds = (60*(dec_degrees - degrees) - minutes) * 60
       [degrees, minutes, seconds]
     end
 
-    def self.to_sexagesimal(dec_degress)
-      degree, minutes, seconds = to_gps_triple(dec_degress)
+
+    # Converts decimal degrees to arc seconds.
+    #
+    # @param dec_degrees [Float] decimal degrees to be converted.
+    # @return [Float] arc seconds.
+    #
+    def self.to_arc_seconds(dec_degrees)
+      degree, minutes, seconds = to_dms_triple(dec_degrees)
       degree * 3600 + minutes * 60 + seconds
     end
 
   end
 
+  Ch1903 = CH1903 # to be compatible to previous versions
+
 end

data/lib/swissgrid/version.rb

@@ -1,3 +1,3 @@
 module Swissgrid
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/swissgrid/wgs84.rb

@@ -2,19 +2,36 @@ module Swissgrid
 
   module WGS84
 
-    Y_BERN = 600_000
-    X_BERN = 200_000
-    SCALE = 1_000_000
+    # Projection centre Bern
+    Y_BERN = 600_000 # in meters
+    X_BERN = 200_000 # in meters
+    SCALE = 1_000_000 # scale to unit 1000km
 
+
+    # Converts a WGS84 point to a CH1903 point.
+    #
+    # @param a_point [List] the WGS84 point to be converted.
+    # @return [List] the converted WGS84 point as CH1903 point.
+    #
     def self.from_ch1903(a_point)
       y, x , z = a_point
       y_prime = (y - Y_BERN) / SCALE.to_f
       x_prime = (x - X_BERN) / SCALE.to_f
+
+      # compute CH1903 point
       convert(y_prime, x_prime, z)
     end
 
+
     private
 
+
+    # Computes the CH1903 point by means of the auxiliary parameters y', x' and height h'.
+    #
+    # @param y_prime [Float] auxiliary parameter y'.
+    # @param x_prime [Float] auxiliary parameter x'.
+    # @param h_prime [Float] height h.
+    #
     def self.convert(y_prime, x_prime, h_prime)
       lambda_prime = [
           2.6779094,
@@ -33,7 +50,7 @@ module Swissgrid
           -0.0140  * (x_prime ** 3)
       ].reduce(:+)
 
-      z = if h_prime.nil?
+      z = if h_prime.nil? # if nil do nothing
             h_prime
           else
             [
@@ -44,7 +61,7 @@ module Swissgrid
           end
 
       lat, lon = [phi_prime, lambda_prime].map { |v| v * 100/36.to_f }
-      z.nil? ? [lat, lon] : [lat, lon, z]
+      z.nil? ? [lat, lon] : [lat, lon, z] # if z is nil, remove z component
     end
 
   end

data/spec/swissgrid_spec.rb

@@ -2,32 +2,164 @@ require 'spec_helper'
 
 module Swissgrid
 
+  PRECISION_CH1903_TO_WGS84 = 0.1/3600 # Precision in the order of 0.1"
+  PRECISION_WGS84_TO_CH1903 = 1.5 # Precision in the order of 1.5 metre
+
   describe Swissgrid do
 
-    it "tests conversion from wgs84 to ch1903" do
-      gps_point = [46.881908, 7.471829]
-      swiss_coord = Swissgrid::CH1903(gps_point)
-      expect(swiss_coord[0]).to be_within(0.5).of(602530.221)
-      expect(swiss_coord[1]).to be_within(0.5).of(192310.331)
-      pp swiss_coord
+    #
+    # Test conversion methods directly.
+    #
+
+    describe CH1903 do
+      it "tests from_wgs84" do
+        wgs84_point = [46.881908, 7.471829]
+        expected_ch1903_point = [602_530.221, 192_310.331]
+        ch1903_coord = Swissgrid::CH1903.from_wgs84(wgs84_point)
+        expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+        expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
+      end
+    end
+
+    describe WGS84 do
+      it "tests from_ch903" do
+        ch1903_point = [602_530.221, 192_310.331]
+        expected_wgs84_point = [46.881908, 7.471829]
+        wgs84_coord = Swissgrid::WGS84.from_ch1903(ch1903_point)
+        expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[0])
+        expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[1])
+      end
+    end
+
+    #
+    # Test conversion: Zimmerwald CH1903 [602_530.221, 192_310.331] <=> WGS84 [46.881908, 7.471829]
+    #
+
+    it "tests conversion from Zimmerwald wgs84 point to ch1903 point" do
+      wgs84_point = [46.881908, 7.471829]
+      expected_ch1903_point = [602_530.221, 192_310.331]
+      ch1903_coord = Swissgrid::CH1903(wgs84_point)
+      expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+      expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
+    end
+
+
+    it "tests conversion from Zimmerwald ch1903 point to wgs84 point" do
+      ch1903_point = [602_530.221, 192_310.331]
+      expected_wgs84_point = [46.881908, 7.471829]
+      wgs84_coord = Swissgrid::WGS84(ch1903_point)
+      expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[0])
+      expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[1])
+    end
+
+
+    #
+    # Test conversion: Zuerich CH1903 [683_082.039, 247_793.250] <=> WGS84 [47.375736, 8.538750]
+    #
+
+    it "tests conversion from Zuerich wgs84 point to ch1903 point" do
+      wgs84_point = [47.375736, 8.538750]
+      expected_ch1903_point = [683_082.039, 247_793.250]
+      ch1903_coord = Swissgrid::CH1903(wgs84_point)
+      expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+      expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
+    end
+
+
+    it "tests conversion from Zuerich ch1903 point to wgs84 point" do
+      ch1903_point = [683_082.039, 247_793.250]
+      expected_wgs84_point = [47.375736, 8.538750]
+      wgs84_coord = Swissgrid::WGS84(ch1903_point)
+      expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[0])
+      expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[1])
+    end
+
+
+    #
+    # Test conversion: Bern CH1903 [600_000, 200_000] <=> WGS84 [46.951082877, 7.438632495]
+    #
+
+    it "tests conversion from Bern wgs84 point to ch1903 point" do
+      wgs84_point = [46.951082877, 7.438632495]
+      expected_ch1903_point = [600_000, 200_000]
+      ch1903_coord = Swissgrid::CH1903(wgs84_point)
+      expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+      expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
     end
 
 
-    it "tests conversion from ch1903 to wgs84" do
+    it "tests conversion from Bern ch1903 point to wgs84 point" do
       ch1903_point = [600_000, 200_000]
-      wgs84_coord =  Swissgrid::WGS84(ch1903_point)
-      expect(wgs84_coord[0]).to be_within(0.1/3600).of(46.951082877)
-      expect(wgs84_coord[1]).to be_within(0.1/3600).of(7.438632495)
-      pp wgs84_coord
+      expected_wgs84_point = [46.951082877, 7.438632495]
+      wgs84_coord = Swissgrid::WGS84(ch1903_point)
+      expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[0])
+      expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[1])
+    end
+
+
+    #
+    # Test conversion: Lugano CH1903 [717_665.373, 95_957.362] <=> WGS84 [46.951082877, 7.438632495]
+    #
+
+    it "tests conversion from Lugano wgs84 point to ch1903 point" do
+      wgs84_point = [46.004914, 8.957646]
+      expected_ch1903_point = [717_665.373, 95_957.362]
+      ch1903_coord = Swissgrid::CH1903(wgs84_point)
+      expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+      expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
+    end
+
+
+    it "tests conversion from Lugano ch1903 point to wgs84 point" do
+      ch1903_point = [717_665.373, 95_957.362]
+      expected_wgs84_point = [46.004914, 8.957646]
+      wgs84_coord = Swissgrid::WGS84(ch1903_point)
+      expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[0])
+      expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs84_point[1])
+    end
+
+
+    #
+    # Test conversion: Geneva CH1903 [501_000.723, 118_136.350] <=> WGS84 [46.207383, 6.155882]
+    #
+
+    it "tests conversion from Geneva wgs84 point to ch1903 point" do
+      wgs84_point = [46.207383, 6.155882]
+      expected_ch1903_point = [501_000.723, 118_136.350]
+      ch1903_coord = Swissgrid::CH1903(wgs84_point)
+      expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+      expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
+    end
+
+
+    it "tests conversion from Geneva ch1903 point to wgs84 point" do
+      ch1903_point = [501_000.723, 118_136.350]
+      expected_wgs_point = [46.207383, 6.155882]
+      wgs84_coord = Swissgrid::WGS84(ch1903_point)
+      expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs_point[0])
+      expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs_point[1])
     end
 
-    it "tests conversion from Thun ch1903 point to wgs 84 point" do
+
+    #
+    # Test conversion: Thun CH1903 [611_202, 177_630] <=> WGS84 [46.7497613025, 7.58523830611]
+    #
+
+    it "tests conversion from Thun wgs84 point to ch1903 point" do
+      wgs84_point = [46.7497613025, 7.58523830611]
+      expected_ch1903_point = [611_202, 177_630]
+      ch1903_coord = Swissgrid::CH1903(wgs84_point)
+      expect(ch1903_coord[0]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[0])
+      expect(ch1903_coord[1]).to be_within(PRECISION_WGS84_TO_CH1903).of(expected_ch1903_point[1])
+    end
+
+
+    it "tests conversion from Thun ch1903 point to wgs84 point" do
       ch1903_point = [611_202, 177_630]
       expected_wgs_point = [46.7497613025, 7.58523830611]
-      wgs84_coord =  Swissgrid::WGS84(ch1903_point)
-      expect(wgs84_coord[0]).to be_within(0.5).of(expected_wgs_point[0])
-      expect(wgs84_coord[1]).to be_within(0.5).of(expected_wgs_point[1])
-      pp wgs84_coord
+      wgs84_coord = Swissgrid::WGS84(ch1903_point)
+      expect(wgs84_coord[0]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs_point[0])
+      expect(wgs84_coord[1]).to be_within(PRECISION_CH1903_TO_WGS84).of(expected_wgs_point[1])
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swissgrid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexander Rueedlinger
@@ -14,56 +14,56 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   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: Swissgrid is a library to convert gps points into the Swiss coordinate
@@ -74,7 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,12 +96,12 @@ 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: []
@@ -113,3 +113,4 @@ summary: A library to convert gps points into the Swiss coordinate system (CH190
 test_files:
 - spec/spec_helper.rb
 - spec/swissgrid_spec.rb
+has_rdoc: