gmt 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d165e67cb791e80aecdbed1b817c6ba15c1f82ef
-  data.tar.gz: 4ffda40ca008f338c9016e84326a2eb8f7242dfd
+  metadata.gz: eb3e6c00f7441e68367685e8e81ae9ab37d7b7df
+  data.tar.gz: 607921342ff51b589eb0a45cd29338f9b7103c67
 SHA512:
-  metadata.gz: 69d55be3f508a2bb345622d90d7cda10363bd1ceb259a5f0f910c0daf96f91663cf17c9c2c693ddc17ac3ade4ea6e669b41b95a33a183ca0b8b6cfe6fbad3b35
-  data.tar.gz: 311b0e6840f3d366ef17ea756ae581be1c8d3aa20978eb1bbb997802ecc154674631dcdac614bf9a1cba0c4a866a159c258447fd8d0579852b3e61097f0a9697
+  metadata.gz: bc29e208845fd2506a567ec89baf60b561a20df1fad75fd23b6b20c06692e224e69b5181175494e294678fe2cfbb1b28fceffa67222ec06533ce1904f10740a0
+  data.tar.gz: 078abee21e2518de7647b0c070ee5ddc57e7b11190b2a026d8f4873069841a0c81721e87a2daa7b72120f94b9c2248b5f366d67634eca9d5f8355c9aa1c0057d

data/ext/gmt/extconf.rb

@@ -2,8 +2,23 @@ require 'mkmf'
 
 $CFLAGS << ' -std=c99'
 
-HEADER_DIRS = [ '/usr/include/gmt' ]
-LIB_DIRS = [ '/usr/lib/x86_64-linux-gnu' ]
+INCLUDEDIR = RbConfig::CONFIG['includedir']
+HEADER_BASE = [
+  '/opt/local/include',
+  '/usr/local/include',
+  INCLUDEDIR,
+  '/usr/include',
+]
+HEADER_GMT = HEADER_BASE.map { |dir| File.join(dir, 'gmt') }
+HEADER_DIRS = HEADER_GMT + HEADER_BASE
+
+LIBDIR = RbConfig::CONFIG['libdir']
+LIB_DIRS = [
+  '/opt/local/lib',
+  '/usr/local/lib',
+  LIBDIR,
+  '/usr/lib'
+]
 
 dir_config('gmt', HEADER_DIRS, LIB_DIRS)
 

data/ext/gmt/gmt.c

@@ -104,134 +104,52 @@ static VALUE gmt_simple(const char *name, int argc, VALUE *argv, VALUE self)
 
 /* The GMT functions */
 
-/* Mathematical Operations on Tables or Grids */
-
-static VALUE gmt_gmtmath(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("gmtmath", argc, argv, self);
-}
-
-static VALUE gmt_makecpt(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("makecpt", argc, argv, self);
+#define GMT_FUN(name) \
+static VALUE gmt_ ## name (int argc, VALUE *argv, VALUE self) \
+{ \
+  return gmt_simple(#name, argc, argv, self); \
 }
 
-static VALUE gmt_spectrum1d(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("spectrum1d", argc, argv, self);
-}
+/* Filtering of 1-D and 2-D Data */
 
-static VALUE gmt_sph2grd(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("sph2grd", argc, argv, self);
-}
+GMT_FUN(blockmean)
+GMT_FUN(blockmedian)
+GMT_FUN(blockmode)
+GMT_FUN(filter1d)
+GMT_FUN(grdfilter)
 
-static VALUE gmt_sphdistance(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("sphdistance", argc, argv, self);
-}
+/* Mathematical Operations on Tables or Grids */
 
-static VALUE gmt_sphtriangulate(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("sphtriangulate", argc, argv, self);
-}
+GMT_FUN(gmtmath)
+GMT_FUN(makecpt)
+GMT_FUN(spectrum1d)
+GMT_FUN(sph2grd)
+GMT_FUN(sphdistance)
+GMT_FUN(sphtriangulate)
 
 /* Plotting of 1-D and 2-D Data */
 
-static VALUE gmt_gmtlogo(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("gmtlogo", argc, argv, self);
-}
-
-static VALUE gmt_grdcontour(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("grdcontour", argc, argv, self);
-}
-
-static VALUE gmt_grdimage(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("grdimage", argc, argv, self);
-}
-
-static VALUE gmt_grdvector(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("grdvector", argc, argv, self);
-}
-
-static VALUE gmt_grdview(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("grdview", argc, argv, self);
-}
-
-static VALUE gmt_psbasemap(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psbasemap", argc, argv, self);
-}
-
-static VALUE gmt_psclip(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psclip", argc, argv, self);
-}
-
-static VALUE gmt_pscoast(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("pscoast", argc, argv, self);
-}
-
-static VALUE gmt_pscontour(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("pscontour", argc, argv, self);
-}
-
-static VALUE gmt_pshistogram(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("pshistogram", argc, argv, self);
-}
-
-static VALUE gmt_psimage(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psimage", argc, argv, self);
-}
-
-static VALUE gmt_pslegend(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("pslegend", argc, argv, self);
-}
-
-static VALUE gmt_psmask(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psmask", argc, argv, self);
-}
-
-static VALUE gmt_psrose(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psrose", argc, argv, self);
-}
-
-static VALUE gmt_psscale(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psscale", argc, argv, self);
-}
-
-static VALUE gmt_pstext(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("pstext", argc, argv, self);
-}
-
-static VALUE gmt_pswiggle(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("pswiggle", argc, argv, self);
-}
-
-static VALUE gmt_psxy(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psxy", argc, argv, self);
-}
-
-static VALUE gmt_psxyz(int argc, VALUE *argv, VALUE self)
-{
-  return gmt_simple("psxyz", argc, argv, self);
-}
+GMT_FUN(gmtlogo)
+GMT_FUN(grdcontour)
+GMT_FUN(grdimage)
+GMT_FUN(grdvector)
+GMT_FUN(grdview)
+GMT_FUN(psbasemap)
+GMT_FUN(psclip)
+GMT_FUN(pscoast)
+GMT_FUN(pscontour)
+GMT_FUN(pshistogram)
+GMT_FUN(psimage)
+GMT_FUN(pslegend)
+GMT_FUN(psmask)
+GMT_FUN(psrose)
+GMT_FUN(psscale)
+GMT_FUN(pstext)
+GMT_FUN(pswiggle)
+GMT_FUN(psxy)
+GMT_FUN(psxyz)
+
+#undef GMT_FUN
 
 void Init_gmt(void)
 {
@@ -241,6 +159,14 @@ 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_define_private_method(cGMT, "blockmean_c", gmt_blockmean, -1);
+  rb_define_private_method(cGMT, "blockmedian_c", gmt_blockmedian, -1);
+  rb_define_private_method(cGMT, "blockmode_c", gmt_blockmode, -1);
+  rb_define_private_method(cGMT, "filter1d_c", gmt_filter1d, -1);
+  rb_define_private_method(cGMT, "grdfilter_c", gmt_grdfilter, -1);
+
   /* Mathematical Operations on Tables or Grids */
 
   rb_define_private_method(cGMT, "gmtmath_c", gmt_gmtmath, -1);

data/lib/gmt.rb

@@ -30,69 +30,157 @@
 # Those familiar with GMT will recognise the +-R+ (range) and +-J+ (projection)
 # options which are now keys for the program options hash.
 #
-# More details to follow ...
-
+# == The session
+#
+# All GMT functions (modules in the GMT parlance) require a session context,
+# and an instance of the GMT class is exactly such a context.
+#
+#    gmt = GMT.new
+#
+# There are no arguments for the constructor.
+#
+# == GMT functions
+#
+# Each GMT function is available as instance method, and each has the same
+# signatures: several _arguments_, typically input files, followed by a
+# single options hash.  The options has 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
+#
+# would be replicated by the Ruby
+#
+#    gmt = GMT.new
+#    gmt.makecpt('depths.txt',
+#                :C => 'gebco', :i => 2, :Z => nil, :E => 24, :> => 'my_depths.cpt')
+#
+# Note that
+# - the single argument (the input file <code>'depths.txt'</code>) preceeds
+#   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>.
+# - the output redirection is _also_ treated as hash option, with key
+#   <code>:></code> and value which is the output file.
+#
+# == PostScript functions
+#
+# When creating complex PostScript plots one needs to make several calls to
+# GMT functions, to use the +-O+ and +-K+ options, and to append output of
+# the second and subsequent calls (rather than overwriting). This is tiresome
+# 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
+# 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)
+#
 class GMT
 
   class << self
 
     private
 
-    def opts_normalise(options)
-      file = options.delete(:file)
-      position = options.delete(:position)
-      if file && position then
-        file_options =
-          case position
-          when :first
-            { :K => nil, :> => file }
-          when :middle
-            { :O => nil, :K => nil, :>> => file }
-          when :last
-            { :O => nil, :>> => file }
-          else
-            raise ArguemntError, 'position should be :first, :middle or :last'
-          end
-        options.merge(file_options)
-      else
-        options
-      end
-    end
-
-    def method_c(method)
-      [method.to_s, 'c'].join('_').to_sym
-    end
-
     # @macro [attach] wrapper_ps
+    #
+    #   A PostScript function (accepts +:file+ and +:position+ options).
     #   @method $1(*files, options)
     #   @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
     def wrapper_ps(method)
-      define_method(method) do |*files, options|
-        self.send(GMT.send(:method_c, method),
-                  *files,
-                  GMT.send(:opts_normalise, options))
+      define_method(method) do |*args, options|
+        self.send(api_function(method),
+                  *string_arguments(args),
+                  postscript_options(options))
       end
     end
 
     # @macro [attach] wrapper_other
-    #   @method $1(*files, options)
-    #   @param [Array<String>] files The input files
+    #   @method $1(*arguments, options)
+    #   @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
     def wrapper_other(method)
-      define_method(method) do |*args|
-        self.send(GMT.send(:method_c, method), *args)
+      define_method(method) do |*args, options|
+        self.send(api_function(method),
+                  *string_arguments(args),
+                  options)
       end
     end
 
   end
 
+  private
+
+  # the name of the C function
+
+  def api_function(method)
+    [method.to_s, 'c'].join('_').to_sym
+  end
+
+  # convert non-option arguments to strings
+
+  def string_arguments(args)
+    args.map(&:to_s)
+  end
+
+  # for GMT modules which produce PostScript, convert the
+  # convenience options (:position, :file) to the hash
+  # equivalent of the -K, -O options, and the creation of
+  # or appending to the PostScript output file
+
+  def postscript_options(options)
+    file = options.delete(:file)
+    position = options.delete(:position)
+    if file && position then
+      file_options =
+        case position
+        when :first
+          { :K => nil, :> => file }
+        when :middle
+          { :O => nil, :K => nil, :>> => file }
+        when :last
+          { :O => nil, :>> => file }
+        else
+          raise ArguemntError, 'position should be :first, :middle or :last'
+        end
+      options.merge(file_options)
+    else
+      options
+    end
+  end
+
   public
 
+  ### 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
+
+
   ### Mathematical Operations on Tables or Grids
 
   # Mathematical operations on table data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gmt
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - J.J. Green
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler