gmt 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: add57f0a400ff02baf95838b30287a290923d1a56e0ed528f0687649eb173a7d
-  data.tar.gz: d8e40fad79ec4dffe5973038fc963da69cbc8e9538ac6c0440971277fe47e010
+  metadata.gz: bcb103c5d9934352f0d7a88c13b8e6c2478d3fd34dc147b43e437081c456652c
+  data.tar.gz: ac99f95bbf7d47b162b7bb5a52e6d5a761d5bafa62149546555cae1bf3dd9878
 SHA512:
-  metadata.gz: f820a71b95aee0f2e3ef4306c771ba3e3449f4be109f505c84dadbe396ea955a2914dbcba1bc5bf055f2f6e9985d76ec882e951e1460123babde15e2b4850a90
-  data.tar.gz: 59fe46c4f7dd9aa045857a9129c948440d56e8209bbbe20848bf6f5f47c7b0ba79c8466155af3a6fd4e9b371046a03941c6663285e60d73b899e1f95f7989fcd
+  metadata.gz: aaebef5a24b0f5d72c546b3823f2210f1129195ba1afa6cdc967e81b2808c3a11f520dca9e801b7f100e38162829961202c3f9bbb1134632514a37c9179ef1b3
+  data.tar.gz: 1e972987f36a448c7e0389b4ced616c7683f543ad4e289856d61c553d07227487178e505d587459ce5024bc8d952af4db6c17e9a0e2d96f58fd2377fad13605e

data/ext/gmt/gmt.c

@@ -106,7 +106,17 @@ static VALUE gmt_simple(const char *name, int argc, VALUE *argv, VALUE self)
   return Qtrue;
 }
 
-/* The GMT functions */
+/*
+  The GMT functions
+
+  We take this list from the GMT documentation for the "classic mode"
+  https://docs.generic-mapping-tools.org/latest/modules-classic.html
+
+  The "modern mode" modules (which have a slicker way of routing and
+  combining postscript output) will probably need a different treatment,
+  possibly a more attractive on from the Ruby perspective; for now we
+  just limit ourselves to the classic mode.
+*/
 
 #define GMT_FUN(name) \
 static VALUE gmt_ ## name (int argc, VALUE *argv, VALUE self) \
@@ -114,15 +124,7 @@ static VALUE gmt_ ## name (int argc, VALUE *argv, VALUE self) \
   return gmt_simple(#name, argc, argv, self); \
 }
 
-/* Filtering of 1-D and 2-D Data */
-
-GMT_FUN(blockmean)
-GMT_FUN(blockmedian)
-GMT_FUN(blockmode)
-GMT_FUN(filter1d)
-GMT_FUN(grdfilter)
-
-/* Plotting of 1-D and 2-D Data */
+/* Plotting  */
 
 GMT_FUN(gmtlogo)
 GMT_FUN(grdcontour)
@@ -152,7 +154,23 @@ GMT_FUN(pssolar)
 GMT_FUN(psternary)
 #endif
 
-/* Gridding of Data Tables */
+#if API_AT_LEAST(6, 0, 0)
+GMT_FUN(psevents)
+#endif
+
+/* Filtering */
+
+GMT_FUN(blockmean)
+GMT_FUN(blockmedian)
+GMT_FUN(blockmode)
+GMT_FUN(filter1d)
+GMT_FUN(grdfilter)
+
+#if API_AT_LEAST(6, 0, 0)
+GMT_FUN(dimfilter)
+#endif
+
+/* Gridding  */
 
 GMT_FUN(greenspline)
 GMT_FUN(nearneighbor)
@@ -160,20 +178,20 @@ GMT_FUN(sphinterpolate)
 GMT_FUN(surface)
 GMT_FUN(triangulate)
 
-/* Sampling of 1-D and 2-D Data */
+/* Sampling of 1-D and 2-D data */
 
 GMT_FUN(gmtsimplify)
 GMT_FUN(grdsample)
 GMT_FUN(grdtrack)
 GMT_FUN(sample1d)
 
-/* Projection and Map-transformation */
+/* Projection and map-transformation */
 
 GMT_FUN(grdproject)
 GMT_FUN(mapproject)
 GMT_FUN(project)
 
-/* Retrieve Information */
+/* Information retrieval */
 
 GMT_FUN(gmtdefaults)
 GMT_FUN(gmtget)
@@ -181,7 +199,7 @@ GMT_FUN(gmtinfo)
 GMT_FUN(gmtset)
 GMT_FUN(grdinfo)
 
-/* Mathematical Operations on Tables or Grids */
+/* Mathematical operations on tables or grids */
 
 GMT_FUN(gmtmath)
 GMT_FUN(makecpt)
@@ -190,14 +208,13 @@ GMT_FUN(sph2grd)
 GMT_FUN(sphdistance)
 GMT_FUN(sphtriangulate)
 
-/* Convert or Extract Subsets of Data */
+/* Convert or extract subsets of data */
 
 GMT_FUN(gmtconnect)
 GMT_FUN(gmtconvert)
 GMT_FUN(gmtselect)
 GMT_FUN(gmtspatial)
 GMT_FUN(gmtvector)
-GMT_FUN(grd2rgb)
 GMT_FUN(grd2xyz)
 GMT_FUN(grdblend)
 GMT_FUN(grdconvert)
@@ -206,14 +223,24 @@ GMT_FUN(grdpaste)
 GMT_FUN(splitxyz)
 GMT_FUN(xyz2grd)
 
-/* Determine Trends in 1-D and 2-D Data */
+#if API_AT_LEAST(6, 0, 0)
+GMT_FUN(grd2kml)
+#else
+GMT_FUN(grd2rgb) /* https://github.com/GenericMappingTools/gmt/pull/425 */
+#endif
+
+/* trends in 1-D and 2-D data */
 
 GMT_FUN(fitcircle)
 GMT_FUN(gmtregress)
 GMT_FUN(trend1d)
 GMT_FUN(trend2d)
 
-/* Other Operations on 2-D Grids */
+#if API_AT_LEAST(6, 0, 0)
+GMT_FUN(grdtrend)
+#endif
+
+/* Grid operations */
 
 GMT_FUN(grd2cpt)
 GMT_FUN(grdclip)
@@ -226,12 +253,20 @@ GMT_FUN(grdmask)
 GMT_FUN(grdmath)
 GMT_FUN(grdvolume)
 
-/* Miscellaneous Tools */
+#if API_AT_LEAST(6, 0, 0)
+GMT_FUN(grdfill)
+#endif
+
+/* Miscellaneous  */
 
 GMT_FUN(gmt2kml)
 GMT_FUN(kml2gmt)
 GMT_FUN(psconvert)
 
+#if API_AT_LEAST(6, 0, 0)
+GMT_FUN(grdgdal)
+#endif
+
 #undef GMT_FUN
 
 #define RB_DPM(name) rb_define_private_method(cGMT, #name "_c", gmt_ ## name, -1)
@@ -244,15 +279,7 @@ void Init_gmt(void)
   rb_define_method(cGMT, "initialize", gmt_init, 0);
   rb_define_method(cGMT, "free", gmt_release, 0);
 
-  /* Filtering of 1-D and 2-D Data */
-
-  RB_DPM(blockmean);
-  RB_DPM(blockmedian);
-  RB_DPM(blockmode);
-  RB_DPM(filter1d);
-  RB_DPM(grdfilter);
-
-  /* Plotting of 1-D and 2-D Data */
+  /* Plotting */
 
   RB_DPM(gmtlogo);
   RB_DPM(grdcontour);
@@ -282,7 +309,23 @@ void Init_gmt(void)
   RB_DPM(psternary);
 #endif
 
-  /* Gridding of Data Tables */
+#if API_AT_LEAST(6, 0, 0)
+  RB_DPM(psevents);
+#endif
+
+  /* Filtering  */
+
+  RB_DPM(blockmean);
+  RB_DPM(blockmedian);
+  RB_DPM(blockmode);
+  RB_DPM(filter1d);
+  RB_DPM(grdfilter);
+
+#if API_AT_LEAST(6, 0, 0)
+  RB_DPM(dimfilter);
+#endif
+
+  /* Gridding */
 
   RB_DPM(greenspline);
   RB_DPM(nearneighbor);
@@ -290,20 +333,20 @@ void Init_gmt(void)
   RB_DPM(surface);
   RB_DPM(triangulate);
 
-  /* Sampling of 1-D and 2-D Data */
+  /* Sampling of 1-D and 2-D data */
 
   RB_DPM(gmtsimplify);
   RB_DPM(grdsample);
   RB_DPM(grdtrack);
   RB_DPM(sample1d);
 
-  /* Projection and Map-transformation */
+  /* Projection and map-transformation */
 
   RB_DPM(grdproject);
   RB_DPM(mapproject);
   RB_DPM(project);
 
-  /* Retrieve Information */
+  /* Information retrieval */
 
   RB_DPM(gmtdefaults);
   RB_DPM(gmtget);
@@ -311,7 +354,7 @@ void Init_gmt(void)
   RB_DPM(gmtset);
   RB_DPM(grdinfo);
 
-  /* Mathematical Operations on Tables or Grids */
+  /* Mathematical operations on tables or grids */
 
   RB_DPM(gmtmath);
   RB_DPM(makecpt);
@@ -320,14 +363,13 @@ void Init_gmt(void)
   RB_DPM(sphdistance);
   RB_DPM(sphtriangulate);
 
-  /* Convert or Extract Subsets of Data */
+  /* Convert or extract subsets of data */
 
   RB_DPM(gmtconnect);
   RB_DPM(gmtconvert);
   RB_DPM(gmtselect);
   RB_DPM(gmtspatial);
   RB_DPM(gmtvector);
-  RB_DPM(grd2rgb);
   RB_DPM(grd2xyz);
   RB_DPM(grdblend);
   RB_DPM(grdconvert);
@@ -336,14 +378,24 @@ void Init_gmt(void)
   RB_DPM(splitxyz);
   RB_DPM(xyz2grd);
 
-  /* Determine Trends in 1-D and 2-D Data */
+#if API_AT_LEAST(6, 0, 0)
+  RB_DPM(grd2kml);
+#else
+  RB_DPM(grd2rgb); /* https://github.com/GenericMappingTools/gmt/pull/425 */
+#endif
+
+  /* Trends in 1-D and 2-D data */
 
   RB_DPM(fitcircle);
   RB_DPM(gmtregress);
   RB_DPM(trend1d);
   RB_DPM(trend2d);
 
-  /* Other Operations on 2-D Grids */
+#if API_AT_LEAST(6, 0, 0)
+  RB_DPM(grdtrend);
+#endif
+
+  /* Grid operations */
 
   RB_DPM(grd2cpt);
   RB_DPM(grdclip);
@@ -356,12 +408,20 @@ void Init_gmt(void)
   RB_DPM(grdmath);
   RB_DPM(grdvolume);
 
-  /* Miscellaneous Tools */
+#if API_AT_LEAST(6, 0, 0)
+  RB_DPM(grdfill);
+#endif
+
+  /* Miscellaneous  */
 
   RB_DPM(gmt2kml);
   RB_DPM(kml2gmt);
   RB_DPM(psconvert);
 
+#if API_AT_LEAST(6, 0, 0)
+  RB_DPM(grdgdal);
+#endif
+
   /* version constants */
 
   rb_define_const(cGMT, "VERSION_MAJOR", INT2NUM(GMT_MAJOR_VERSION));

data/lib/gmt.rb

@@ -1,5 +1,5 @@
 # This class provides a native extension accessing the programs of
-# the {http://gmt.soest.hawaii.edu/home Generic Mapping Tools};
+# the {https://docs.generic-mapping-tools.org Generic Mapping Tools};
 # an open source collection of about 80 command-line tools for
 # manipulating geographic and Cartesian data sets (including filtering,
 # trend fitting, gridding, projecting, etc.) and producing PostScript
@@ -13,16 +13,8 @@
 #    common = { file: 'output.ps', R: '0/3/0/2', J: 'x1i' }
 #
 #    GMT.session do |gmt|
-#      gmt.psxy('dots.xy',
-#               common.merge(
-#                 position: :first,
-#                 S: 'c0.50c',
-#                 G: 'blue'))
-#      gmt.psxy('dots.xy',
-#               common.merge(
-#                 position: :last,
-#                 S: 'c0.25c',
-#                 G: 'red'))
+#      gmt.psxy('dots.xy', position: :first, S: 'c0.50c', G: 'blue', **common)
+#      gmt.psxy('dots.xy', position: :last, S: 'c0.25c', G: 'red', **common)
 #    end
 #
 # Those familiar with GMT will recognise the +-R+ (range) and +-J+ (projection)
@@ -50,20 +42,19 @@
 # single options hash.  The options hash corresponds to the command-line
 # options of the GMT program; hence the shell command
 #
-#    gmt makecpt -Cgebco depths.txt -i2 -Z -E24 > my_depths.cpt
+#    gmt makecpt -Cgebco depths.txt -i2 -Z -E24 > bath.cpt
 #
 # would be replicated by the Ruby
 #
 #    gmt = GMT.new
-#    gmt.makecpt('depths.txt',
-#                C: 'gebco', i: 2, Z: nil, E: 24, :> => 'my_depths.cpt')
+#    gmt.makecpt('depths.txt', C: 'gebco', i: 2, Z: nil, E: 24, :> => 'bath.cpt')
 #
 # Note that
 # - the argument(s) (the input file <code>'depths.txt'</code>) preceed(s)
 #   the options hash
 # - the options hash has keys which are symbols
 # - options which lack arguments correspond to hash keys with nil values
-#   <code>:Z => nil</code>.
+#   <code>Z: nil</code>.
 # - the output redirection is _also_ treated as hash option, with key
 #   <code>:></code> and value which is the output file.
 #
@@ -71,8 +62,7 @@
 # _argument_, but recall that arguments must proceed the options hash,
 # so the above would be
 #
-#    gmt.makecpt('depths.txt',
-#                :Z, C: 'gebco', i: 2, E: 24, :> => 'my_depths.cpt')
+#    gmt.makecpt('depths.txt', :Z, C: 'gebco', i: 2, E: 24, :> => 'bath.cpt')
 #
 # using this format.
 #
@@ -84,17 +74,17 @@
 # and error-prone on the command-line, and more so in the "options hash"
 # representation in the Ruby module.
 #
-# So we add some syntatactic sugar for these PostScript functions: if the
+# So we add some syntactic sugar for these PostScript functions: if the
 # options hash has the keys +:position+ (with values one of +:first+, +:middle+,
 # or +:last+) and +:file+ (with the value of the ouptut file), then the
 # +-O+ and +-K+ options and the output redirection are handled by the class.
 # So one might write
 #
 #     gmt = GMT.new
-#     gmt.psbasemap( …, file: 'map.ps', position: :first)
-#     gmt.pstext(    …, file: 'map.ps', position: :middle)
-#     gmt.psxy(      …, file: 'map.ps', position: :middle)
-#     gmt.pslogo(    …, file: 'map.ps', position: :last)
+#     gmt.psbasemap( ..., file: 'map.ps', position: :first)
+#     gmt.pstext(    ..., file: 'map.ps', position: :middle)
+#     gmt.psxy(      ..., file: 'map.ps', position: :middle)
+#     gmt.pslogo(    ..., file: 'map.ps', position: :last)
 #
 class GMT
 
@@ -142,7 +132,7 @@ class GMT
     #   @param [Array<String>] files The input files
     #   @param [Hash] options The GMT command-line options in hash form
     #   @return [Boolean] +true+ on success
-    #   @see http://gmt.soest.hawaii.edu/doc/latest/$1.html
+    #   @see https://docs.generic-mapping-tools.org/latest/$1.html
     def wrapper_ps(method)
       define_method(method) do |*args, **opts|
         args, opts = arg_opt_normalise(args, opts)
@@ -157,7 +147,7 @@ class GMT
     #   @param [Array<String>] arguments The arguments
     #   @param [Hash] options The GMT command-line options in hash form
     #   @return [Boolean] +true+ on success
-    #   @see http://gmt.soest.hawaii.edu/doc/latest/$1.html
+    #   @see https://docs.generic-mapping-tools.org/latest/$1.html
     def wrapper_other(method)
       define_method(method) do |*args, **opts|
         args, opts = arg_opt_normalise(args, opts)
@@ -215,11 +205,11 @@ class GMT
       file_opts =
         case position
         when :first, 'first'
-          { :K => nil, :> => file }
+          { K: nil, :> => file }
         when :middle, 'middle'
-          { :O => nil, :K => nil, :>> => file }
+          { O: nil, K: nil, :>> => file }
         when :last, 'last'
-          { :O => nil, :>> => file }
+          { O: nil, :>> => file }
         else
           raise ArgumentError, 'position should be :first, :middle or :last'
         end
@@ -257,25 +247,7 @@ class GMT
 
   public
 
-  # @!group Filtering of 1-D and 2-D Data
-
-  # L2 (x,y,z) table data filter/decimator
-  wrapper_other :blockmean
-
-  # L1 (x,y,z) table data filter/decimator
-  wrapper_other :blockmedian
-
-  # Mode estimate (x,y,z) table data filter/decimator
-  wrapper_other :blockmode
-
-  # Time domain filtering of 1-D data tables
-  wrapper_other :filter1d
-
-  # Filter 2-D gridded data sets in the space domain
-  wrapper_other :grdfilter
-
-
-  # @!group Plotting of 1-D and 2-D Data
+  # @!group Plotting
 
   # Plot the GMT logo on maps
   wrapper_ps :gmtlogo
@@ -340,8 +312,32 @@ class GMT
   # Plot data on ternary diagrams
   wrapper_ps :psternary
 
+  # Plot event symbols and labels for a moment in time
+  wrapper_ps :psevents
+
+
+  # @!group Filtering
+
+  # L2 (x,y,z) table data filter/decimator
+  wrapper_other :blockmean
+
+  # L1 (x,y,z) table data filter/decimator
+  wrapper_other :blockmedian
+
+  # Mode estimate (x,y,z) table data filter/decimator
+  wrapper_other :blockmode
+
+  # Time domain filtering of 1-D data tables
+  wrapper_other :filter1d
+
+  # Filter 2-D gridded data sets in the space domain
+  wrapper_other :grdfilter
+
+  # Directional filtering of grids in the space domain
+  wrapper_other :dimfilter
 
-  # @!group Gridding of Data Tables
+
+  # @!group Gridding
 
   # Interpolation with Green’s functions for splines in 1–3 D
   wrapper_other :greenspline
@@ -359,7 +355,7 @@ class GMT
   wrapper_other :triangulate
 
 
-  # @!group Sampling of 1-D and 2-D Data
+  # @!group Sampling of 1-D and 2-D data
 
   # Line reduction using the Douglas-Peucker algorithm
   wrapper_other :gmtsimplify
@@ -374,7 +370,7 @@ class GMT
   wrapper_other :sample1d
 
 
-  # @!group Projection and Map-transformation
+  # @!group Projection and map-transformation
 
   # Project gridded data sets onto a new coordinate system
   wrapper_other :grdproject
@@ -386,7 +382,7 @@ class GMT
   wrapper_other :project
 
 
-  # @!group Retrieve Information
+  # @!group Information retrieval
 
   # List the current default settings
   wrapper_other :gmtdefaults
@@ -404,7 +400,7 @@ class GMT
   wrapper_other :grdinfo
 
 
-  # @!group Mathematical Operations on Tables or Grids
+  # @!group Mathematical operations on tables or grids
 
   # Mathematical operations on table data
   wrapper_other :gmtmath
@@ -425,7 +421,7 @@ class GMT
   wrapper_other :sphtriangulate
 
 
-  # @!group Convert or Extract Subsets of Data
+  # @!group Convert or extract subsets of data
 
   # Connect segments into more complete lines or polygons
   wrapper_other :gmtconnect
@@ -466,8 +462,11 @@ class GMT
   # Convert an equidistant table xyz file to a 2-D grid file
   wrapper_other :xyz2grd
 
+  # Create KML image quadtree from single grid
+  wrapper_other :grd2kml
+
 
-  # @!group Determine Trends in 1-D and 2-D Data
+  # @!group Trends in 1-D and 2-D data
 
   # Finds the best-fitting great or small circle for a set of points
   wrapper_other :fitcircle
@@ -481,8 +480,11 @@ class GMT
   # Fits polynomial trends to z = f(x,y) series
   wrapper_other :trend2d
 
+  # Fit trend surface to grids and compute residuals
+  wrapper_other :grdtrend
+
 
-  # @!group Other Operations on 2-D Grids
+  # @!group Grid operations
 
   # Make color palette table from a grid files
   wrapper_other :grd2cpt
@@ -514,8 +516,11 @@ class GMT
   # Calculate volumes under a surface within specified contour
   wrapper_other :grdvolume
 
+  # Interpolate across holes in a grid
+  wrapper_other :grdfill
 
-  # @!group Miscellaneous Tools
+
+  # @!group Miscellaneous
 
   # Like psxy but plots KML for use in Google Earth
   wrapper_other :gmt2kml
@@ -526,6 +531,9 @@ class GMT
   # Crop and convert PostScript files to raster images, EPS, and PDF
   wrapper_other :psconvert
 
+  # Execute GDAL raster programs from GMT
+  wrapper_other :grdgdal
+
 end
 
 require 'gmt/gmt'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gmt
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1'
 description: |
-  A Ruby extension for the Generic Mapping Tools (GMT5)
+  A Ruby extension for the Generic Mapping Tools (GMT5/6)
   cartographic toolset.
 email: j.j.green@gmx.co.uk
 executables: []
@@ -128,11 +128,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- GMT5 development libraries (compile)
-- GMT5 installation (test)
+- GMT5/6 development libraries (compile)
+- GMT5/6 installation (test)
 - ghostscript (test)
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Generic Mapping Tools (GMT)