nztm2000 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd08ac118e24a4d0236bfb2a3eb23467e59e8bab
-  data.tar.gz: eb448964c7a654daf2f381f3de60d4bbd7160b82
+  metadata.gz: 9f8935ed2a880bfc5e71444a44b18f41d706f24a
+  data.tar.gz: b5a00e1f1913e8ff0b28c5a5700055bd376db1c2
 SHA512:
-  metadata.gz: b66cad2c660774b0cee56132ccb2f982a2c9c34c5daed8659fdf8a6340fcdccd3e8827307c8a09fe6afb60a22ce5a885124aff6d6a655e0be6fb2dbb19e10f09
-  data.tar.gz: 0b455392afe57938843ae6404c3e81be1623747416ca918b1b54495b272bc28ec7babefeec460229a9aaf3f9ff4e9fa80ced67e97fa3c583d89481f660b25527
+  metadata.gz: a59f8c5c2aafac21a30be88cb1c5874667ba00180909b2cbf885457f59afb321b7efb16069c5ede5d53461e096064887d4a8306bb5d8c10520adedecb8e63404
+  data.tar.gz: 2a01610ddb54e7e3829bcb4b34e6bba05989b6a19cc2fbef54fc2a82bc90e2059e70706811ee837c2b40057cb35529cad5f5a5e4cf21f352d48d20a06afd521d

data/README.md

@@ -17,19 +17,37 @@ Converts coordinates  between the New Zealand Transverse Merctator 2000 and GRS8
 
 The NZTM200 provides two public methods 
 
-NZTM2000.geod( easting, northing )
+geod( easting, northing )
 Converts easting and northing (meters) to a latitude and longitude (Decimal degrees and radian results available)
 
-NZTM2000.nztm( latitude, longitude )
+nztm( latitude, longitude )
 Converts latitude and longitude (Decimal degrees) to easting and northing (meters) 
 
+```
+require 'nztm2000'
+  #Self test from nztm.c.
+  nztm2000 = NZTM2000.new
+  [[1576041.150, 6188574.240], 
+   [1576542.010, 5515331.050],
+   [1307103.220, 4826464.860]].each do |easting,northing|
+     r_latitude, r_longitude = nztm2000.geod(easting, northing)
+     r_easting, r_northing = nztm2000.nztm(r_latitude, r_longitude)
+ 
+     printf "Input  NZTM easting, northing: %12.3f %12.3f\n", easting, northing
+     printf "Output     Latitude Longitude: %12.6f %12.6f\n", r_latitude, r_longitude
+     printf "Output NZTM easting, northing: %12.3f %12.3f\n", r_easting, r_northing
+     printf "Difference:                    %12.3f %12.3f\n", easting - r_easting, northing - r_northing
+     puts
+  end
+```
+
 ## REQUIREMENTS:
 
 * 
 
 ## INSTALL:
 
-* sudo gem install NZTM2000
+* sudo gem install nztm2000
 
 ## LICENSE:
 

data/lib/nztm2000.rb

@@ -1,5 +1,5 @@
 class NZTM2000
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   #Define the parameters for the International Ellipsoid
   #used for the NZGD2000 datum (and hence for NZTM)
@@ -28,8 +28,21 @@ class NZTM2000
   attr_accessor :northing    #NZTM 2000 northing (meters)
   attr_accessor :easting     #NZTM 2000 easting (meters)
   
-  def initialize
+  #Initialize
+  # Without arguments, use geod or nztm methods.
+  # Given easting: and northing:, @latitude and @longitude will be calculated
+  # Given latitude: and longitude:, @easting: and @northing will be calculated
+  # @option easting: [Numeric] nztm2000 easting
+  # @option northing: [Numeric] nztm2000 northing
+  # @option latitude: [Numeric] GRS80 latitude
+  # @option longitude: [Numeric] GRS80 longitude
+  def initialize(easting: nil, northing: nil, latitude: nil, longitude: nil)
     tm_initialize(NZTM_A, NZTM_RF, NZTM_CM/(180/Math::PI), NZTM_SF, NZTM_OLAT/(180/Math::PI), NZTM_FE, NZTM_FN, 1.0)
+    if easting != nil && northing != nil
+      geod(easting, northing)
+    elsif( latitude != nil && longitude != nil)
+      nztm(latitude, longitude)
+    end
   end
   
   #Initialize the TM projection parameters
@@ -52,7 +65,7 @@ class NZTM2000
   
   #*************************************************************************
   #  Method based on Redfearn's formulation as expressed in GDA technical   
-  #  manual at http://www.anzlic.org.au/icsm/gdatm/index.html               
+  #  manual at http://www.icsm.gov.au/gda/tech.html               
   #                                                                         
   #  @param latitude [Numeric] radians                                                 
   #  @return [Numeric] the length of meridional arc in meters (Helmert formula)                 
@@ -73,7 +86,7 @@ class NZTM2000
   #***********************************************************************
   #   Calculates the foot point latitude from the meridional arc          
   #   Method based on Redfearn's formulation as expressed in GDA technical
-  #   manual at http://www.anzlic.org.au/icsm/gdatm/index.html            
+  #   manual at http://www.icsm.gov.au/gda/tech.html            
   #                                                                       
   #   @param m [Numeric] meridional arc (metres)                                          
   #                                                              
@@ -98,7 +111,7 @@ class NZTM2000
   #*************************************************************************
   #   Routine to convert from Tranverse Mercator to latitude and longitude. 
   #   Method based on Redfearn's formulation as expressed in GDA technical  
-  #   manual at http://www.anzlic.org.au/icsm/gdatm/index.html      
+  #   manual at http://www.icsm.gov.au/gda/tech.html      
   #   Sets @latitude, @longitude (degrees) and @latitude_r, @longitude_r (Radians)    
   #                                                                         
   #   @param ce [Numeric] input northing (metres)
@@ -162,7 +175,7 @@ class NZTM2000
   #                                                                         
   #   Routine to convert from latitude and longitude to Transverse Mercator.
   #   Method based on Redfearn's formulation as expressed in GDA technical  
-  #   manual at http://www.anzlic.org.au/icsm/gdatm/index.html              
+  #   manual at http://www.icsm.gov.au/gda/tech.html              
   #   Loosely based on FORTRAN source code by J.Hannah and A.Broadhurst.    
   #                                                                         
   #   Sets @easting  (metres)                                               
@@ -219,21 +232,27 @@ class NZTM2000
 
   # Functions implementation the TM projection specifically for the
   #   NZTM coordinate system
+  # @param easting: [Numeric] nztm2000 easting, either named, or the first argument
+  # @param northing: [Numeric] nztm2000 northing, either named, or the second argument
   #  @return [Numeric,Numeric] latitude and longitude (decimal degrees)
-  def geod( easting, northing )
-    @easting = easting
-    @northing = northing
+  def geod( f_easting = nil, f_northing = nil, easting: nil, northing: nil )
+    @easting = easting || f_easting
+    @northing = northing || f_northing
+    raise ArgumentError.new("Not Numeric") if ! (@easting.is_a?(Numeric) && @northing.is_a?(Numeric) )
     return tm_geod
   end
 
   # Functions implementation the TM projection specifically for the
   #   NZTM coordinate system
+  # @param latitude: [Numeric] GRS80 latitude, either named, or the first argument
+  # @param longitude: [Numeric] GRS80 longitude, either named, or the second argument
   #  @return [Numeric,Numeric] northing and easting (meters)
-  def nztm( latitude, longitude )
-    @latitude = latitude
-    @latitude_r = latitude/(180/Math::PI)
-    @longitude = longitude
-    @longitude_r = longitude/(180/Math::PI)
+  def nztm( f_latitude = nil, f_longitude = nil, latitude: nil, longitude: nil )
+    @latitude = latitude || f_latitude
+    @longitude = longitude || f_longitude
+    raise ArgumentError.new("Not Numeric") if ! (@latitude.is_a?(Numeric) && @longitude.is_a?(Numeric) )
+    @latitude_r = @latitude/(180/Math::PI)
+    @longitude_r = @longitude/(180/Math::PI)
     return geod_tm
   end
 

data/test/test_nztm2000.rb

@@ -3,6 +3,7 @@ require "nztm2000"
 
 class TestNztm2000 < Test::Unit::TestCase
   def test_sanity
+    #Test with nil intializer, and using the NZTM2000::geod() and NZTM2000.nztm() methods.
     nztm2000 = NZTM2000.new
     [[1576041.150, 6188574.240, -34.444065991,	172.739193967], 
      [1576542.010, 5515331.050, -40.512408980,	172.723105968],
@@ -15,5 +16,32 @@ class TestNztm2000 < Test::Unit::TestCase
        assert_in_delta(easting_r, easting, 0.0005)
        assert_in_delta(northing_r, northing, 0.0005)
     end
+
+    #Test with nil intializer, and using the NZTM2000::geod() and NZTM2000.nztm() methods with named arguments.
+    nztm2000 = NZTM2000.new
+    [[1576041.150, 6188574.240, -34.444065991,	172.739193967], 
+     [1576542.010, 5515331.050, -40.512408980,	172.723105968],
+     [1307103.220, 4826464.860, -46.651295012,	169.172062008]
+    ].each do |easting,northing, latitude, longitude|
+       latitude_r, longitude_r = nztm2000.geod(northing: northing, easting: easting)
+       easting_r, northing_r = nztm2000.nztm(longitude: longitude_r, latitude: latitude_r)
+       assert_in_delta(latitude_r, latitude, 0.00005)
+       assert_in_delta(longitude_r, longitude, 0.00005)
+       assert_in_delta(easting_r, easting, 0.0005)
+       assert_in_delta(northing_r, northing, 0.0005)
+    end
+
+    #Test initializers used
+    [[1576041.150, 6188574.240, -34.444065991,	172.739193967], 
+     [1576542.010, 5515331.050, -40.512408980,	172.723105968],
+     [1307103.220, 4826464.860, -46.651295012,	169.172062008]
+    ].each do |easting,northing, latitude, longitude|
+       nztm1 = NZTM2000.new(easting: easting, northing: northing)
+       nztm2 = NZTM2000.new(latitude: nztm1.latitude, longitude: nztm1.longitude)
+       assert_in_delta(nztm1.latitude, latitude, 0.00005)
+       assert_in_delta(nztm1.longitude, longitude, 0.00005)
+       assert_in_delta(nztm2.easting, easting, 0.0005)
+       assert_in_delta(nztm2.northing, northing, 0.0005)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nztm2000
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rob Burrowes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-06 00:00:00.000000000 Z
+date: 2016-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe-yard