Class: GMT

Inherits:

Object

• Object
• GMT

Defined in:

lib/gmt.rb

Overview

This class provides a native extension accessing the programs of the 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

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.

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 'depths.txt') preceeds the options hash

• the options hash has keys which are symbols

• options which lack arguments correspond to hash keys with nil values :Z => nil.

• the output redirection is also treated as hash option, with key :> 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)

Filtering of 1-D and 2-D Data

• #blockmean(*arguments, options) ⇒ Boolean

  L2 (x,y,z) table data filter/decimator.

• #blockmedian(*arguments, options) ⇒ Boolean

  L1 (x,y,z) table data filter/decimator.

• #blockmode(*arguments, options) ⇒ Boolean

  Mode estimate (x,y,z) table data filter/decimator.

• #filter1d(*arguments, options) ⇒ Boolean

  Time domain filtering of 1-D data tables.

• #grdfilter(*arguments, options) ⇒ Boolean

  Filter 2-D gridded data sets in the space domain.

Plotting of 1-D and 2-D Data

• #gmtlogo(*files, options) ⇒ Boolean

  Plot the GMT logo on maps.

• #grdcontour(*files, options) ⇒ Boolean

  Contouring of 2-D gridded data sets.

• #grdimage(*files, options) ⇒ Boolean

  Produce images from 2-D gridded data sets.

• #grdvector(*files, options) ⇒ Boolean

  Plotting of 2-D gridded vector fields.

• #grdview(*files, options) ⇒ Boolean

  3-D perspective imaging of 2-D gridded data sets.

• #psbasemap(*files, options) ⇒ Boolean

  Create a basemap plot.

• #psclip(*files, options) ⇒ Boolean

  Use polygon files to define clipping paths.

• #pscoast(*files, options) ⇒ Boolean

  Plot (and fill) coastlines, borders, and rivers on maps.

• #pscontour(*files, options) ⇒ Boolean

  Contour or image raw table data by triangulation.

• #pshistogram(*files, options) ⇒ Boolean

  Plot a histogram.

• #psimage(*files, options) ⇒ Boolean

  Plot Sun raster files on a map.

• #pslegend(*files, options) ⇒ Boolean

  Plot a legend on a map.

• #psmask(*files, options) ⇒ Boolean

  Create overlay to mask out regions on maps.

• #psrose(*files, options) ⇒ Boolean

  Plot sector or rose diagrams.

• #psscale(*files, options) ⇒ Boolean

  Plot gray scale or color scale on maps.

• #pstext(*files, options) ⇒ Boolean

  Plot text strings on maps.

• #pswiggle(*files, options) ⇒ Boolean

  Draw table data time-series along track on maps.

• #psxy(*files, options) ⇒ Boolean

  Plot symbols, polygons, and lines on maps.

• #psxyz(*files, options) ⇒ Boolean

  Plot symbols, polygons, and lines in 3-D.

Gridding of Data Tables

• #greenspline(*arguments, options) ⇒ Boolean

  Interpolation with Green’s functions for splines in 1–3 D.

• #nearneighbor(*arguments, options) ⇒ Boolean

  Nearest-neighbor gridding scheme.

• #sphinterpolate(*arguments, options) ⇒ Boolean

  Spherical gridding in tension of data on a sphere.

• #surface(*arguments, options) ⇒ Boolean

  A continuous curvature gridding algorithm.

• #triangulate(*arguments, options) ⇒ Boolean

  Perform optimal Delauney triangulation and gridding.

Sampling of 1-D and 2-D Data

• #gmtsimplify(*arguments, options) ⇒ Boolean

  Line reduction using the Douglas-Peucker algorithm.

• #grdsample(*arguments, options) ⇒ Boolean

  Resample a 2-D gridded data set onto a new grid.

• #grdtrack(*arguments, options) ⇒ Boolean

  Sampling of 2-D gridded data set(s) along 1-D track.

• #sample1d(*arguments, options) ⇒ Boolean

  Resampling of 1-D table data sets.

Projection and Map-transformation

• #grdproject(*arguments, options) ⇒ Boolean

  Project gridded data sets onto a new coordinate system.

• #mapproject(*arguments, options) ⇒ Boolean

  Transformation of coordinate systems for table data.

• #project(*arguments, options) ⇒ Boolean

  Project table data onto lines or great circles.

Retrieve Information

• #gmtdefaults(*arguments, options) ⇒ Boolean

  List the current default settings.

• #gmtget(*arguments, options) ⇒ Boolean

  Retrieve selected parameters in current file.

• #gmtinfo(*arguments, options) ⇒ Boolean

  Get information about table data files.

• #gmtset(*arguments, options) ⇒ Boolean

  Change selected parameters in current file.

• #grdinfo(*arguments, options) ⇒ Boolean

  Get information about grid files.

Mathematical Operations on Tables or Grids

• #gmtmath(*arguments, options) ⇒ Boolean

  Mathematical operations on table data.

• #makecpt(*arguments, options) ⇒ Boolean

  Make color palette tables.

• #spectrum1d(*arguments, options) ⇒ Boolean

  Compute various spectral estimates from time-series.

• #sph2grd(*arguments, options) ⇒ Boolean

  Compute grid from spherical harmonic coefficients.

• #sphdistance(*arguments, options) ⇒ Boolean

  Make grid of distances to nearest points on a sphere.

• #sphtriangulate(*arguments, options) ⇒ Boolean

  Delaunay or Voronoi construction of spherical lon,lat data.

Convert or Extract Subsets of Data

• #gmtconnect(*arguments, options) ⇒ Boolean

  Connect segments into more complete lines or polygons.

• #gmtconvert(*arguments, options) ⇒ Boolean

  Convert data tables from one format to another.

• #gmtselect(*arguments, options) ⇒ Boolean

  Select subsets of table data based on multiple spatial criteria.

• #gmtspatial(*arguments, options) ⇒ Boolean

  Geospatial operations on lines and polygons.

• #gmtvector(*arguments, options) ⇒ Boolean

  Operations on Cartesian vectors in 2-D and 3-D.

• #grd2rgb(*arguments, options) ⇒ Boolean

  Convert Sun raster or grid file to red, green, blue component grids.

• #grd2xyz(*arguments, options) ⇒ Boolean

  Conversion from 2-D grid file to table data.

• #grdblend(*arguments, options) ⇒ Boolean

  Blend several partially over-lapping grid files onto one grid.

• #grdconvert(*arguments, options) ⇒ Boolean

  Converts grid files into other grid formats.

• #grdcut(*arguments, options) ⇒ Boolean

  Cut a sub-region from a grid file.

• #grdpaste(*arguments, options) ⇒ Boolean

  Paste together grid files along a common edge.

• #splitxyz(*arguments, options) ⇒ Boolean

  Split xyz files into several segments.

• #xyz2grd(*arguments, options) ⇒ Boolean

  Convert an equidistant table xyz file to a 2-D grid file.

Determine Trends in 1-D and 2-D Data

• #fitcircle(*arguments, options) ⇒ Boolean

  Finds the best-fitting great or small circle for a set of points.

• #gmtregress(*arguments, options) ⇒ Boolean

  Linear regression of 1-D data sets.

• #trend1d(*arguments, options) ⇒ Boolean

  Fits polynomial or Fourier trends to y = f(x) series.

• #trend2d(*arguments, options) ⇒ Boolean

  Fits polynomial trends to z = f(x,y) series.

Other Operations on 2-D Grids

• #grd2cpt(*arguments, options) ⇒ Boolean

  Make color palette table from a grid files.

• #grdclip(*arguments, options) ⇒ Boolean

  Limit the z-range in gridded data sets.

• #grdedit(*arguments, options) ⇒ Boolean

  Modify header information in a 2-D grid file.

• #grdfft(*arguments, options) ⇒ Boolean

  Perform operations on grid files in the frequency domain.

• #grdgradient(*arguments, options) ⇒ Boolean

  Compute directional gradient from grid files.

• #grdhisteq(*arguments, options) ⇒ Boolean

  Histogram equalization for grid files.

• #grdlandmask(*arguments, options) ⇒ Boolean

  Create masking grid files from shoreline data base.

• #grdmask(*arguments, options) ⇒ Boolean

  Reset grid nodes in/outside a clip path to constants.

• #grdmath(*arguments, options) ⇒ Boolean

  Mathematical operations on grid files.

• #grdvolume(*arguments, options) ⇒ Boolean

  Calculate volumes under a surface within specified contour.

Miscellaneous Tools

• #gmt2kml(*arguments, options) ⇒ Boolean

  Like psxy but plots KML for use in Google Earth.

• #kml2gmt(*arguments, options) ⇒ Boolean

  Extracts coordinates from Google Earth KML files.

• #psconvert(*arguments, options) ⇒ Boolean

  Crop and convert PostScript files to raster images, EPS, and PDF.

Instance Method Summary

• #free ⇒ Object
• #initialize ⇒ Object constructor

Constructor Details

#initialize ⇒ Object

# File 'ext/gmt/gmt.c', line 49

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;
}

Instance Method Details

#blockmean(*arguments, options) ⇒ Boolean

L2 (x,y,z) table data filter/decimator

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/blockmean.html

# File 'lib/gmt.rb', line 198

wrapper_other :blockmean

#blockmedian(*arguments, options) ⇒ Boolean

L1 (x,y,z) table data filter/decimator

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/blockmedian.html

# File 'lib/gmt.rb', line 201

wrapper_other :blockmedian

#blockmode(*arguments, options) ⇒ Boolean

Mode estimate (x,y,z) table data filter/decimator

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/blockmode.html

# File 'lib/gmt.rb', line 204

wrapper_other :blockmode

#filter1d(*arguments, options) ⇒ Boolean

Time domain filtering of 1-D data tables

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/filter1d.html

# File 'lib/gmt.rb', line 207

wrapper_other :filter1d

#fitcircle(*arguments, options) ⇒ Boolean

Finds the best-fitting great or small circle for a set of points

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/fitcircle.html

# File 'lib/gmt.rb', line 402

wrapper_other :fitcircle

#free ⇒ Object

# File 'ext/gmt/gmt.c', line 64

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;
}

#gmt2kml(*arguments, options) ⇒ Boolean

Like psxy but plots KML for use in Google Earth

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmt2kml.html

# File 'lib/gmt.rb', line 450

wrapper_other :gmt2kml

#gmtconnect(*arguments, options) ⇒ Boolean

Connect segments into more complete lines or polygons

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtconnect.html

# File 'lib/gmt.rb', line 360

wrapper_other :gmtconnect

#gmtconvert(*arguments, options) ⇒ Boolean

Convert data tables from one format to another

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtconvert.html

# File 'lib/gmt.rb', line 363

wrapper_other :gmtconvert

#gmtdefaults(*arguments, options) ⇒ Boolean

List the current default settings

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtdefaults.html

# File 'lib/gmt.rb', line 321

wrapper_other :gmtdefaults

#gmtget(*arguments, options) ⇒ Boolean

Retrieve selected parameters in current file

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtget.html

# File 'lib/gmt.rb', line 324

wrapper_other :gmtget

#gmtinfo(*arguments, options) ⇒ Boolean

Get information about table data files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtinfo.html

# File 'lib/gmt.rb', line 327

wrapper_other :gmtinfo

#gmtlogo(*files, options) ⇒ Boolean

Plot the GMT logo on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtlogo.html

# File 'lib/gmt.rb', line 216

wrapper_ps :gmtlogo

#gmtmath(*arguments, options) ⇒ Boolean

Mathematical operations on table data

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtmath.html

# File 'lib/gmt.rb', line 339

wrapper_other :gmtmath

#gmtregress(*arguments, options) ⇒ Boolean

Linear regression of 1-D data sets

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtregress.html

# File 'lib/gmt.rb', line 405

wrapper_other :gmtregress

#gmtselect(*arguments, options) ⇒ Boolean

Select subsets of table data based on multiple spatial criteria

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtselect.html

# File 'lib/gmt.rb', line 366

wrapper_other :gmtselect

#gmtset(*arguments, options) ⇒ Boolean

Change selected parameters in current file

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtset.html

# File 'lib/gmt.rb', line 330

wrapper_other :gmtset

#gmtsimplify(*arguments, options) ⇒ Boolean

Line reduction using the Douglas-Peucker algorithm

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtsimplify.html

# File 'lib/gmt.rb', line 294

wrapper_other :gmtsimplify

#gmtspatial(*arguments, options) ⇒ Boolean

Geospatial operations on lines and polygons

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtspatial.html

# File 'lib/gmt.rb', line 369

wrapper_other :gmtspatial

#gmtvector(*arguments, options) ⇒ Boolean

Operations on Cartesian vectors in 2-D and 3-D

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/gmtvector.html

# File 'lib/gmt.rb', line 372

wrapper_other :gmtvector

#grd2cpt(*arguments, options) ⇒ Boolean

Make color palette table from a grid files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grd2cpt.html

# File 'lib/gmt.rb', line 417

wrapper_other :grd2cpt

#grd2rgb(*arguments, options) ⇒ Boolean

Convert Sun raster or grid file to red, green, blue component grids

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grd2rgb.html

# File 'lib/gmt.rb', line 375

wrapper_other :grd2rgb

#grd2xyz(*arguments, options) ⇒ Boolean

Conversion from 2-D grid file to table data

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grd2xyz.html

# File 'lib/gmt.rb', line 378

wrapper_other :grd2xyz

#grdblend(*arguments, options) ⇒ Boolean

Blend several partially over-lapping grid files onto one grid

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdblend.html

# File 'lib/gmt.rb', line 381

wrapper_other :grdblend

#grdclip(*arguments, options) ⇒ Boolean

Limit the z-range in gridded data sets

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdclip.html

# File 'lib/gmt.rb', line 420

wrapper_other :grdclip

#grdcontour(*files, options) ⇒ Boolean

Contouring of 2-D gridded data sets

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdcontour.html

# File 'lib/gmt.rb', line 219

wrapper_ps :grdcontour

#grdconvert(*arguments, options) ⇒ Boolean

Converts grid files into other grid formats

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdconvert.html

# File 'lib/gmt.rb', line 384

wrapper_other :grdconvert

#grdcut(*arguments, options) ⇒ Boolean

Cut a sub-region from a grid file

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdcut.html

# File 'lib/gmt.rb', line 387

wrapper_other :grdcut

#grdedit(*arguments, options) ⇒ Boolean

Modify header information in a 2-D grid file

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdedit.html

# File 'lib/gmt.rb', line 423

wrapper_other :grdedit

#grdfft(*arguments, options) ⇒ Boolean

Perform operations on grid files in the frequency domain

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdfft.html

# File 'lib/gmt.rb', line 426

wrapper_other :grdfft

#grdfilter(*arguments, options) ⇒ Boolean

Filter 2-D gridded data sets in the space domain

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdfilter.html

# File 'lib/gmt.rb', line 210

wrapper_other :grdfilter

#grdgradient(*arguments, options) ⇒ Boolean

Compute directional gradient from grid files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdgradient.html

# File 'lib/gmt.rb', line 429

wrapper_other :grdgradient

#grdhisteq(*arguments, options) ⇒ Boolean

Histogram equalization for grid files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdhisteq.html

# File 'lib/gmt.rb', line 432

wrapper_other :grdhisteq

#grdimage(*files, options) ⇒ Boolean

Produce images from 2-D gridded data sets

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdimage.html

# File 'lib/gmt.rb', line 222

wrapper_ps :grdimage

#grdinfo(*arguments, options) ⇒ Boolean

Get information about grid files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdinfo.html

# File 'lib/gmt.rb', line 333

wrapper_other :grdinfo

#grdlandmask(*arguments, options) ⇒ Boolean

Create masking grid files from shoreline data base

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdlandmask.html

# File 'lib/gmt.rb', line 435

wrapper_other :grdlandmask

#grdmask(*arguments, options) ⇒ Boolean

Reset grid nodes in/outside a clip path to constants

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdmask.html

# File 'lib/gmt.rb', line 438

wrapper_other :grdmask

#grdmath(*arguments, options) ⇒ Boolean

Mathematical operations on grid files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdmath.html

# File 'lib/gmt.rb', line 441

wrapper_other :grdmath

#grdpaste(*arguments, options) ⇒ Boolean

Paste together grid files along a common edge

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdpaste.html

# File 'lib/gmt.rb', line 390

wrapper_other :grdpaste

#grdproject(*arguments, options) ⇒ Boolean

Project gridded data sets onto a new coordinate system

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdproject.html

# File 'lib/gmt.rb', line 309

wrapper_other :grdproject

#grdsample(*arguments, options) ⇒ Boolean

Resample a 2-D gridded data set onto a new grid

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdsample.html

# File 'lib/gmt.rb', line 297

wrapper_other :grdsample

#grdtrack(*arguments, options) ⇒ Boolean

Sampling of 2-D gridded data set(s) along 1-D track

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdtrack.html

# File 'lib/gmt.rb', line 300

wrapper_other :grdtrack

#grdvector(*files, options) ⇒ Boolean

Plotting of 2-D gridded vector fields

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdvector.html

# File 'lib/gmt.rb', line 225

wrapper_ps :grdvector

#grdview(*files, options) ⇒ Boolean

3-D perspective imaging of 2-D gridded data sets

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdview.html

# File 'lib/gmt.rb', line 228

wrapper_ps :grdview

#grdvolume(*arguments, options) ⇒ Boolean

Calculate volumes under a surface within specified contour

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/grdvolume.html

# File 'lib/gmt.rb', line 444

wrapper_other :grdvolume

#greenspline(*arguments, options) ⇒ Boolean

Interpolation with Green’s functions for splines in 1–3 D

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/greenspline.html

# File 'lib/gmt.rb', line 276

wrapper_other :greenspline

#kml2gmt(*arguments, options) ⇒ Boolean

Extracts coordinates from Google Earth KML files

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/kml2gmt.html

# File 'lib/gmt.rb', line 453

wrapper_other :kml2gmt

#makecpt(*arguments, options) ⇒ Boolean

Make color palette tables

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/makecpt.html

# File 'lib/gmt.rb', line 342

wrapper_other :makecpt

#mapproject(*arguments, options) ⇒ Boolean

Transformation of coordinate systems for table data

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/mapproject.html

# File 'lib/gmt.rb', line 312

wrapper_other :mapproject

#nearneighbor(*arguments, options) ⇒ Boolean

Nearest-neighbor gridding scheme

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/nearneighbor.html

# File 'lib/gmt.rb', line 279

wrapper_other :nearneighbor

#project(*arguments, options) ⇒ Boolean

Project table data onto lines or great circles

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/project.html

# File 'lib/gmt.rb', line 315

wrapper_other :project

#psbasemap(*files, options) ⇒ Boolean

Create a basemap plot

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psbasemap.html

# File 'lib/gmt.rb', line 231

wrapper_ps :psbasemap

#psclip(*files, options) ⇒ Boolean

Use polygon files to define clipping paths

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psclip.html

# File 'lib/gmt.rb', line 234

wrapper_ps :psclip

#pscoast(*files, options) ⇒ Boolean

Plot (and fill) coastlines, borders, and rivers on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/pscoast.html

# File 'lib/gmt.rb', line 237

wrapper_ps :pscoast

#pscontour(*files, options) ⇒ Boolean

Contour or image raw table data by triangulation

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/pscontour.html

# File 'lib/gmt.rb', line 240

wrapper_ps :pscontour

#psconvert(*arguments, options) ⇒ Boolean

Crop and convert PostScript files to raster images, EPS, and PDF

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psconvert.html

# File 'lib/gmt.rb', line 456

wrapper_other :psconvert

#pshistogram(*files, options) ⇒ Boolean

Plot a histogram

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/pshistogram.html

# File 'lib/gmt.rb', line 243

wrapper_ps :pshistogram

#psimage(*files, options) ⇒ Boolean

Plot Sun raster files on a map

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psimage.html

# File 'lib/gmt.rb', line 246

wrapper_ps :psimage

#pslegend(*files, options) ⇒ Boolean

Plot a legend on a map

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/pslegend.html

# File 'lib/gmt.rb', line 249

wrapper_ps :pslegend

#psmask(*files, options) ⇒ Boolean

Create overlay to mask out regions on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psmask.html

# File 'lib/gmt.rb', line 252

wrapper_ps :psmask

#psrose(*files, options) ⇒ Boolean

Plot sector or rose diagrams

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psrose.html

# File 'lib/gmt.rb', line 255

wrapper_ps :psrose

#psscale(*files, options) ⇒ Boolean

Plot gray scale or color scale on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psscale.html

# File 'lib/gmt.rb', line 258

wrapper_ps :psscale

#pstext(*files, options) ⇒ Boolean

Plot text strings on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/pstext.html

# File 'lib/gmt.rb', line 261

wrapper_ps :pstext

#pswiggle(*files, options) ⇒ Boolean

Draw table data time-series along track on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/pswiggle.html

# File 'lib/gmt.rb', line 264

wrapper_ps :pswiggle

#psxy(*files, options) ⇒ Boolean

Plot symbols, polygons, and lines on maps

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psxy.html

# File 'lib/gmt.rb', line 267

wrapper_ps :psxy

#psxyz(*files, options) ⇒ Boolean

Plot symbols, polygons, and lines in 3-D

A PostScript function (accepts :file and :position options).

Parameters:

• files (Array<String>) —

  The input files

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/psxyz.html

# File 'lib/gmt.rb', line 270

wrapper_ps :psxyz

#sample1d(*arguments, options) ⇒ Boolean

Resampling of 1-D table data sets

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/sample1d.html

# File 'lib/gmt.rb', line 303

wrapper_other :sample1d

#spectrum1d(*arguments, options) ⇒ Boolean

Compute various spectral estimates from time-series

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/spectrum1d.html

# File 'lib/gmt.rb', line 345

wrapper_other :spectrum1d

#sph2grd(*arguments, options) ⇒ Boolean

Compute grid from spherical harmonic coefficients

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/sph2grd.html

# File 'lib/gmt.rb', line 348

wrapper_other :sph2grd

#sphdistance(*arguments, options) ⇒ Boolean

Make grid of distances to nearest points on a sphere

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/sphdistance.html

# File 'lib/gmt.rb', line 351

wrapper_other :sphdistance

#sphinterpolate(*arguments, options) ⇒ Boolean

Spherical gridding in tension of data on a sphere

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/sphinterpolate.html

# File 'lib/gmt.rb', line 282

wrapper_other :sphinterpolate

#sphtriangulate(*arguments, options) ⇒ Boolean

Delaunay or Voronoi construction of spherical lon,lat data

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/sphtriangulate.html

# File 'lib/gmt.rb', line 354

wrapper_other :sphtriangulate

#splitxyz(*arguments, options) ⇒ Boolean

Split xyz files into several segments

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/splitxyz.html

# File 'lib/gmt.rb', line 393

wrapper_other :splitxyz

#surface(*arguments, options) ⇒ Boolean

A continuous curvature gridding algorithm

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/surface.html

# File 'lib/gmt.rb', line 285

wrapper_other :surface

#trend1d(*arguments, options) ⇒ Boolean

Fits polynomial or Fourier trends to y = f(x) series

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/trend1d.html

# File 'lib/gmt.rb', line 408

wrapper_other :trend1d

#trend2d(*arguments, options) ⇒ Boolean

Fits polynomial trends to z = f(x,y) series

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/trend2d.html

# File 'lib/gmt.rb', line 411

wrapper_other :trend2d

#triangulate(*arguments, options) ⇒ Boolean

Perform optimal Delauney triangulation and gridding

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/triangulate.html

# File 'lib/gmt.rb', line 288

wrapper_other :triangulate

#xyz2grd(*arguments, options) ⇒ Boolean

Convert an equidistant table xyz file to a 2-D grid file

Parameters:

• arguments (Array<String>) —

  The arguments

• options (Hash) —

  The GMT command-line options in hash form

Returns:

• (Boolean) —

  true on success

See Also:

• http://gmt.soest.hawaii.edu/doc/latest/xyz2grd.html

# File 'lib/gmt.rb', line 396

wrapper_other :xyz2grd