gmt 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5a65a755a31688499a920ea9a2607b532559ff1
-  data.tar.gz: 5485b4fe71d63e8042db9fd0f459ba5ec0b4bccd
+  metadata.gz: d165e67cb791e80aecdbed1b817c6ba15c1f82ef
+  data.tar.gz: 4ffda40ca008f338c9016e84326a2eb8f7242dfd
 SHA512:
-  metadata.gz: 5f74d327f2ec1f15b2444eb61dfdab5fbcf4c1732e4e9164838a79d8108146881b87645d27ad427e304b6b8e3e70b7fa85568221fb6858888db78a3fcced3e52
-  data.tar.gz: 426b2a729293828d069eb78c540adc689db325e7b87b4415ab826de4f13cb897d2bcbcf1359080985d3730febe3b3a2a373e4de86ee381262e3fdb2cd336e92e
+  metadata.gz: 69d55be3f508a2bb345622d90d7cda10363bd1ceb259a5f0f910c0daf96f91663cf17c9c2c693ddc17ac3ade4ea6e669b41b95a33a183ca0b8b6cfe6fbad3b35
+  data.tar.gz: 311b0e6840f3d366ef17ea756ae581be1c8d3aa20978eb1bbb997802ecc154674631dcdac614bf9a1cba0c4a866a159c258447fd8d0579852b3e61097f0a9697

data/ext/gmt/gmt.c

@@ -8,6 +8,8 @@ typedef struct
   void *session;
 } gmt_t;
 
+/* helpers */
+
 static void raise_unless_class_data(gmt_t *gmt)
 {
   if (gmt == NULL)
@@ -20,6 +22,62 @@ static void raise_if_error(int err, const char *module)
     rb_raise(rb_eRuntimeError, "failed call to GMT module %s", module);
 }
 
+/* ruby object interface */
+
+static void gmt_free(void *p)
+{
+  gmt_t *gmt = p;
+
+  if (gmt->session)
+    {
+      GMT_Destroy_Session(gmt->session);
+      gmt->session = NULL;
+    }
+}
+
+static VALUE gmt_alloc(VALUE klass)
+{
+  gmt_t *gmt;
+
+  VALUE obj = Data_Make_Struct(klass, gmt_t, NULL, gmt_free, gmt);
+
+  gmt->session = NULL;
+
+  return obj;
+}
+
+static VALUE gmt_init(VALUE self)
+{
+  gmt_t *gmt;
+
+  Data_Get_Struct(self, gmt_t, gmt);
+
+  gmt->session =
+    GMT_Create_Session("Session name", 2, 0, NULL);
+
+  if (gmt->session == NULL)
+    rb_raise(rb_eNoMemError, "failed to create GMT session");
+
+  return self;
+}
+
+static VALUE gmt_release(VALUE self)
+{
+  gmt_t *gmt;
+
+  Data_Get_Struct(self, gmt_t, gmt);
+
+  if (gmt->session)
+    {
+      GMT_Destroy_Session(gmt->session);
+      gmt->session = NULL;
+    }
+
+  return self;
+}
+
+/* hander for GMT functions */
+
 static VALUE gmt_simple(const char *name, int argc, VALUE *argv, VALUE self)
 {
   VALUE files, opts;
@@ -44,71 +102,135 @@ static VALUE gmt_simple(const char *name, int argc, VALUE *argv, VALUE self)
   return Qtrue;
 }
 
+/* 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);
 }
 
-static VALUE gmt_pstext(int argc, VALUE *argv, VALUE self)
+static VALUE gmt_spectrum1d(int argc, VALUE *argv, VALUE self)
 {
-  return gmt_simple("pstext", argc, argv, self);
+  return gmt_simple("spectrum1d", argc, argv, self);
 }
 
-static VALUE gmt_psxy(int argc, VALUE *argv, VALUE self)
+static VALUE gmt_sph2grd(int argc, VALUE *argv, VALUE self)
 {
-  return gmt_simple("psxy", argc, argv, self);
+  return gmt_simple("sph2grd", argc, argv, self);
 }
 
-static void gmt_free(void *p)
+static VALUE gmt_sphdistance(int argc, VALUE *argv, VALUE self)
 {
-  gmt_t *gmt = p;
+  return gmt_simple("sphdistance", argc, argv, self);
+}
 
-  if (gmt->session)
-    {
-      GMT_Destroy_Session(gmt->session);
-      gmt->session = NULL;
-    }
+static VALUE gmt_sphtriangulate(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("sphtriangulate", argc, argv, self);
 }
 
-static VALUE gmt_alloc(VALUE klass)
+/* Plotting of 1-D and 2-D Data */
+
+static VALUE gmt_gmtlogo(int argc, VALUE *argv, VALUE self)
 {
-  gmt_t *gmt;
+  return gmt_simple("gmtlogo", argc, argv, self);
+}
 
-  VALUE obj = Data_Make_Struct(klass, gmt_t, NULL, gmt_free, gmt);
+static VALUE gmt_grdcontour(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("grdcontour", argc, argv, self);
+}
 
-  gmt->session = NULL;
+static VALUE gmt_grdimage(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("grdimage", argc, argv, self);
+}
 
-  return obj;
+static VALUE gmt_grdvector(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("grdvector", argc, argv, self);
 }
 
-static VALUE gmt_init(VALUE self)
+static VALUE gmt_grdview(int argc, VALUE *argv, VALUE self)
 {
-  gmt_t *gmt;
+  return gmt_simple("grdview", argc, argv, self);
+}
 
-  Data_Get_Struct(self, gmt_t, gmt);
+static VALUE gmt_psbasemap(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("psbasemap", argc, argv, self);
+}
 
-  gmt->session =
-    GMT_Create_Session("Session name", 2, 0, NULL);
+static VALUE gmt_psclip(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("psclip", argc, argv, self);
+}
 
-  if (gmt->session == NULL)
-    rb_raise(rb_eNoMemError, "failed to create GMT session");
+static VALUE gmt_pscoast(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("pscoast", argc, argv, self);
+}
 
-  return self;
+static VALUE gmt_pscontour(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("pscontour", argc, argv, self);
 }
 
-static VALUE gmt_release(VALUE self)
+static VALUE gmt_pshistogram(int argc, VALUE *argv, VALUE self)
 {
-  gmt_t *gmt;
+  return gmt_simple("pshistogram", argc, argv, self);
+}
 
-  Data_Get_Struct(self, gmt_t, gmt);
+static VALUE gmt_psimage(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("psimage", argc, argv, self);
+}
 
-  if (gmt->session)
-    {
-      GMT_Destroy_Session(gmt->session);
-      gmt->session = NULL;
-    }
+static VALUE gmt_pslegend(int argc, VALUE *argv, VALUE self)
+{
+  return gmt_simple("pslegend", argc, argv, self);
+}
 
-  return 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);
 }
 
 void Init_gmt(void)
@@ -119,7 +241,34 @@ void Init_gmt(void)
   rb_define_method(cGMT, "initialize", gmt_init, 0);
   rb_define_method(cGMT, "free", gmt_release, 0);
 
+  /* Mathematical Operations on Tables or Grids */
+
+  rb_define_private_method(cGMT, "gmtmath_c", gmt_gmtmath, -1);
   rb_define_private_method(cGMT, "makecpt_c", gmt_makecpt, -1);
+  rb_define_private_method(cGMT, "spectrum1d_c", gmt_spectrum1d, -1);
+  rb_define_private_method(cGMT, "sph2grd_c", gmt_sph2grd, -1);
+  rb_define_private_method(cGMT, "sphdistance_c", gmt_sphdistance, -1);
+  rb_define_private_method(cGMT, "sphtriangulate_c", gmt_sphtriangulate, -1);
+
+  /* Plotting of 1-D and 2-D Data */
+
+  rb_define_private_method(cGMT, "gmtlogo_c", gmt_gmtlogo, -1);
+  rb_define_private_method(cGMT, "grdcontour_c", gmt_grdcontour, -1);
+  rb_define_private_method(cGMT, "grdimage_c", gmt_grdimage, -1);
+  rb_define_private_method(cGMT, "grdvector_c", gmt_grdvector, -1);
+  rb_define_private_method(cGMT, "grdview_c", gmt_grdview, -1);
+  rb_define_private_method(cGMT, "psbasemap_c", gmt_psbasemap, -1);
+  rb_define_private_method(cGMT, "psclip_c", gmt_psclip, -1);
+  rb_define_private_method(cGMT, "pscoast_c", gmt_pscoast, -1);
+  rb_define_private_method(cGMT, "pscontour_c", gmt_pscontour, -1);
+  rb_define_private_method(cGMT, "pshistogram_c", gmt_pshistogram, -1);
+  rb_define_private_method(cGMT, "psimage_c", gmt_psimage, -1);
+  rb_define_private_method(cGMT, "pslegend_c", gmt_pslegend, -1);
+  rb_define_private_method(cGMT, "psmask_c", gmt_psmask, -1);
+  rb_define_private_method(cGMT, "psrose_c", gmt_psrose, -1);
+  rb_define_private_method(cGMT, "psscale_c", gmt_psscale, -1);
   rb_define_private_method(cGMT, "pstext_c", gmt_pstext, -1);
+  rb_define_private_method(cGMT, "pswiggle_c", gmt_pswiggle, -1);
   rb_define_private_method(cGMT, "psxy_c", gmt_psxy, -1);
+  rb_define_private_method(cGMT, "psxyz_c", gmt_psxyz, -1);
 }

data/lib/gmt.rb

@@ -1,6 +1,36 @@
-# === Generic Mapping Tools (GMT) interface for Ruby
+# This class provides a native extension accessing the programs of
+# the {http://gmt.soest.hawaii.edu/home 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
+# illustrations ranging from simple x–y plots via contour maps to
+# artificially illuminated surfaces and 3D perspective views
 #
-# Here we will have some documentation
+# An example of usage:
+#
+#    require 'gmt'
+#
+#    common = {
+#      file: 'output.ps',
+#      R: '0/3/0/2',
+#      J: 'x1i'
+#    }
+#    gmt = GMT.new
+#    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'))
+#
+# 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 ...
 
 class GMT
 
@@ -38,6 +68,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
     def wrapper_ps(method)
       define_method(method) do |*files, options|
         self.send(GMT.send(:method_c, method),
@@ -51,6 +82,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
     def wrapper_other(method)
       define_method(method) do |*args|
         self.send(GMT.send(:method_c, method), *args)
@@ -61,14 +93,85 @@ class GMT
 
   public
 
+  ### Mathematical Operations on Tables or Grids
+
+  # Mathematical operations on table data
+  wrapper_other :gmtmath
+
+  # Make color palette tables
+  wrapper_other :makecpt
+
+  # Compute various spectral estimates from time-series
+  wrapper_other :spectrum1d
+
+  # Compute grid from spherical harmonic coefficients
+  wrapper_other :sph2grd
+
+  # Make grid of distances to nearest points on a sphere
+  wrapper_other :sphdistance
+
+  # Delaunay or Voronoi construction of spherical lon,lat data
+  wrapper_other :sphtriangulate
+
+
+  ### Plotting of 1-D and 2-D Data
+
+  # Plot the GMT logo on maps
+  wrapper_ps :gmtlogo
+
+  # Contouring of 2-D gridded data sets
+  wrapper_ps :grdcontour
+
+  # Produce images from 2-D gridded data sets
+  wrapper_ps :grdimage
+
+  # Plotting of 2-D gridded vector fields
+  wrapper_ps :grdvector
+
+  # 3-D perspective imaging of 2-D gridded data sets
+  wrapper_ps :grdview
+
+  # Create a basemap plot
+  wrapper_ps :psbasemap
+
+  # Use polygon files to define clipping paths
+  wrapper_ps :psclip
+
+  # Plot (and fill) coastlines, borders, and rivers on maps
+  wrapper_ps :pscoast
+
+  # Contour or image raw table data by triangulation
+  wrapper_ps :pscontour
+
+  # Plot a histogram
+  wrapper_ps :pshistogram
+
+  # Plot Sun raster files on a map
+  wrapper_ps :psimage
+
+  # Plot a legend on a map
+  wrapper_ps :pslegend
+
+  # Create overlay to mask out regions on maps
+  wrapper_ps :psmask
+
+  # Plot sector or rose diagrams
+  wrapper_ps :psrose
+
+  # Plot gray scale or color scale on maps
+  wrapper_ps :psscale
+
   # Plot text strings on maps
   wrapper_ps :pstext
 
+  # Draw table data time-series along track on maps
+  wrapper_ps :pswiggle
+
   # Plot symbols, polygons, and lines on maps
   wrapper_ps :psxy
 
-  # Make color palette tables
-  wrapper_other :makecpt
+  # Plot symbols, polygons, and lines in 3-D
+  wrapper_ps :psxyz
 
 end
 

metadata

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