append2fig(fname::String)

Move the file fname to the default name and location (GMTjl_tmp.ps in tmp). The fname should be a PS file that has NOT been closed. Posterior calls to plotting methods will append to this file. Useful when creating figures that use a common base map that may be heavy (slow) to compute.

arrows(cmd0::String="", arg1=nothing; arrow=(...), kwargs...)

Plots an arrow field. When the keyword arrow=(...) or vector=(...) is used, the direction (in degrees counter-clockwise from horizontal) and length must be found in columns 3 and 4, and size, if not specified on the command-line, should be present in column 5. The size is the length of the vector head. Vector stem width is set by option pen or line_attrib.

The vecmap=(...) variation is similar to above except azimuth (in degrees east of north) should be given instead of direction. The azimuth will be mapped into an angle based on the chosen map projection. If length is not in plot units but in arbitrary user units (e.g., a rate in mm/yr) then you can use the input_col option to scale the corresponding column via the +sscale modifier.

The geovec=(...) or geovector=(...) keywords plot geovectors. In geovectors azimuth (in degrees east from north) and geographical length must be found in columns 3 and 4. The size is the length of the vector head. Vector width is set by pen or line_attrib. Note: Geovector stems are drawn as thin filled polygons and hence pen attributes like dashed and dotted are not available. For allowable geographical units, see the units=() option.

The full arrow options list can be consulted at Vector Attributes

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• W | pen | line_attrib :: [Type => Str]

  Set pen attributes for lines or the outline of symbols (http://docs.generic-mapping-tools.org/latest/plot.html#w)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

Example:

arrows([0 8.2 0 6], limits=(-2,4,0,9), arrow=(len=2,stop=1,shape=0.5,fill=:red), axis=:a, pen="6p", show=true)

bar(cmd0::String="", arg1=nothing; kwargs...)

Reads a file or (x,y) pairs and plots vertical bars extending from base to y.

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• fill :: [Type => Str –

  Select color or pattern for filling the bars (http://docs.generic-mapping-tools.org/latest/plot.html#g)

• base | bottom :: [Type => Str | Num] $key=value$

  By default, base = ymin. Use this option to change that value. If base is not appended then we read it. from the last input data column.

• size | width :: [Type => Str | Num] $key=value$

  The size or width is the bar width. Append u if size is in x-units. When width is used the default is plot-distance units.

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

Example:

bar(sort(randn(10)), fill=:black, axis=:auto, show=true)

bar3(cmd0::String="", arg1=nothing; kwargs...)

Read a grid file, a grid or a MxN matrix and plots vertical bars extending from base to z.

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• fill :: [Type => Str] $key=color$

  Select color or pattern for filling the bars (http://docs.generic-mapping-tools.org/latest/plot.html#g)

• base :: [Type => Str | Num] $key=value$

  By default, base = ymin. Use this option to change that value. If base is not appended then we read it.

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

Example:

G = gmt("grdmath -R-15/15/-15/15 -I0.5 X Y HYPOT DUP 2 MUL PI MUL 8 DIV COS EXCH NEG 10 DIV EXP MUL =");
bar3(G, lw=:thinnest, show=true)

basemap(cmd0::String=""; kwargs...)

Plot base maps and frames.

Full option list at psbasemap

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• A | polygon :: [Type => Str | []]

  No plotting is performed. Instead, we determine the geographical coordinates of the polygon outline for the (possibly oblique) rectangular map domain. (http://docs.generic-mapping-tools.org/latest/basemap.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• D | inset | inset_box :: [Type => Str]

  Draw a simple map insert box on the map. Requires -F. (http://docs.generic-mapping-tools.org/latest/basemap.html#d)

• F | box :: [Type => Str]

  Without further options, draws a rectangular border around any map insert (D), map scale (L) or map rose (T) (http://docs.generic-mapping-tools.org/latest/basemap.html#f)

• Jz | zscale | zsize :: [Type => String]

• L | map_scale :: [Type => Str]

  Draw a map scale. (http://docs.generic-mapping-tools.org/latest/basemap.html#l)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Td | rose :: [Type => Str]

  Draws a map directional rose on the map at the location defined by the reference and anchor points. (http://docs.generic-mapping-tools.org/latest/basemap.html#t)

• Tm | compass :: [Type => Str]

  Draws a map magnetic rose on the map at the location defined by the reference and anchor points. (http://docs.generic-mapping-tools.org/latest/basemap.html#t)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

blendimg!(color::GMTimage, shade::GMTimage; new=false)

Blend the RGB color GMTimage with the shade intensity image (normally obtained with gdaldem) The new argument determines if we return a new RGB image or update the color argument.

The blending method is the one explained in https://gis.stackexchange.com/questions/255537/merging-hillshade-dem-data-into-color-relief-single-geotiff-with-qgis-and-gdal/255574#255574

Returns

A GMT RGB Image

blendimg!(img1::GMTimage, img2::GMTimage; new=false, transparency=0.5)

Blend two 2D UInt8 or 2 RGB images using transparency.

• transparency The default value, 0.5, gives equal weight to both images. 0.75 will make img weight 3/4 of the total sum, and so forth.
• new If true returns a new GMTimage object, otherwise it cahnges the img content.

Returns

A GMT intensity Image

blockmean(cmd0::String="", arg1=nothing; kwargs...)

Block average (x,y,z) data tables by L2 norm.

Full option list at blockmean

Parameters

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/blockmean.html#i)

• A | field | fields :: [Type => Str]

  Select which fields to write to individual grids. Append comma-separated codes for available fields: z (the mean data z, but see statistic), s (standard deviation), l (lowest value), h (highest value) and w (the output weight; requires weights). [Default is just z]. (http://docs.generic-mapping-tools.org/latest/blockmean.html#a)

• C | center :: [Type => Bool]

  Use the center of the block as the output location [Default uses the mean location]. Not used when -A (http://docs.generic-mapping-tools.org/latest/blockmean.html#c)

• E | extend | extended :: [Type => Str | []]

  Provide Extended report which includes s (the standard deviation about the mean), l, the lowest value, and h, the high value for each block. Output order becomes x,y,z,s,l,h[,w]. [Default outputs x,y,z[,w]. See -W for w output. If -Ep is used we assume weights are 1/(sigma squared) and s becomes the propagated error of the mean. (http://docs.generic-mapping-tools.org/latest/blockmean.html#e)

• G | save | outgrid | outfile :: [Type => Str]

  Write one or more fields directly to grids on disk; no table data are return. If more than one fields are specified via A then grdfile must contain the format flag %s so that we can embed the field code in the file names. If not provided but A is used, return 1 or more GMTgrid type(s). (http://docs.generic-mapping-tools.org/latest/blockmean.html#g)

• S | statistic :: [Type => Str | Symb]

  Use statistic=:n to report the number of points inside each block, statistic=:s to report the sum of all z-values inside a block, statistic=:w to report the sum of weights [Default (or statistic=:m reports mean value]. (http://docs.generic-mapping-tools.org/latest/blockmean.html#s)

• mean :: [Type => Any]

  Report the mean value of points inside each block

• npts | counts :: [Type => Any]

  Report the number of points inside each block

• sum :: [Type => Any]

  Report the sum of all z-values inside each block

• sum_weights :: [Type => Any]

  Report the the sum of weights

• grid :: [Type => Bool]

  With any of the above options (statistic, npts, sum) this option makes it return a grid instead of a GMTdataset.

• W | weights :: [Type => Str | []]

  Unweighted input and output have 3 columns x,y,z; Weighted i/o has 4 columns x,y,z,w. Weights can be used in input to construct weighted mean values for each block. (http://docs.generic-mapping-tools.org/latest/blockmean.html#w)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• q | inrow | inrows :: [Type => Str] $Arg = [i|o][~]rows[+ccol][+a|f|s]$

  Select specific data rows to be read (-qi [Default]) or written (-qo) [all]. (http://docs.generic-mapping-tools.org/latest/gmt.html#q-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

blockmedian(cmd0::String="", arg1=nothing; kwargs...)

Block average (x,y,z) data tables by L1 norm.

Full option list at blockmedian

blockmode(cmd0::String="", arg1=nothing; kwargs...)

Block average (x,y,z) data tables by mode estimation.

Full option list at blockmode

buffergeo(D::GMTdataset; width=0, unit=:m, np=120, flatstart=false, flatend=false, epsg::Integer=0, tol=0.01)

or

buffergeo(line::Matrix; width=0, unit=:m, np=120, flatstart=false, flatend=false, proj::String="", epsg::Integer=0, tol=0.01)

or

buffergeo(fname::String; width=0, unit=:m, np=120, flatstart=false, flatend=false, proj::String="", epsg::Integer=0, tol=0.01)

Computes a buffer arround a poly-line. This calculation is performed on a ellipsoidal Earth (or other planet) using the GeographicLib (via PROJ4) so it should be very accurate.

Parameters

• D | line | fname: - the geometry. This can either be a GMTdataset (or vector of it), a Mx2 matrix, the name of file that can be read as a GMTdataset by gmtread() or a GDAL AbstractDataset object
• width: - the buffer width to be applied. Expressed meters (the default), km or Miles (see unit)
• unit: - If width is not in meters use one of unit=:km, or unit=:Nautical or unit=:Miles
• np: - Number of points into which circles are descretized (Default = 120)
• flatstart - When computing buffers arround poly-lines make the start flat (no half-circle)
• flatend - Same as flatstart but for the buffer end
• proj - If line data is in Cartesians but with a known projection pass in a PROJ4 string to allow computing the buffer
• epsg - Same as proj but using an EPSG code
• tol - At the end simplify the buffer line with a Douglas-Peucker procedure. Use TOL=0 to NOT do the line simplification, or use any other value in degrees. Default computes it as 0.5% of buffer width.

Returns

A GMT dataset or a vector of it (when input is Vector{GMTdataset})

Example: Compute a buffer with 50000 m width

D = buffergeo([0 0; 10 10; 15 20], width=50000);

circgeo(lon, lat; radius=X, proj="", s_srs="", epsg=0, dataset=false, unit=:m, np=120, shape="")

or

circgeo(lonlat; radius=X, proj="", s_srs="", epsg=0, dataset=false, unit=:m, np=120, shape="")

Args:

• lonlat: - longitude, latitude (degrees). If a Mx2 matrix, returns as many segments as number of rows. Use this to compute multiple shapes at different positions. In this case output type is

			always a vector of GMTdatasets.

• radius: - The circle radius in meters (but see unit) or circumscribing circle for the other shapes
• proj or s_srs: - the given projection whose ellipsoid we move along. Can be a proj4 string or an WKT
• epsg: - Alternative way of specifying the projection [Default is WGS84]
• dataset: - If true returns a GMTdataset instead of matrix (with single shapes)
• unit: - If radius is not in meters use one of unit=:km, or unit=:Nautical or unit=:Miles
• np: - Number of points into which the circle is descretized (Default = 120)
• shape: - Optional string/symbol with "triangle", "square", "pentagon" or "hexagon" (or just the first char) to compute one of those geometries instead of a circle. np is ignored in these cases.

Returns

• circ - A Mx2 matrix or GMTdataset with the circle coordinates

Example: Compute circle about the (0,0) point with a radius of 50 km

c = circgeo([0.,0], radius=50, unit=:k)

clip(cmd0::String="", arg1=nothing; kwargs...)

Reads (length,azimuth) pairs from file and plot a windclip diagram.

Full option list at psclip

Parameters

• C | endclippath :: [Type => Bool]

  Mark end of existing clip path. No input file is needed. (http://docs.generic-mapping-tools.org/latest/psclip.html#c)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• A | inc :: [Type => Str or []]

  By default, geographic line segments are connected as great circle arcs. To connect them as straight lines, use A (http://docs.generic-mapping-tools.org/latest/psclip.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• Jz | zscale | zsize :: [Type => String]

• N | invert :: [Type => Bool]

  Invert the sense of the test, i.e., clip regions where there is data coverage. (http://docs.generic-mapping-tools.org/latest/psclip.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• T | clip_limits :: [Type => Bool]

  Rather than read any input files, simply turn on clipping for the current map region. (http://docs.generic-mapping-tools.org/latest/psclip.html#t)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

coast(cmd0::String=""; kwargs...)

Plot continents, shorelines, rivers, and borders on maps. Plots grayshaded, colored, or textured land-masses [or water-masses] on maps and [optionally] draws coastlines, rivers, and political boundaries. A map projection must be supplied.

Full option list at coast

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• A | area :: [Type => Str or Number]

  Features with an area smaller than minarea in km^2 or of hierarchical level that is lower than minlevel or higher than max_level will not be plotted. (http://docs.generic-mapping-tools.org/latest/coast.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | river_fill :: [Type => Str]

  Set the shade, color, or pattern for lakes and river-lakes. (http://docs.generic-mapping-tools.org/latest/coast.html#c)

• D | res | resolution :: [Type => Str] $Arg = c|l|i|h|f|a$

  Selects the resolution of the data set to use ((f)ull, (h)igh, (i)ntermediate, (l)ow, (c)rude), or (a)uto). (http://docs.generic-mapping-tools.org/latest/coast.html#d)

• E | DCW :: [Type => Str]

  Select painting or dumping country polygons from the Digital Chart of the World. (http://docs.generic-mapping-tools.org/latest/coast.html#e)

  • Tuple("code", Str); Tuple(code, number); Tuple("code" [,"fill"], (pen)); Tuple((...),(...),...)
  • ex: ("PT",(0.5,"red","–")); (("PT","gblue",(0.5,"red"),("ES",(0.5,"yellow")))

  • DCW=:PT; DCW=(:PT, 1); DCW=("PT", :red)

• F | box :: [Type => Str]

  Draws a rectangular border around the map scale or rose. (http://docs.generic-mapping-tools.org/latest/coast.html#f)

• G | land :: [Type => Str]

  Select filling or clipping of “dry” areas. (http://docs.generic-mapping-tools.org/latest/coast.html#g)

• I | rivers :: [Type => Str]

  Draw rivers. Specify the type of rivers and [optionally] append pen attributes. (http://docs.generic-mapping-tools.org/latest/coast.html#i)

• L | map_scale :: [Type => Str]

  Draw a map scale. (http://docs.generic-mapping-tools.org/latest/coast.html#l)

• M | dump :: [Type => Str]

  Dumps a single multisegment ASCII output. No plotting occurs. (http://docs.generic-mapping-tools.org/latest/coast.html#m)

• N | borders :: [Type => Str]

  Draw political boundaries. Specify the type of boundary and [optionally] append pen attributes (http://docs.generic-mapping-tools.org/latest/coast.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• clip :: [Type => Str] $Arg = land|water|end$

  To clip land do clip=:land, clip=:water clips water. Use end to mark end of existing clip path. No projection information is needed. (http://docs.generic-mapping-tools.org/latest/coast.html#q)

• S | water | ocean :: [Type => Str]

  Select filling or clipping of “wet” areas. (http://docs.generic-mapping-tools.org/latest/coast.html#s)

• Td | rose` :: [Type => Str]

  Draws a map directional rose on the map at the location defined by the reference and anchor points. (http://docs.generic-mapping-tools.org/latest/coast.html#t)

• Tm | compass :: [Type => Str]

  Draws a map magnetic rose on the map at the location defined by the reference and anchor points. (http://docs.generic-mapping-tools.org/latest/coast.html#t)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | shore | shorelines | coast :: [Type => Str] Draw shorelines [Default is no shorelines]. Append pen attributes. (http://docs.generic-mapping-tools.org/latest/coast.html#w)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

colorbar(cmd0::String="", arg1=nothing; kwargs...)

Plots gray scales or color scales on maps.

Full option list at psscale

• D | pos | position :: [Type => Str]

  Defines the reference point on the map for the color scale using one of four coordinate systems. (http://docs.generic-mapping-tools.org/latest/psscale.html#d)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• F | box :: [Type => Str]

  Draws a rectangular border around the scale. (http://docs.generic-mapping-tools.org/latest/psscale.html#f)

• G | truncate :: [Type => Str]

  Truncate the incoming CPT so that the lowest and highest z-levels are to zlo and zhi. (http://docs.generic-mapping-tools.org/latest/psscale.html#g)

• I | shade :: [Type => Number | Str]

  Add illumination effects. (http://docs.generic-mapping-tools.org/latest/psscale.html#i)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• Jz | zscale | zsize :: [Type => String]

• L | equal | equal_size :: [Type => Str | Bool] Arg = [i][gap]

  Gives equal-sized color rectangles. Default scales rectangles according to the z-range in the CPT. (http://docs.generic-mapping-tools.org/latest/psscale.html#l)

• M | monochrome :: [Type => Bool]

  Force conversion to monochrome image using the (television) YIQ transformation. (http://docs.generic-mapping-tools.org/latest/psscale.html#m)

• N | dpi :: [Type => Str | Number]

  Controls how the color scale is represented by the PostScript language. (http://docs.generic-mapping-tools.org/latest/psscale.html#n)

• Q | log :: [Type => Str]

  Selects a logarithmic interpolation scheme [Default is linear]. (http://docs.generic-mapping-tools.org/latest/psscale.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | nolines :: [Type => Bool | []]

  Do not separate different color intervals with black grid lines.

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | zscale :: [Type => Number]

  Multiply all z-values in the CPT by the provided scale. (http://docs.generic-mapping-tools.org/latest/psscale.html#w)

• Z | zfile :: [Type => Str]

  File with colorbar-width per color entry. (http://docs.generic-mapping-tools.org/latest/psscale.html#z)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

colorzones(shapes::Vector{GMTdataset}[, fun::Function]; img::GMTimage=nothing, url::AbstractString="", layer=0, pixelsize::Int=0, append::Bool=true)

Paint the polygons in the shapes with the average color that those polygons ocupy in the img image. When the shapes are plotted the resulting image looks like a choropleth map. Alternatively, instead of transmitting the img image one can provide a WMS URL, layer number and pixelsize to download images from the Web Map Server service, covering each one the bounding box of each of the shapes polygons. This option is much slower than passing the entire image at once but consumes much less memory. Important when the total area is large (think Russia size) because even at a moderately resultion it can imply downloading a huge file.

Parameters

• shapes: A vector of GMTdataset containing the polygons to be painted. This container will be changed in the sense that the $header$ field of each polygon (a GMTdataset) will be appended with the fill color (but see also the append option that controls how this change takes place.)
• fun: By default the average color is obtained by taking the square root of the average of squares of each of the three (RGB) bands (or just one for grayscale images). Give the name of another function to replace this default. For example $median$ will assign the color by computing the median of each component inside the polygon area in question.
• img: the image from which the stats (fun) of each color for each polygon will be computed.
• url: In case the img option is not used, pass the Web Map Server URL (see the $wmsinfo$ and $wmsread$ functions) from where the the images covering the BoundingBox of each polygon will be downloaded. Warning, this is a much slower method but potentially usefull when the images to download risk to be very big.
• layer: When the url option is used this one becomes mandatory and represents the layer number or layer name of interest from those provided by the WMS service. That is, both of these forms are allowed: layer=3 or layer="Invented layer name"
• pixelsize: Sets the requested cell size in meters [default]. Use a string appended with a 'd' (e.g. resolution="0.001d") if the resolution is given in degrees. This way works only when the layer is in geogs.
• append: By default the color assignement to each of the polygons in the shapes vector is achieved by appending the fill color to the possibly existing header field. Running the $colorzones$ command more than once keeps adding (now ignored, because only the first is used) colors. Setting append=false forces rewriting the header field at each run and hence the assigned color is always the one used (but the previous header is cleared out).

See also: $rasterzones!$

Returns

It does't return anything but the input shapes is modified.

Example

Read the 2020 Sentinel2 Earth color for Portugal at 100 m resolution. Load the administrative
regions and compute their median colors.

wms = wmsinfo("http://tiles.maps.eox.at/wms?");
img = wmsread(wms, layer=3, region=(-9.6,-6,36.9,42.2), pixelsize=100);
Pt = gmtread("C:\programs\compa_libs\covid19pt\extra\mapas\concelhos\concelhos.shp");
colorzones(Pt, median, img=img);
imshow(Pt, proj=:guess)

contour(cmd0::String="", arg1=nothing; kwargs...)

Reads a table data and produces a raw contour plot by triangulation.

Full option list at contour

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• A | annot :: [Type => Str | Number] $Arg = [-|[+]annot_int][labelinfo]$

  annot_int is annotation interval in data units; it is ignored if contour levels are given in a file. (http://docs.generic-mapping-tools.org/latest/contour.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | cont | contour | contours | levels :: [Type => Str | Number | GMTcpt] $Arg = [+]cont_int$

  Contours to be drawn may be specified in one of three possible ways. (http://docs.generic-mapping-tools.org/latest/contour.html#c)

• D | dump :: [Type => Str]

  Dump contours as data line segments; no plotting takes place. (http://docs.generic-mapping-tools.org/latest/contour.html#d)

• E | index :: [Type => Str | Mx3 array]

  Give name of file with network information. Each record must contain triplets of node numbers for a triangle. (http://docs.generic-mapping-tools.org/latest/contour.html#e)

• G | labels :: [Type => Str]

  Controls the placement of labels along the quoted lines. (http://docs.generic-mapping-tools.org/latest/contour.html#g)

• I | fill | colorize :: [Type => Bool]

  Color the triangles using the color scale provided via C. (http://docs.generic-mapping-tools.org/latest/contour.html#i)

• Jz | zscale | zsize :: [Type => String]

• L | mesh :: [Type => Str | Number]

  Draw the underlying triangular mesh using the specified pen attributes (if not provided, use default pen) (http://docs.generic-mapping-tools.org/latest/contour.html#l)

• N | no_clip :: [Type => Bool]

  Do NOT clip contours or image at the boundaries [Default will clip to fit inside region]. (http://docs.generic-mapping-tools.org/latest/contour.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Q | cut :: [Type => Str | Number] $Arg = [cut[unit]][+z]]$

  Do not draw contours with less than cut number of points. (http://docs.generic-mapping-tools.org/latest/contour.html#q)

• S | skip :: [Type => Str | []] $Arg = [p|t]$

  Skip all input xyz points that fall outside the region. (http://docs.generic-mapping-tools.org/latest/contour.html#s)

• T | ticks :: [Type => Str] $Arg = [+|-][+a][+dgap[/length]][+l[labels]]$

  Draw tick marks pointing in the downward direction every gap along the innermost closed contours. (http://docs.generic-mapping-tools.org/latest/contour.html#t)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | pen :: [Type => Str | Number]

  Sets the attributes for the particular line. (http://docs.generic-mapping-tools.org/latest/contour.html#w)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• Z | scale :: [Type => Str]

  Use to subtract shift from the data and multiply the results by factor before contouring starts. (http://docs.generic-mapping-tools.org/latest/contour.html#z)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• do | nodata_out :: [Type => Str or Number] $Arg = nodata$

  Examine all output columns and if any item equals NAN substitute it with the chosen missing data value. (http://docs.generic-mapping-tools.org/latest/gmt.html#do-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

contourf(cmd0::String="", arg1=nothing; kwargs...)

Performs Delaunay triangulation on x,y[,z] data, i.e., it find how the points should be connected to give the most equilateral triangulation possible.

Full option list at triangulate

Parameters

• A | annot :: [Type => Str | Number] $Arg = [-|[+]annot_int][labelinfo]$

  annot_int is annotation interval in data units; it is ignored if contour levels are given in a file. (http://docs.generic-mapping-tools.org/latest/contour.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | cont | contour | contours | levels :: [Type => Str | Number | GMTcpt] $Arg = [+]cont_int$

  Contours to be drawn may be specified in one of three possible ways. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#c)

• E | index :: [Type => Str | Mx3 array]

  Give name of file with network information. Each record must contain triplets of node numbers for a triangle. (http://docs.generic-mapping-tools.org/latest/contour.html#e)

• G | labels :: [Type => Str]

  Controls the placement of labels along the quoted lines. (http://docs.generic-mapping-tools.org/latest/contour.html#g)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Q | cut :: [Type => Str | Number] $Arg = [cut[unit]][+z]]$

  Do not draw contours with less than cut number of points. (http://docs.generic-mapping-tools.org/latest/contour.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | skip :: [Type => Str | []] $Arg = [p|t]$

  Skip all input xyz points that fall outside the region (Used when input data is a table). (http://docs.generic-mapping-tools.org/latest/contour.html#s)

• S | smooth :: [Type => Number]

  Used to resample the contour lines at roughly every (gridbox_size/smoothfactor) interval. (Used when input data is a grid) (http://docs.generic-mapping-tools.org/latest/grdcontour.html#s)

• T | ticks :: [Type => Str] $Arg = [+|-][+a][+dgap[/length]][+l[labels]]$

  Draw tick marks pointing in the downward direction every gap along the innermost closed contours. (http://docs.generic-mapping-tools.org/latest/contour.html#t)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | pen :: [Type => Str | Number]

  Sets the attributes for the particular line. (http://docs.generic-mapping-tools.org/latest/contour.html#w)

• Z | xyz | triplets :: [Type => Bool]

  (http://docs.generic-mapping-tools.org/latest/triangulate.html#z)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

Examples

    G = GMT.peaks();
    C = makecpt(T=(-7,9,2));

    contourf(G, show=1)
    contourf(G, C=[-2, 0, 2, 5], show=1)
    contourf(G, C, contour=[-2, 0, 2, 5], show=1)
    contourf(G, C, annot=[-2, 0, 2, 5], show=1)
    contourf(G, C, annot=2, show=1)
    contourf(G, C, contour=1, annot=[-2, 0, 2, 5], show=1)
    contourf(G, C, annot=:none, show=1)

    d = [0 2 5; 1 4 5; 2 0.5 5; 3 3 9; 4 4.5 5; 4.2 1.2 5; 6 3 1; 8 1 5; 9 4.5 5];
    contourf(d, limits=(-0.5,9.5,0,5), pen=0.25, labels=(line=(:min,:max),), show=1)

coupe(cmd0::String="", arg1=nothing; kwargs...)

Plot cross-sections of focal mechanisms.

Full option list at pscoupe. Essentially the same as meca plus A. Run gmthelp(coupe) to see the list.

C = cpt4dcw(codes::String, vals::Vector{<:Real}; kwargs...)

Create a categorical CPT to use with the output of coast(dcw=...) to make Choropleth maps.

• codes is a comma separated string with two chars country codes (ex: "PT,ES,FR,IT")
• vals a vector with same size as number of country codes, with the values used to colorize the countries

Optionally provide a CPT in the kwarg cmap=CPT with a range sufficient to tansform the vals in colors. As an alternative to the above provide a makecpt type range numeric vector to create a CPT. If none of these are provided a default CPT = makecpt(range=(0,255,1)) will be used.

crop(arg::GItype; kw...)

Crop a subregion of a grid (GMTgrid) or a image (GMTimage). The subregion is specified with the $limits$ or $region$ keyword; the specified range must not exceed the range of the input. This function differs from $grdcut$ in the sense that it doesn't call the GMT lib and works only on in-memory array (i.e., no disk files).

Returns

A grid or an image, depending on the input type, plus two 1x2 matrices with the indices of the cropped zone.

Example

G = GMT.peaks();
crop(G, region=(-2,2,-2,2))

date2doy(date) -> Integer

Compute the Day-Of-Year (DOY) from date that can be a string or a Date/DateTime type. If ommited, returns today's DOY

doy2date(doy[, year]) -> Date

Compute the date from the Day-Of-Year doy. If year is ommited we take it to mean the current year. Both doy and year can be strings or integers.

ids, ind = dsget_segment_ids(D, case=0)::Tuple{Vector{String}, Vector{Int}}

Where D is a GMTdataset or a vector of them, returns the segment ids (first text after the '>') and the indices of those segments.

earthtide(cmd0::String=""; kwargs...)

Compute grids or time-series of solid Earth tides.

Full option list at earthtide

	G = earthtide();
	imshow(G)

epsg2proj(code::Integer)

Convert a EPSG code into the PROJ4 form.

epsg2wkt(code::Integer, pretty::Bool=false)

Convert a EPSG code into the WKT form. Use pretty=true to return a more human readable text.

filter1d(cmd0::String="", arg1=nothing, kwargs...)

Time domain filtering of 1-D data tables.

Full option list at filter1d

Parameters

• F | filter_type :: [Type => Str] Arg = type width[modifiers]

  Sets the filter type. Choose among convolution and non-convolution filters. Append the filter code followed by the full filter width in same units as time column. (http://docs.generic-mapping-tools.org/latest/filter1d.html#f)

• D | inc :: [Type => Number] Arg = increment

  $increment$ is used when series is NOT equidistantly sampled. Then increment will be the abscissae resolution. (http://docs.generic-mapping-tools.org/latest/filter1d.html#d)

• E | end | ends :: [Type => Bool | []]

  Include Ends of time series in output. Default loses half the filter-width of data at each end. (http://docs.generic-mapping-tools.org/latest/filter1d.html#e)

• L | gap_width :: [Type => Number | Str] Arg = width

  Checks for Lack of data condition. If input data has a gap exceeding width then no output will be given at that point. (http://docs.generic-mapping-tools.org/latest/filter1d.html#l)

• N | time_col :: [Type => Int] Arg = t_col

  Indicates which column contains the independent variable (time). The left-most column is # 0, the right-most is # (n_cols - 1). [Default is 0]. (http://docs.generic-mapping-tools.org/latest/filter1d.html#n)

• Q | quality :: [Type => Number] Arg = q_factor

  Assess Quality of output value by checking mean weight in convolution. Enter q_factor between 0 and 1. (http://docs.generic-mapping-tools.org/latest/filter1d.html#q)

• S | symetry :: [Type => Number] Arg = symmetry_factor

  Checks symmetry of data about window center. Enter a factor between 0 and 1. (http://docs.generic-mapping-tools.org/latest/filter1d.html#s)

• T | equi_space :: [Type => List | Str] Arg = [min/max/]inc[+a|n]

  Make evenly spaced time-steps from min to max by inc [Default uses input times]. (http://docs.generic-mapping-tools.org/latest/filter1d.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

fitcircle(cmd0::String="", arg1=nothing, kwargs...)

Find mean position and great [or small] circle fit to points on a sphere.

Full option list at fitcircle

Parameters

• L | norm :: [Type => Int | []]

  Specify the desired norm as 1 or 2, or use [] or 3 to see both solutions. (http://docs.generic-mapping-tools.org/latest/fitcircle.html#l)

• F | coord | coordinates :: [Type => Str] Arg = f|m|n|s|c

  Only return data coordinates, and append Arg to specify which coordinates you would like. (http://docs.generic-mapping-tools.org/latest/fitcircle.html#f)

• S | symetry :: [Type => Number] Arg = symmetry_factor

  Attempt to (http://docs.generic-mapping-tools.org/latest/fitcircle.html#s)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gadm(country, subregions...; children=false, names=false, children_raw=false, reportlevels=false)

Returns a GMTdataset for the requested country, or country subregion(s)

1. country: ISO 3166 Alpha 3 country code .
2. subregions: Full official names in hierarchial order (provinces, districts, etc...). To know the names of all administrative children of parent, use the option names.
3. children: When true, function returns all subregions of parent.
4. children_raw: When true, function returns two variables -> parent, children, where children is a GDAL object E.g. when children is set to true and when querying just the country, second return parameter are the states/provinces. If children we return a Vector of GMTdataset with the polygons. If children_raw the second output is a GDAL object much like in GADM.jl (less the Tables.jl)
5. names: Return a string vector with all children names.
6. reportlevels: just report the number of administrative levels (including the country) and exit.

Examples

# data of India's borders
data = gadm("IND")

# uttar -> the limits of the Uttar Pradesh state
uttar = gadm("IND", "Uttar Pradesh")

# uttar -> limits of all districts of the  Uttar Pradesh state
uttar = gadm("IND", "Uttar Pradesh", children=true)

# Names of all states of India
gadm("IND", names=true)

gammacorrection(I::GMTimage, gamma; contrast=[0.0, 1.0], brightness=[0.0, 1.0])

Apply a gamma correction to a 2D (intensity) GMTimage using the exponent gamma. Optionally set also contrast and/or brightness

Returns

A GMT intensity Image

O = gd2gmt(dataset; band=0, bands=[], sds=0, pad=0)

Convert a GDAL raster dataset into either a GMTgrid (if type is Int16 or Float) or a GMTimage type Use band to select a single band of the dataset. When you know that the dataset contains several bands of an image, use the kwarg bands with a vector the wished bands. By default it reads all bands of the image or grid object.

When DATASET is a string it may contain the file name or the name of a subdataset. In former case you can use the kwarg sds to selec the subdataset numerically. Alternatively, provide the full sds name. For files with sds with a scale_factor (e.g. MODIS data), that scale is applyied automaticaly.

Examples:

   G = gd2gmt("AQUA_MODIS.20210228.L3m.DAY.NSST.sst.4km.NRT.nc", sds=1);
or
   G = gd2gmt("SUBDATASET_1_NAME=NETCDF:AQUA_MODIS.20210228.L3m.DAY.NSST.sst.4km.NRT.nc:sst");
or
   G = gd2gmt("NETCDF:AQUA_MODIS.20210228.L3m.DAY.NSST.sst.4km.NRT.nc:sst");

gdalread(fname::AbstractString, opts=String[]; gdataset=false, kwargs...)

Read a raster or a vector file from a disk file and return the result either as a GMT type (the default) or a GDAL dataset.

• fname: Input data. It can be a file name, a GMTgrid or GMTimage object or a GDAL dataset
• opts: List of options. The accepted options are the ones of the gdal_translate utility. This list can be in the form of a vector of strings, or joined in a simgle string.
• gdataset: If set to true forces the return of a GDAL dataset instead of a GMT type.
• kwargs: This options accept the GMT region (-R) and increment (-I)

Returns

A GMT grid/image or a GDAL dataset

gdalshade(filename; kwargs...)

Create a shaded relief with the GDAL method (color image blended with shaded intensity).

• kwargs hold the keyword=value to pass the arguments to gdaldem hillshade

Example: I = gdalshade("hawaii_south.grd", C="faa.cpt", zfactor=4);

Returns

A GMT RGB Image

gdalwrite(data, fname::AbstractString, opts=String[]; kwargs...)

or

gdalwrite(fname::AbstractString, data, opts=String[]; kwargs...)

Write a raster or a vector file to disk

• fname: Output file name. If not explicitly selected via opts the used driver will be picked from the file extension.
• data: The data to be saved in file. It can be a GMT type or a GDAL dataset.
• opts: List of options. The accepted options are the ones of the gdal_translate or ogr2ogr utility. This list can be in the form of a vector of strings, or joined in a simgle string.
• kwargs: This options accept the GMT region (-R) and increment (-I)

or

gdalwrite(cube, fname::AbstractString, v=nothing; dim_name::String="time", dim_units::String="")

Write a MxNxP cube object to disk as a multilayered file.

• cube: A GMTgrid or GMTimage cube
• fname: The file name where to save the cube
• v: A vector with the coordinates of the Z layers (if omitted create one as 1:size(cube,3))
• dim_name: The name of the variable of the $vertical$ dimension.
• dim_units: The units of the v vector. If not provided, use the cube.z_units if exist (GMTgrid only)

geod(lonlat, azim, distance; proj::String="", s_srs::String="", epsg::Integer=0, dataset=false, unit=:m)

Solve the direct geodesic problem.

Args:

• lonlat: - longitude, latitude (degrees). This can be a vector or a matrix with one row only.
• azimuth: - azimuth (degrees) ∈ [-540, 540)
• distance: - distance to move from (lat,lon); can be negative, Default is meters but see unit
• proj or s_srs: - the given projection whose ellipsoid we move along. Can be a proj4 string or an WKT
• epsg: - Alternative way of specifying the projection [Default is WGS84]
• dataset: - If true returns a GMTdataset instead of matrix
• unit: - If distance is not in meters use one of unit=:km, or unit=:Nautical or unit=:Miles

The distance argument can be a scalar, a Vector, a Vector{Vector} or an AbstractRange. The azimuth can be a scalar or a Vector.

When azimuth is a Vector we always return a GMTdataset with the multiple lines. Use this together with a non-scalar distance to get lines with multiple points along the line. The number of points along line does not even need to be the same. For data, give the distance as a Vector{Vector} where each element of distance is a vector with the distances of the points along a line. In this case the number of distance elements must be equal to the number of azimuth.

Returns

• dest - destination after moving for [distance] metres in [azimuth] direction.
• azi - forward azimuth (degrees) at destination [dest].

Example: Compute two lines starting at (0,0) with lengths 111100 & 50000, heading at 15 and 45 degrees.

geod([0., 0], [15., 45], [[0, 10000, 50000, 111100.], [0., 50000]])[1]

Convert from geodetic coordinates to local East, North, Up (ENU) coordinates.

getbyattrib(D::Vector{<:GMTdataset}[, index::Bool]; kw...)

Take a GMTdataset vector and return only its elememts that match the condition(s) set by the attrib keywords. Note, this assumes that D has its attrib fields set with usable information.

Parameters

• attrib or att: keyword with the attribute $name$ used in selection. It can be a single name as in att="NAME_2" or a NamedTuple with the attribname, attribvalue as in att=(NAME_2="value"). Use more elements if wishing to do a composite match. E.g. att=(NAME_1="val1", NAME_2="val2") in which case oly segments matching the two conditions are returned.
• val or value: keyword with the attribute $value$ used in selection. Use this only when att is not a NamedTuple.
• index: Use this $positional$ argument = true to return only the segment indices that match the att condition(s).

Returns

Either a vector of GMTdataset, or a vector of Int with the indices of the segments that match the query condition. Or $nothing$ if the query results in an empty GMTdataset

Example:

D = getbyattrib(D, attrib="NAME_2", val="Porto");

Call a GMT module. This function is not called directly by the users, except when using the $monolithic$ mode. Usage:

gmt("module_name `options`", args...)

ds = gmt2gd(GI)

Create GDAL dataset from the contents of GI that can be either a Grid or an Image

ds = gmt2gd(D, save="", geometry="")

Create GDAL dataset from the contents of D, which can be a GMTdataset, a vector of GMTdataset ir a MxN array. The save keyword instructs GDAL to save the contents as an OGR file. Format is determined by file estension. geometry can be a string with "polygon", where file will be converted to polygon/multipolygon depending on D is a single or a multi-segment object, or "point" to convert to a multipoint geometry.

gmt2kml(cmd0::String="", arg1=nothing, kwargs...)

Convert GMT data tables to KML files for Google Earth

Full option list at gmt2kml

Parameters

• A | altitude_mode :: [Type => Str] $Arg = a|g|s[alt|xscale]$

  Select one of three altitude modes recognized by Google Earth that determines the altitude (in m) of the feature: $a$ absolute altitude, $g$ altitude relative to sea surface or ground, $s$ altitude relative to seafloor or ground. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#a)

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• D | descript :: [Type => Str] $Arg = descriptfile$

  File with HTML snippets that will be included as part of the main description content for the KML file. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#d)

• E | extrude :: [Type => Str | []] $Arg = [altitude]$

  Extrude feature down to ground level. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#e)

• F | feature_type :: [Type => Str] $Arg = e|s|t|l|p|w$

  Sets the feature type. Choose from points (event, symbol, or timespan), line, polygon, or wiggle. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#f)

• G | fill :: [Type => Str] $Arg = f|nfill$

  Sets color fill (G=:f) or label font color (G=:n). (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#g)

• I | icon :: [Type => Str] $Arg = icon$

  Specify the URL to an alternative icon that should be used for the symbol [Default is a Google Earth circle]. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#i)

• K | not_finished :: [Type => Bool]

  Allow more KML code to be appended to the output later [finalize the KML file]. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#k)

• L | extended_data :: [Type => Str] $Arg = name1,name2,…$

  Extended data given. Append one or more column names separated by commas. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#l)

• N | feature_name :: [Type => Str | Number] $Arg = [t|col |name_template|name]$

  By default, if segment headers contain a -L”label string” then we use that for the name of the KML feature. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#n)

• O | overlay :: [Type => Bool]

  Append KML code to an existing KML file [initialize a new KML file]. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#o)

• Qa | wiggles :: [Type => Str] $Arg = azimuth$

  Option in support of wiggle plots (requires F=:w). (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#q)

• Qs | wiggle_scale :: [Type => Str | Number] $Arg = scale[unit]$

  Required setting for wiggle plots (i.e., it requires F=:w). Sets a wiggle scale in z-data units per the user’s units (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | scale :: [Type => Str] $Arg = c|nscale$

  Scale icons or labels. Here, S=:c sets a scale for the symbol icon, whereas S=:n sets a scale for the name labels (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#s)

• T | title :: [Type => Str] $Arg = title[/foldername]$

  Sets the document title [default is unset]. Optionally, append /FolderName; (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#t)

• W | pen :: [Type => Str | []] $Arg = [pen][attr]$

  Set pen attributes for lines, wiggles or polygon outlines. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#w)

• Z | attrib :: [Type => Str] $Arg = args$

  Set one or more attributes of the Document and Region tags. (http://docs.generic-mapping-tools.org/latest/gmt2kml.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtbegin(name::String=""; fmt)

Start a GMT session in modern mode (GMT >= 6). 'name' contains the figure name with or without extension. If an extension is used (e.g. "map.pdf") it is used to select the image format.

As an alternative use 'fmt' as a string or symbol containing the format (ps, pdf, png, PNG, tif, jpg, eps).

By default name="GMTplot" and fmt="ps"

gmtconnect(cmd0::String="", arg1=nothing, kwargs...)

Connect individual lines whose end points match within tolerance

Full option list at gmtconnect

Parameters

• C | closed :: [Type => Str | []] Arg = [closed]

  Write all the closed polygons to closed [gmtgmtconnect_closed.txt] and return all other segments as they are. No gmtconnection takes place. (http://docs.generic-mapping-tools.org/latest/gmtconnect.html#c)

• D | dump :: [Type => Str | []] Arg = [template]

  For multiple segment data, dump each segment to a separate output file (http://docs.generic-mapping-tools.org/latest/gmtconnect.html#d)

• L | linkfile :: [Type => Str | []] Arg = [linkfile]

  Writes the link information to the specified file [gmtgmtconnect_link.txt]. (http://docs.generic-mapping-tools.org/latest/gmtconnect.html#l)

• Q | list_file :: [Type => Str | []] Arg = [listfile]

  Used with D to write a list file with the names of the individual output files. (http://docs.generic-mapping-tools.org/latest/gmtconnect.html#q)

• T | tolerance :: [Type => Str | List] Arg = [cutoff[unit][/nn_dist]]

  Specifies the separation tolerance in the data coordinate units [0]; append distance unit. If two lines has end-points that are closer than this cutoff they will be joined. (http://docs.generic-mapping-tools.org/latest/gmtconnect.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtconvert(cmd0::String="", arg1=nothing, kwargs...)

Convert, Paste, and/or Extract columns from data tables

Full option list at gmtconvert

Parameters

• A | h_cat :: [Type => Str | []]

  The records from the input files should be pasted horizontally, not appended vertically [Default]. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#a)

• C | n_records :: [Type => Str] $Arg = [+lmin][+umax][+i]$

  Only output segments whose number of records matches your given criteria: (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#c)

• D | dump :: [Type => Str | []] $Arg = [template[+oorig]]$

  For multiple segment data, dump each segment to a separate output file. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#d)

• E | first_last :: [Type => Str | []] $Arg = [f|l|m|Mstride]$

  Only extract the first and last record for each segment of interest. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#e)

• F | conn_method :: [Type => Str | []] $Arg = [c|n|r|v][refpoint]$

  Alter the way points are connected (by specifying a scheme) and data are grouped (by specifying a method). (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#f)

• I | invert | reverse :: [Type => Str | Bool] $Arg = [tsr]$

  Invert the order of items, i.e., output the items in reverse order, starting with the last and ending up with the first item. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#i)

• L | list_only :: -[Type => Bool]

  Only output a listing of all segment header records and no data records. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#l)

• N | sort :: [Type => Str | Number] $Arg = [-|+]col$

  Numerically sort each segment based on values in column col. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#n)

• Q | select_num :: [Type => Str] $Arg = [~]selection$

  Only write segments whose number is included in $selection$ and skip all others. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#q)

• S | select_hdr :: [Type => Str] $Arg = [~]”search string” or [~]/regexp/[i]$

  Only output those segments whose header record contains the specified text string. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#s)

• T | suppress | skip :: [Type => Str | []] $Arg = [h|d]$

  Suppress the writing of certain records on output. Append h to suppress segment headers [Default] or d to suppress duplicate data records. Use T=:hd to suppress both types of records. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#t)

• W | word2num :: [Type => Str | []] $Arg = [+n]$

  Attempt to gmtconvert each word in the trialing text to a number and append such values to the numerical output columns. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#w)

• Z | range :: [Type => Str | []] $Arg = [first][:last]$

  Limit output to the specified record range. If first is not set it defaults to record 0 (very first record) and if last is not set then it defaults to the very last record. (http://docs.generic-mapping-tools.org/latest/gmtconvert.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• s | skiprows | skip_NaN :: [Type => Str] $Arg = [cols][a|r]$

  Suppress output for records whose z-value equals NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#s-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtend(show=false, verbose=nothing)

Ends a GMT session in modern mode (GMT >= 6) and optionaly shows the figure

function gmtfig(name::String; fmt=nothing, opts="")

Set attributes for the current modern mode session figure. 'name' name of the new (or resumed) figure. It may contain an extension. 'fmt' figures graphics format (or formats, e.g. fmt="eps,pdf"). Not needed if 'name' has extension 'opts' Sets one or more comma-separated options (and possibly arguments) that can be passed to psconvert when preparing this figure.

gmtgravmag3d(cmd0::String=""; kwargs...)

Compute the gravity/magnetic anomaly of a 3-D body by the method of Okabe.

Full option list at gmtgravmag3d

Parameters

• C | density :: [Type => Str | GMTgrid]

  Sets body density in SI. Provide either a constant density or a grid with a variable one. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#c)

• F | track :: [Type => Str | Matrix | GMTdataset]

  Provide locations where the anomaly will be computed. Note this option is mutually exclusive with outgrid. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#f)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = gmtgravmag3d(....) form. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#g)

• H | mag_params :: [Type => Number]

  Sets parameters for computation of magnetic anomaly. Alternatively, provide a magnetic intensity grid. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#h)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#i)

• L | z_obs | observation_level :: [Type => Number]

  Sets level of observation [Default = 0]. That is the height (z) at which anomalies are computed. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#l)

• M | body :: [Type => Str | Tuple]

  Create geometric bodies and compute their grav/mag effect. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#m)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | radius :: [Type => Number]

  Set search radius in km (valid only in the two grids mode OR when thickness) [Default = 30 km]. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#s)

• Tv | index :: [Type => Str]

• Tr | raw_triang :: [Type => Str]

• Ts | stl :: [Type => Str]

  Gives names of a xyz and vertex (ndex="vert_file") files defining a close surface. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#t)

• Z | z_level | reference_level :: [Type => Number]

  Level of reference plane [Default = 0]. (http://docs.generic-mapping-tools.org/latest/gmtgravmag3d.html#z)

Example

	G = gmtgravmag3d(M=(shape=:prism, params=(1,1,1,5)), inc=1.0, region="-15/15/-15/15", mag_params="10/60/10/-10/40");
	imshow(G)

gmtinfo(cmd0::String="", arg1=nothing; kwargs...)

Reads files and finds the extreme values in each of the columns.

Full option list at gmtinfo

Parameters

• A | ranges :: [Type => Str]

  Specify how the range should be reported. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#a)

• C | numeric :: [Type => Bool]

  Report the min/max values per column in separate columns [Default uses <min/max> format]. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#c)

• D | center :: [Type => Bool]

  Modifies results obtained by -I by shifting the region to better align with the center of the data. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#d)

• E | get_record :: [Type => Str | []]

  Returns the record whose column col contains the minimum (l) or maximum (h) value. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#e)

• F | counts :: [Type => Str | []]

  Returns the counts of various records depending on the appended mode. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#f)

• I | inc | increment | spacing :: [Type => Str | Number | Tuple]

  Report the min/max of the first n columns to the nearest multiple of the provided increments and output results in the form -Rw/e/s/n (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#i)

• L | common_limits :: [Type => Bool]

  Determines common limits across tables or segments. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#l)

• S | forerrorbars :: [Type => Str | []]

  Add extra space for error bars. Useful together with I option and when later plotting with plot E. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#s)

• T | nearest_multiple :: [Type => Str | Number] $Arg = dz[+ccol]$

  Report the min/max of the first (0’th) column to the nearest multiple of dz and output this as the string -Tzmin/zmax/dz. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtmath(cmd::String, args...)

Call gmtmath with all commands in a single string 'cmd'. This is not useful in itself as compared to call gmt("gmtmath ....") but it's very useful in 'movie' because it can generate shell scripts from the julai command

Full option list at grdmath

gmtread(fname::String; kwargs...)

Read GMT object from file. The object is one of "grid" or "grd", "image" or "img", "data" or "table", "cmap" or "cpt" and "ps" (for postscript), and OGR formats (shp, kml, json). Use a type specificatin to force a certain reading path (e.g. grd=true to read grids) or take the chance of letting the data type be guessed via the file extension. Known extensions are:

• Grids: .grd, .nc
• Images: .jpg, .png, .tif, .tiff, .bmp, .webp
• Datasets: .dat, .txt, .csv
• Datasets: .shp, .kml, .json, .geojson, .gmt, .gpkg
• CPT: .cpt
• PostScript: .ps, .eps

Parameters

Specify data type (with type=true, e.g. img=true). Choose among:

• grd | grid :: [Type => Any]

  Load a grid.

• img | image :: [Type => Any]

  Load an image.

• cpt | cmap :: [Type => Any]

  Load a GMT color palette.

• data | dataset | table :: [Type => Any]

  Load a dataset (a table of numbers).

• ogr :: [Type => Any]

  Load a dataset via GDAL OGR (a table of numbers). Many things can happen here.

• ps :: [Type => Any]

  Load a PostScript file

• gdal :: [Type => Any]

  Force reading the file via GDAL. Should only be used to read grids.

• varname :: [Type => Str]

  When netCDF files have more than one 2D (or higher) variables use varname to pick the wished variable. e.g. varname=:slp to read the variable named 'slp'. This option defaults data type to 'grid'

• layer | band :: [Type => Str, Number, Array]

When files are multiband or nc files with 3D or 4D arrays, we access them via these keywords. layer=4 reads the fourth layer (or band) of the file. But the file can be a grid or an image. If it is a grid, layer can be a scalar (to read 3D arrays) or an array of two elements (to read a 4D array).

If file is an image layer can be a 1 or a 1x3 array (to read a RGB image). Not that in this later case bands do not need to be contiguous. A band=[1,5,2]` composes an RGB out of those bands. See more at http://docs.generic-mapping-tools.org/latest//GMT_Docs.html#modifiers-for-coards-compliant-netcdf-files) but note that we use 1 based indexing here.

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

Example: to read a nc called 'lixo.grd'

G = gmtread("lixo.grd");

to read a jpg image with the bands reversed (this example is currently broken in GMT5. Needs GMT6dev)

I = gmtread("image.jpg", band=[2,1,0]);

gmtselect(cmd0::String="", arg1=nothing, kwargs...)

Select data table subsets based on multiple spatial criteria.

Full option list at gmtselect

Parameters

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• A | area :: [Type => Str | Number]

  Features with an area smaller than minarea in km^2 or of hierarchical level that is lower than minlevel or higher than max_level will not be plotted. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#a)

• C | dist2pt | dist :: [Type => Str | NamedTuple] Arg = pointfile+ddist[unit] | (pts=Array, dist=xx)

  Pass all records whose location is within dist of any of the points in the ASCII file pointfile. If dist is zero then the 3rd column of pointfile must have each point’s individual radius of influence. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#c)

• D | res | resolution :: [Type => Str] Arg = c|l|i|h|f

  Ignored unless N is set. Selects the resolution of the coastline data set to use ((f)ull, (h)igh, (i)ntermediate, (l)ow, or (c)rude). (http://docs.generic-mapping-tools.org/latest/gmtselect.html#d)

• E | boundary :: [Type => Str | []] Arg = [fn]

  Specify how points exactly on a polygon boundary should be considered. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#e)

• F | polygon :: [Type => Str | GMTdaset | Mx2 array] Arg = polygonfile

  Pass all records whose location is within one of the closed polygons in the multiple-segment file $polygonfile$ or a GMTdataset type or a Mx2 array defining the polygon. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#f)

• G | gridmask :: [Type => Str | GRDgrid] Arg = gridmask

  Pass all locations that are inside the valid data area of the grid gridmask. Nodes that are outside are either NaN or zero. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#g)

• I | reverse :: [Type => Str | []] Arg = [cflrsz]

  Reverses the sense of the test for each of the criteria specified. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#i)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• L | dist2line :: [Type => Str | NamedTuple] Arg = linefile+ddist[unit][+p] | (pts=Array, dist=xx, ortho=_)

  Pass all records whose location is within dist of any of the line segments in the ASCII multiple-segment file linefile. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#l)

• N | mask :: [Type => Str | List] Arg = ocean/land/lake/island/pond or wet/dry

  Pass all records whose location is inside specified geographical features. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#n)

• Z | in_range :: [Type => Str | List] Arg = min[/max][+a][+ccol][+i]

  Pass all records whose 3rd column (z; col = 2) lies within the given range or is NaN. (http://docs.generic-mapping-tools.org/latest/gmtselect.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtset(cmd0::String="", kwargs...)

Adjust individual GMT defaults settings in the current directory’s gmt.conf file.

Full option list at gmtset

Parameters

• D | units :: [Type => Str | []]

  Modify the GMT defaults based on the system settings. Append u for US defaults or s for SI defaults. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#d)

• G | defaultsfile :: [Type => Str]

  Name of specific gmt.conf file to read and modify. (http://docs.generic-mapping-tools.org/latest/gmtinfo.html#g)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

gmtsimplify(cmd0::String="", arg1=nothing, kwargs...)

Line reduction using the Douglas-Peucker algorithm.

Full option list at gmtsimplify

Parameters

• T | tol | tolerance :: [Type => Str | Number] Arg = tolerance[unit]

  Specifies the maximum mismatch tolerance in the user units. If the data is not Cartesian then append the distance unit. (http://docs.generic-mapping-tools.org/latest/gmtsimplify.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtspatial(cmd0::String="", arg1=nothing, kwargs...)

Geospatial operations on points, lines and polygons.

Full option list at gmtspatial

Parameters

• A | nn | nearest_neighbor :: [Type => Str] Arg = [amin_dist][unit]

  Perform spatial nearest neighbor (NN) analysis: Determine the nearest neighbor of each point and report the NN distances and the point IDs involved in each pair. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#a)

• C | clip :: [Type => Bool]

  Clips polygons to the map region, including map boundary to the polygon as needed. The result is a closed polygon. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#c)

• D | duplicates :: [Type => Str] Arg = [+ffile][+aamax][+ddmax][+c|Ccmax][+sfact]

  Check for duplicates among the input lines or polygons, or, if file is given via +f, check if the input features already exist among the features in file. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#d)

• E | handedness :: [Type => Str] Arg = +|-

  Reset the handedness of all polygons to match the given + (counter-clockwise) or - (clockwise). Implies Q+ (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#e)

• F | force_polygons :: [Type => Str | []] Arg = [l]

  Force input data to become polygons on output, i.e., close them explicitly if not already closed. Optionally, append l to force line geometry. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#f)

• I | intersections :: [Type => Str | []] Arg = [e|i]

  Determine the intersection locations between all pairs of polygons. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#i)

• N | in_polyg :: [Type => Str] Arg = pfile[+a][+pstart][+r][+z]

  Determine if one (or all, with +a) points of each feature in the input data are inside any of the polygons given in the pfile. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#n)

• Q | area or length :: [Type => Str] Arg = [[-|+]unit][+cmin[/max]][+h][+l][+p][+s[a|d]]

  Measure the area of all polygons or length of line segments. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | polygons :: [Type => Str] Arg = h|i|j|s|u

  Spatial processing of polygons. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#s)

• T | truncate :: [Type => Str | []] Arg = [clippolygon]

  Truncate polygons against the specified polygon given, possibly resulting in open polygons. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | extend :: [Type => Str | Tuple] Arg = <dist>[<unit>][+f|l]

  Extend all segments with extra first and last points that are <dist> units away from the original end points in the directions implied by the line ends. (http://docs.generic-mapping-tools.org/latest/gmtspatial.html#w)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtsplit(cmd0::String="", arg1=nothing; kwargs...)

Reads a series of (x,y[,z]) records [or optionally (x,y,z,d,h)] and splits this into separate lists of (x,y[,z]) series, such that each series has a nearly constant azimuth through the x,y plane.

Full option list at gmtsplit

Parameters

• A | azim_tol :: [Type => Str | Array]

  Write out only those segments which are within +/- tolerance degrees of azimuth in heading, measured clockwise from North, [0 - 360]. (http://docs.generic-mapping-tools.org/latest/gmtsplit.html#a)

• C | course_change :: [Type => Number]

  Terminate a segment when a course change exceeding course_change degrees of heading is detected. (http://docs.generic-mapping-tools.org/latest/gmtsplit.html#c)

• D | min_dist | min_distance :: [Type => Number]

  Do not write a segment out unless it is at least minimum_distance units long. (http://docs.generic-mapping-tools.org/latest/gmtsplit.html#d)

• F | filter :: [Type => Str | Array]

  Filter the z values and/or the x,y values, assuming these are functions of d coordinate. xyfilter and zfilter are filter widths in distance units. (http://docs.generic-mapping-tools.org/latest/gmtsplit.html#f)

• Q | xyzdh :: [Type => Str]

  Specify your desired output using any combination of xyzdh, in any order. (http://docs.generic-mapping-tools.org/latest/gmtsplit.html#q)

• S | dh | dist_head :: [Type => Bool]

  Both d and h are supplied. In this case, input contains x,y,z,d,h. [Default expects (x,y,z) input, and d,h are computed from delta x, delta y. (http://docs.generic-mapping-tools.org/latest/gmtsplit.html#s)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• do | nodata_out :: [Type => Str or Number] $Arg = nodata$

  Examine all output columns and if any item equals NAN substitute it with the chosen missing data value. (http://docs.generic-mapping-tools.org/latest/gmt.html#do-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtvector(cmd0::String="", arg1=nothing, kwargs...)

Time domain filtering of 1-D data tables.

Full option list at gmtvector

Parameters

• A | single_vec :: [Type => Str] Arg = m[conf]|vector

  Specify a single, primary vector instead of reading tables. (http://docs.generic-mapping-tools.org/latest/gmtvector.html#a)

• C | cartesian :: [Type => Str | []] Arg = [i|o]

  Select Cartesian coordinates on input and output. (http://docs.generic-mapping-tools.org/latest/gmtvector.html#c)

• E | geod2geoc :: [Type => Bool]

  Convert input geographic coordinates from geodetic to geocentric and output geographic coordinates from geocentric to geodetic. (http://docs.generic-mapping-tools.org/latest/gmtvector.html#e)

• N | normalize :: [Type => Bool]

  Normalize the resultant vectors prior to reporting the output. (http://docs.generic-mapping-tools.org/latest/gmtvector.html#n)

• S | secondary_vec :: [Type => Str | List] Arg = [vector]

  Specify a single, secondary vector in the same format as the first vector. (http://docs.generic-mapping-tools.org/latest/gmtvector.html#s)

• T | transform :: [Type => Str | List] Arg = a|d|D|paz|s|r[arg|R|x]

  Specify the vector transformation of interest. (http://docs.generic-mapping-tools.org/latest/gmtvector.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

gmtwhich(cmd0::String; kwargs...)

Find full path to specified files

Full option list at gmtwhich

Parameters

• A | with_permissions :: [Type => Bool]

Only consider files that the user has permission to read [Default consider all files found].
(http://docs.generic-mapping-tools.org/latest/gmtwhich.html#a)

• C | confirm :: [Type => Bool]

Instead of reporting the paths, print the confirmation Y if the file is found and N if it is not.
(http://docs.generic-mapping-tools.org/latest/gmtwhich.html#c)

• D | report_dir :: [Type => Bool]

Instead of reporting the paths, print the directories that contains the files.
(http://docs.generic-mapping-tools.org/latest/gmtwhich.html#d)

• G | download :: [Type => Str | []] $Arg = [c|l|u]$

If a file argument is a downloadable file (either a full URL, a @file for downloading from
the GMT Site Cache, or @earth_relief_*.grd) we will try to download the file if it is not
found in your local data or cache dirs.
(http://docs.generic-mapping-tools.org/latest/gmtwhich.html#g)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

gmtwrite(fname::AbstractString, data; kwargs...)

Write a GMT object to file. The object is one of "grid" or "grd", "image" or "img", "dataset" or "table", "cmap" or "cpt" and "ps" (for postscript).

When saving grids we have a panoply of formats at our disposal.

Parameters

• id :: [Type => Str]

  Use an $id$ code when not not saving a grid into a standard COARDS-compliant netCDF grid. This $id$ is made up of two characters like $ef$ to save in ESRI Arc/Info ASCII Grid Interchange format (ASCII float). See the full list of ids at http://docs.generic-mapping-tools.org/latest/grdconvert.html#format-identifier.

  (http://docs.generic-mapping-tools.org/latest/grdconvert.html#g)

• scale | offset :: [Type => Number]

  You may optionally ask to scale the data and then offset them with the specified amounts. These modifiers are particularly practical when storing the data as integers, by first removing an offset and then scaling down the values.

• nan | novalue | invalid | missing :: [Type => Number]

  Lets you supply a value that represents an invalid grid entry, i.e., ‘Not-a-Number’.

• gdal :: [Type => Bool]

  Force the use of the GDAL library to write the grid (to be used only with grids). (http://docs.generic-mapping-tools.org/latest/GMT_Docs.html#grid-file-format-specifications)

• driver :: [Type => Str]

  When saving in other than the netCDF format we must tell the GDAL library what is wished format. That is done by specifying the driver name used by GDAL itself (e.g., netCDF, GTiFF, etc...).

• datatype :: [Type => Str] $Arg = u8|u16|i16|u32|i32|float32$

  When saving with GDAL we can specify the data type from u8|u16|i16|u32|i32|float32 where ‘i’ and ‘u’ denote signed and unsigned integers respectively.

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

Example: write the GMTgrid 'G' object into a nc file called 'lixo.grd'

gmtwrite("lixo.grd", G);

gravfft(cmd0::String="", arg1=nothing, arg2=nothing; kwargs...)

Spectral calculations of gravity, isostasy, admittance, and coherence for grids.

Full option list at gravfft

Parameters

• D | density :: [Type => Str | GMTgrid]

  Sets body density in SI. Provide either a constant density or a grid with a variable one. (http://docs.generic-mapping-tools.org/latest/gravfft.html#c)

• E | n_terms :: [Type => Number]

  Number of terms used in Parker expansion [Default = 3]. (http://docs.generic-mapping-tools.org/latest/gravfft.html#e)

• F | geopotential :: [Type => Str | Tuple]

  Specify desired geopotential field: compute geoid rather than gravity (http://docs.generic-mapping-tools.org/latest/gravfft.html#h)

• I | admittance :: [Type => Number]

  Use ingrid2 and ingrid1 (a grid with topography/bathymetry) to estimate admittance|coherence and return a GMTdataset. (http://docs.generic-mapping-tools.org/latest/gravfft.html#l)

• N | inquire :: [Type => Str] $Arg = [a|f|m|r|s|nx/ny][+a|[+d|h|l][+e|n|m][+twidth][+v][+w[suffix]][+z[p]]$

  Choose or inquire about suitable grid dimensions for FFT and set optional parameters. Control the FFT dimension: (http://docs.generic-mapping-tools.org/latest/gravfft.html#n)

• Q | flex_topo | flexural_topography :: [Type => Bool]

  Computes grid with the flexural topography. (http://docs.generic-mapping-tools.org/latest/gravfft.html#q)

• S | subplate | subplate_load :: [Type => Bool]

  Computes predicted gravity or geoid grid due to a subplate load produced by the current bathymetry and the theoretical model. (http://docs.generic-mapping-tools.org/latest/gravfft.html#s)

• T | topo_load :: [Type => Str]

  Compute the isostatic compensation from the topography load (input grid file) on an elastic plate of thickness te. (http://docs.generic-mapping-tools.org/latest/gravfft.html#t)

• W | z_obs | observation_level :: [Type => Number]

  Set water depth (or observation height) relative to topography in meters [0]. Append k to indicate km. (http://docs.generic-mapping-tools.org/latest/gravfft.html#w)

• Z | moho_depth :: [Type => Number]

  Moho [and swell] average compensation depths (in meters positive down). (http://docs.generic-mapping-tools.org/latest/gravfft.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

Example. Compute the gravity effect of the Gorringe bank.

    G = grdcut("@earth_relief_10m", region=(-12.5,-10,35.5,37.5));
	G2 = gravfft(G, density=1700, F=(faa=6,slab=4), f=:g);
	imshow(G2)

grd2cpt(cmd0::String="", arg1=nothing, kwargs...)

Make linear or histogram-equalized color palette table from grid

Full option list at grd2cpt

Parameters

• A | alpha | transparency :: [Type => Str]

  Sets a constant level of transparency (0-100) for all color slices. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#a)

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• D | bg | background :: [Type => Str | []] Arg = [i|o]

  Select the back- and foreground colors to match the colors for lowest and highest z-values in the output CPT. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#d)

• E | nlevels :: [Type => Int | []] Arg = [nlevels]

  Create a linear color table by using the grid z-range as the new limits in the CPT. Alternatively, append nlevels and we will resample the color table into nlevels equidistant slices. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#e)

• F | color_model :: [Type => Str | []] Arg = [R|r|h|c][+c]]

  Force output CPT to written with r/g/b codes, gray-scale values or color name. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#f)

• G | truncate :: [Type => Str] Arg = zlo/zhi

  Truncate the incoming CPT so that the lowest and highest z-levels are to zlo and zhi. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#g)

• I | inverse | reverse :: [Type => Str] Arg = [c][z]

  Reverse the sense of color progression in the master CPT. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#i)

• L | range :: [Type => Str] Arg = minlimit/maxlimit

  Limit range of CPT to minlimit/maxlimit, and don’t count data outside this range when estimating CDF(Z). Default uses min and max of data.

• M | overrule_bg :: [Type => Bool]

  Overrule background, foreground, and NaN colors specified in the master CPT with the values of the parameters COLORBACKGROUND, COLORFOREGROUND, and COLOR_NAN. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#m)

• N | no_bg | nobg :: [Type => Bool]

  Do not write out the background, foreground, and NaN-color fields. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#n)

• Q | log :: [Type => Bool]

  Selects a logarithmic interpolation scheme [Default is linear]. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | symetric :: [Type => Str] Arg = h|l|m|u

  Force the color table to be symmetric about zero (from -R to +R). (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#s)

• T | range :: [Type => Str] Arg = (min,max,inc) or = "n"

  Set steps in CPT. Calculate entries in CPT from zstart to zstop in steps of (zinc). Default chooses arbitrary values by a crazy scheme based on equidistant values for a Gaussian CDF. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | wrap | categorical :: [Type => Bool | Str | []] Arg = [w]

  Do not interpolate the input color table but pick the output colors starting at the beginning of the color table, until colors for all intervals are assigned. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#w)

• Z | continuous :: [Type => Bool]

  Creates a continuous CPT [Default is discontinuous, i.e., constant colors for each interval]. (http://docs.generic-mapping-tools.org/latest/grd2cpt.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

grd2kml(cmd0::String="", arg1=nothing, kwargs...)

Reads a 2-D grid file and makes a quadtree of PNG images and KML wrappers for Google Earth using the selected tile size [256x256 pixels].

Full option list at grd2kml

Parameters

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• E | url :: [Type => Str] Arg = url

  Instead of hosting the files locally, prepend a site URL. The top-level prefix.kml file will then use this URL to find the other files it references.`` (http://docs.generic-mapping-tools.org/latest/grd2kml.html#e)

• F | filter :: [Type => Str]

  Specifies the filter to use for the downsampling of the grid for more distant viewing. Choose among boxcar, cosine arch, gaussian, or median [Gaussian]. (http://docs.generic-mapping-tools.org/latest/grd2kml.html#e)

• H | sub_pixel :: [Type => Int] Arg = factor

  Improve the quality of rasterization by passing the sub-pixel smoothing factor to psconvert. (http://docs.generic-mapping-tools.org/latest/grd2kml.html#h)

• I | shade | shading | intensity :: [Type => Str | GMTgrid]

  Gives the name of a grid file or GMTgrid with intensities in the (-1,+1) range, or a grdgradient shading flags. (http://docs.generic-mapping-tools.org/latest/grd2kml.html#i)

• L | tile_size :: [Type => Number] Arg = tilesize

  Sets the fixed size of the image building blocks. Must be an integer that is radix 2. Typical values are 256 or 512 [256]. (http://docs.generic-mapping-tools.org/latest/grd2kml.html#l)

• N | prefix [Type => Str] Arg = prefix

  Sets a unique name prefixed used for the top-level KML filename and the directory where all referenced KML files and PNG images will be written [GMT_Quadtree]. (http://docs.generic-mapping-tools.org/latest/grd2kml.html#n)

• Q | nan_t | nan_alpha :: [Type => Bool]

  Make grid nodes with z = NaN transparent, using the color-masking feature in PostScript Level 3. (http://docs.generic-mapping-tools.org/latest/grd2kml.html#q)

• T | title :: [Type => Str] Arg = title

  Sets the title of the top-level document (i.e., its description). (http://docs.generic-mapping-tools.org/latest/grd2kml.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grd2xyz(cmd0::String="", arg1=nothing, kwargs...)

Reads one 2-D grid and returns xyz-triplets.

Full option list at grd2xyz

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• C | row_col :: [Type => Bool]

  Replace the x- and y-coordinates on output with the corresponding column and row numbers. (http://docs.generic-mapping-tools.org/latest/grd2xyz.html#c)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | weight :: [Type => Str] Arg = [a|weight]

  Write out x,y,z,w, where w is the supplied weight (or 1 if not supplied) [Default writes x,y,z only]. (http://docs.generic-mapping-tools.org/latest/grd2xyz.html#w)

• Z | flags :: [Type => Str]

  Write a 1-column table. Output will be organized according to the specified ordering convention contained in $flags$. (http://docs.generic-mapping-tools.org/latest/grd2xyz.html#z)

• write | |> :: [Type => Str] $Arg = fname$

  Save result to ASCII file instead of returning to a Julia variable. Give file name as argument. Use the bo option to save as a binary file.

• append :: [Type => Str] $Arg = fname$

  Append result to an existing file named $fname$ instead of returning to a Julia variable. Use the bo option to save as a binary file.

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• s | skiprows | skip_NaN :: [Type => Str] $Arg = [cols][a|r]$

  Suppress output for records whose z-value equals NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#s-full)

grdblend(cmd0::String="", arg1=nothing, arg2=nothing, kwargs...)

Reads a listing of grid files and blend parameters, or up to 2 GTMgrid types, and creates a grid by blending the other grids using cosine-taper weights.

Full option list at grdblend

Parameters

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/grdblend.html#i)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdblend(....) form. (http://docs.generic-mapping-tools.org/latest/grdblend.html#g)

• C | clobber :: [Type => Str | []] $Arg = f|l|o|u[±]$

  Clobber mode: Instead of blending, simply pick the value of one of the grids that covers a node. (http://docs.generic-mapping-tools.org/latest/grdproject.html#c)

• N | nodata :: [Type => Str | Number]

  No data. Set nodes with no input grid to this value [Default is NaN]. (http://docs.generic-mapping-tools.org/latest/grdblend.html#n)

• Q | headless :: [Type => Bool]

  Create plain header-less grid file (for use with external tools). Requires that the output grid file is a native format (i.e., not netCDF). DO NOT USE WITH G. (http://docs.generic-mapping-tools.org/latest/grdblend.html#q)

• W | no_blend :: [Type => Str | []]

  Do not blend, just output the weights used for each node [Default makes the blend]. Append $z$ to write the weight*z sum instead. (http://docs.generic-mapping-tools.org/latest/grdblend.html#w)

• Z | scale :: [Type => Number]

  Scale output values by scale before writing to file. (http://docs.generic-mapping-tools.org/latest/grdblend.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

grdclip(cmd0::String="", arg1=nothing, kwargs...)

Clip the range of grid values. will set values < low to below and/or values > high to above. You can also specify one or more intervals where all values should be set to $between$, or replace individual values.

Full option list at grdclip

Parameters

• cmd0 :: [Type => Str]

  The input file name. Do not use this when the grid (a GMTgrid type) is passed via the $arg1$ argument.

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdclip(....) form. (http://docs.generic-mapping-tools.org/latest/grdclip.html#g)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• above | high :: [Type => Array | Str]

  Two elements array with $high$ and $above$ or a string with "high/above". It sets all data[i] > $high$ to $above$.

• below | low :: [Type => Array | Str]

  Two elements array with $low$ and $below$ or a string with "low/below". It sets all data[i] < $low$ to $below$.

• between :: [Type => Array | Str]

  Three elements array with $low, high$ and $between$ or a string with "low/high/between". It sets all data[i] >= $low$ and <= $high$ to $between$.

• old | new :: [Type => Array | Str]

  Two elements array with $old$ and $new$ or a string with "old/new". It sets all data[i] == $old$ to $new$.

• S :: [Type => Str]

  Condense all replacement options above in a single string. (http://docs.generic-mapping-tools.org/latest/grdclip.html#s)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• Examples:

    G=gmt("grdmath", "-R0/10/0/10 -I1 X");
    G2=grdclip(G, above=[5 6], low=[2 2], between="3/4/3.5")

  or (note the use of -S for second on options because we can't repeat a kwarg name)

    G2=grdclip(G, S="a5/6 -Sb2/2 -Si3/4/3.5")

grdcontour(cmd0::String="", arg1=nothing; kwargs...)

Reads a 2-D grid file or a GMTgrid type and produces a contour map by tracing each contour through the grid.

Full option list at grdcontour

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• A | annot :: [Type => Str or Number] $Arg = [-|[+]annot_int][labelinfo]$

  annot_int is annotation interval in data units; it is ignored if contour levels are given in a file. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | cont | contour | contours | levels :: [Type => Str | Number | GMTcpt] $Arg = [+]cont_int$

  Contours to be drawn may be specified in one of three possible ways. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#c)

• D | dump :: [Type => Str]

  Dump contours as data line segments; no plotting takes place. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#d)

• F | force :: [Type => Str | []]

  Force dumped contours to be oriented so that higher z-values are to the left (-Fl [Default]) or right. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#f)

• G | labels :: [Type => Str]

  Controls the placement of labels along the quoted lines. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#g)

• Jz | zscale | zsize :: [Type => String]

• L | range :: [Type => Str]

  Limit range: Do not draw contours for data values below low or above high. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#l)

• N | fill | colorize :: [Type => Bool]

  Fill the area between contours using the discrete color table given by cpt. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Q | cut :: [Type => Str | Number]

  Do not draw contours with less than cut number of points. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#q)

• S | smooth :: [Type => Number]

  Used to resample the contour lines at roughly every (gridbox_size/smoothfactor) interval. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#s)

• T | ticks :: [Type => Str]

  Draw tick marks pointing in the downward direction every gap along the innermost closed contours. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#t)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | pen :: [Type => Str | Number]

  Sets the attributes for the particular line. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#w)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• Z | scale :: [Type => Str]

  Use to subtract shift from the data and multiply the results by factor before contouring starts. (http://docs.generic-mapping-tools.org/latest/grdcontour.html#z)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• do | nodata_out :: [Type => Str or Number] $Arg = nodata$

  Examine all output columns and if any item equals NAN substitute it with the chosen missing data value. (http://docs.generic-mapping-tools.org/latest/gmt.html#do-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

grdcut(cmd0::String="", arg1=[], kwargs...)

Produce a new outgrid which is a subregion of ingrid. The subregion is specified with $limits$ (the -R); the specified range must not exceed the range of ingrid (but see $extend$).

Full option list at grdcut

Parameters

• F | clip | cutline :: [Type => Str | GMTdaset | Mx2 array | NamedTuple] Arg = array|fname[+c] | (polygon=Array|Str, crop2cutline=Bool, invert=Bool)

  Specify a closed polygon (either a file or a dataset). All grid nodes outside the polygon will be set to NaN (>= GMT6.2). (http://docs.generic-mapping-tools.org/latest/grdcut.html#f)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdcut(....) form. (http://docs.generic-mapping-tools.org/latest/grdcut.html#g)

• img | usegdal | gdal :: [Type => Any]

  Force the cut operation to be done by GDAL. Works for images where GMT fails or even crash.

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• N | extend :: [Type => Str or []]

  Allow grid to be extended if new region exceeds existing boundaries. Append nodata value to initialize nodes outside current region [Default is NaN]. (http://docs.generic-mapping-tools.org/latest/grdcut.html#n)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | circ_subregion :: [Type => Str] $Arg = [n]lon/lat/radius[unit]$

  Specify an origin and radius; append a distance unit and we determine the corresponding rectangular region so that all grid nodes on or inside the circle are contained in the subset. (http://docs.generic-mapping-tools.org/latest/grdcut.html#s)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• Z | z_subregion :: [Type => Str] $Arg = [n|N |r][min/max]$

  Determine a new rectangular region so that all nodes outside this region are also outside the given z-range. (http://docs.generic-mapping-tools.org/latest/grdcut.html#z)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdedit(cmd0::String="", arg1=nothing, kwargs...)

Reads the header information in a binary 2-D grid file and replaces the information with values provided on the command line.

If single input is a G GMTgrid object, it will update the z_min|max values of the G.range member

Full option list at grdedit

Parameters

• A | adjust :: [Type => Bool]

  If necessary, adjust the file’s xinc, yinc to be compatible with its domain. (http://docs.generic-mapping-tools.org/latest/grdedit.html#a)

• C | adjust :: [Type => Bool]

  Clear the command history from the grid header. (http://docs.generic-mapping-tools.org/latest/grdedit.html#c)

• D | header :: [Type => Str] $Arg = [+xxname][+yyname][+zzname][+sscale][+ooffset][+ninvalid][+ttitle][+rremark$

  Change these header parameters. (http://docs.generic-mapping-tools.org/latest/grdedit.html#d)

• E | header :: [Type => Str] $Arg = [a|h|l|r|t|v]$

  Transform the grid in one of six ways and (for l|r|t) interchange the x and y information (http://docs.generic-mapping-tools.org/latest/grdedit.html#e)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdedit(....) form. (http://docs.generic-mapping-tools.org/latest/grdedit.html#g)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• N | replace :: [Type => Str | Mx3 array] $Arg = replace=fname | replace=Array$

  Read the ASCII (or binary) file table and replace the corresponding nodal values in the grid with these x,y,z values. Alternatively, provide a Mx3 matrix with values to be changed. (http://docs.generic-mapping-tools.org/latest/grdedit.html#n)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | wrap :: [Type => Bool]

  For global, geographical grids only. Grid values will be shifted longitudinally according to the new borders given in $limits$ (R option). (http://docs.generic-mapping-tools.org/latest/grdedit.html#s)

• T | toggle :: [Type => Bool]

  Make necessary changes in the header to convert a gridline-registered grid to a pixel-registered grid, or vice-versa. (http://docs.generic-mapping-tools.org/latest/grdedit.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

grdfft(cmd0::String="", arg1=nothing, [arg2=nothing,] kwargs...)

Take the 2-D forward Fast Fourier Transform and perform one or more mathematical operations in the frequency domain before transforming back to the space domain.

Full option list at grdfft

Parameters

• A | azim :: [Type => Number] $Arg = azim$

  Take the directional derivative in the azimuth direction measured in degrees CW from north. (http://docs.generic-mapping-tools.org/latest/grdfft.html#a)

• C | upward :: [Type => Number] $Arg = zlevel$

  Upward (for zlevel > 0) or downward (for zlevel < 0) continue the field zlevel meters. (http://docs.generic-mapping-tools.org/latest/grdfft.html#c)

• D | dfdz :: [Type => Str or Number] $Arg = [scale|g]$

  Differentiate the field, i.e., take d(field)/dz. This is equivalent to multiplying by kr in the frequency domain (kr is radial wave number). (http://docs.generic-mapping-tools.org/latest/grdfft.html#d)

• E | radial_power :: [Type => Str] $Arg = [r|x|y][+w[k]][+n]$

  Estimate power spectrum in the radial direction [r]. Place x or y immediately after E to compute the spectrum in the x or y direction instead. (http://docs.generic-mapping-tools.org/latest/grdfft.html#e)

• F | filter :: [Type => Str or List– $Arg = [r|x|y]params$

  Filter the data. Place x or y immediately after -F to filter x or y direction only; default is isotropic [r]. Choose between a cosine-tapered band-pass, a Gaussian band-pass filter, or a Butterworth band-pass filter. (http://docs.generic-mapping-tools.org/latest/grdfft.html#f)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name (or table if radial_power is used). Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdfft(....) form. (http://docs.generic-mapping-tools.org/latest/grdfft.html#g)

• I | integrate :: [Type => Str or Number] $Arg = [scale|g]$

  Integrate the field, i.e., compute integraloverz (field * dz). This is equivalent to divide by kr in the frequency domain (kr is radial wave number). (http://docs.generic-mapping-tools.org/latest/grdfft.html#i)

• N | inquire :: [Type => Str] $Arg = [a|f|m|r|s|nx/ny][+a|[+d|h|l][+e|n|m][+twidth][+v][+w[suffix]][+z[p]]$

  Choose or inquire about suitable grid dimensions for FFT and set optional parameters. Control the FFT dimension: (http://docs.generic-mapping-tools.org/latest/grdfft.html#n)

• S | scale :: [Type => Number] $Arg = scale$

  Multiply each element by scale in the space domain (after the frequency domain operations). (http://docs.generic-mapping-tools.org/latest/grdfft.html#s)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdfill(cmd0::String="", arg1=nothing, kwargs...)

Reads a grid that presumably has unfilled holes that the user wants to fill in some fashion. Holes are identified by NaN values but this criteria can be changed.

Full option list at grdfill

Parameters

• A | algo :: [Type => Str] $Arg = mode[arg]$

  Specify the hole-filling algorithm to use. Choose from c for constant fill and append the constant value, n for nearest neighbor (and optionally append a search radius in pixels). (http://docs.generic-mapping-tools.org/latest/grdfill.html#a)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdfill(....) form. (http://docs.generic-mapping-tools.org/latest/grdfill.html#g)

• L | list :: [Type => Str] $Arg = [p]$

  Just list the rectangular subregions west east south north of each hole. No grid fill takes place and outgrid is ignored. Optionally, append p to instead write closed polygons for all subregions.

• N | nodata :: [Type => Str] $Arg = nodata$

  Sets the node value that identifies a point as a member of a hole [Default is NaN]. (http://docs.generic-mapping-tools.org/latest/grdfill.html#n)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdfilter(cmd0::String="", arg1=nothing, kwargs...)

Filter a grid file in the time domain using one of the selected convolution or non-convolution isotropic or rectangular filters and compute distances using Cartesian or Spherical geometries.

Full option list at grdfilter

Parameters

• F | filter :: [Type => Str]

  Sets the filter type. (http://docs.generic-mapping-tools.org/latest/grdfilter.html#f)

• D | distflag | distance :: [Type => Number]

  Distance flag tells how grid (x,y) relates to filter width. (http://docs.generic-mapping-tools.org/latest/grdfilter.html#d)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdfilter(....) form. (http://docs.generic-mapping-tools.org/latest/grdfilter.html#g)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/grdfilter.html#i)

• N | nans :: [Type => Str]

  Determine how NaN-values in the input grid affects the filtered output. Values are i|p|r (http://docs.generic-mapping-tools.org/latest/grdfilter.html#n)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• T | toggle :: [Type => Bool]

  Toggle the node registration for the output grid so as to become the opposite of the input grid (http://docs.generic-mapping-tools.org/latest/grdfilter.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdgradient(cmd0::String="", arg1=nothing, kwargs...)

Compute the directional derivative in a given direction, or to find the direction [and the magnitude] of the vector gradient of the data.

Full option list at grdgradient

Parameters

• A | azim :: [Type => Str | Number] $Arg = azim[/azim2]$

  Azimuthal direction for a directional derivative. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#a)

• D | find_dir :: [Type => Str] $Arg = [a][c][o][n]$

  Find the direction of the positive (up-slope) gradient of the data. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#d)

• G | save | write | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdgradient(....) form. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#g)

• E | lambert :: [Type => Str] $Arg = [m|s|p]azim/elev[+aambient][+ddiffuse][+pspecular][+sshine]$

  Compute Lambertian radiance appropriate to use with grdimage and grdview. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#e)

• N | norm | normalize :: [Type => Str] $Arg = [e|t][amp][+ssigma][+ooffset]$

  Normalization. [Default is no normalization.] The actual gradients g are offset and scaled to produce normalized gradients. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#n)

• Q | save_stats :: [Type => Str] $Arg = c|r|R$

  Controls how normalization via N is carried out. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | slopegrid :: [Type => Str]

  Name of output grid file with scalar magnitudes of gradient vectors. Requires D but makes G optional. (http://docs.generic-mapping-tools.org/latest/grdgradient.html#s)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdgravmag3d(cmd0::String="", arg1=nothing, arg2=nothing; kwargs...)

Compute the gravity/magnetic anomaly of the volume contained between a surface provided by one grid and a plane, or between a top and a bottom surface provided by two grids.

Full option list at grdgravmag3d

Parameters

• C | density :: [Type => Str | GMTgrid]

  Sets body density in SI. Provide either a constant density or a grid with a variable one. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#c)

• F | track :: [Type => Str | Matrix | GMTdataset]

  Provide locations where the anomaly will be computed. Note this option is mutually exclusive with outgrid. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#f)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdgravmag3d(....) form. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#g)

• E | thickness :: [Type => Number]

  Provide the layer thickness in m [Default = 500 m]. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#e)

• H | mag_params :: [Type => Number]

  Sets parameters for computation of magnetic anomaly. Alternatively, provide a magnetic intensity grid. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#h)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#i)

• L | z_obs | observation_level :: [Type => Number]

  Sets level of observation [Default = 0]. That is the height (z) at which anomalies are computed. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#l)

• Q | pad :: [Type => Number]

  Extend the domain of computation with respect to output region. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | radius :: [Type => Number]

  Set search radius in km (valid only in the two grids mode OR when thickness) [Default = 30 km]. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#s)

• Z | z_level | reference_level :: [Type => Number]

  Level of reference plane [Default = 0]. (http://docs.generic-mapping-tools.org/latest/grdgravmag3d.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• x | cores | n_threads :: [Type => Str or Number] $Arg = [[-]n]$

  Limit the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. (http://docs.generic-mapping-tools.org/latest/gmt.html#x-full)

Example. Compute the gravity effect of the Gorringe bank.

	G = grdgravmag3d("@earth_relief_10m", region=(-12.5,-10,35.5,37.5), density=2700, inc=0.05, pad=0.5, z_level=:bottom, f=:g);
	imshow(G)

grdhisteq(cmd0::String="", arg1=nothing, kwargs...)

Find the data values which divide a given grid file into patches of equal area. One common use of grdhisteq is in a kind of histogram equalization of an image.

Full option list at grdhisteq

Parameters

• D | dump :: [Type => Str or []]

  Dump level information to file, or standard output if no file is provided. (http://docs.generic-mapping-tools.org/latest/grdhisteq.html#d)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdhisteq(....) form. (http://docs.generic-mapping-tools.org/latest/grdhisteq.html#g)

• N | gaussian :: [Type => Number or []]

  Gaussian output. (http://docs.generic-mapping-tools.org/latest/grdhisteq.html#n)

• Q | quadratic :: [Type => Bool]

  Quadratic output. Selects quadratic histogram equalization. [Default is linear]. (http://docs.generic-mapping-tools.org/latest/grdhisteq.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

grdimage(cmd0::String="", arg1=nothing, arg2=nothing, arg3=nothing; kwargs...)

Produces a gray-shaded (or colored) map by plotting rectangles centered on each grid node and assigning them a gray-shade (or color) based on the z-value.

Full option list at grdimage

Parameters

• A | img_out | image_out :: [Type => Str]

  Save an image in a raster format instead of PostScript. (http://docs.generic-mapping-tools.org/latest/grdimage.html#a)

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• D | img_in | image_in :: [Type => Str]

  Specifies that the grid supplied is an image file to be read via GDAL. (http://docs.generic-mapping-tools.org/latest/grdimage.html#d)

• E | dpi :: [Type => Int]

  Sets the resolution of the projected grid that will be created. (http://docs.generic-mapping-tools.org/latest/grdimage.html#e)

• G | bit_color :: [Type => Int]

  (http://docs.generic-mapping-tools.org/latest/grdimage.html#g)

• I | shade | shading | intensity :: [Type => Bool | Str | GMTgrid]

  Gives the name of a grid file or GMTgrid with intensities in the (-1,+1) range, or a grdgradient shading flags. (http://docs.generic-mapping-tools.org/latest/grdimage.html#i)

• M | monochrome :: [Type => Bool]

  Force conversion to monochrome image using the (television) YIQ transformation. (http://docs.generic-mapping-tools.org/latest/grdimage.html#m)

• N | noclip :: [Type => Bool]

  Do not clip the image at the map boundary. (http://docs.generic-mapping-tools.org/latest/grdimage.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Q | alpha_color | nan_alpha :: [Type => Bool | Tuple | Str] $Q = true | Q = (r,g,b)$

Make grid nodes with z = NaN transparent, or pick a color for transparency in a image.

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

grdinfo(cmd0::String="", arg1=nothing; kwargs...)

Reads a 2-D grid file and reports metadata and various statistics for the (x,y,z) data in the grid file

Full option list at grdinfo

Parameters

• C | numeric :: [Type => Str | Number]

  Formats the report using tab-separated fields on a single line. (http://docs.generic-mapping-tools.org/latest/grdinfo.html#c)

• D | tiles :: [Type => Number | Str]

  Divide a single grid’s domain (or the -R domain, if no grid given) into tiles of size dx times dy (set via -I). (http://docs.generic-mapping-tools.org/latest/grdinfo.html#d)

• F :: [Type => Bool]

  Report grid domain and x/y-increments in world mapping format. (http://docs.generic-mapping-tools.org/latest/grdinfo.html#f)

• G | force_download :: [Type => Bool]

  Force (possible) download and mosaicing of all tiles of tiled global remote grids in order to report the requested information. (http://docs.generic-mapping-tools.org/latest/grdinfo.html#g)

• I | nearest :: [Type => Number | Str] $Arg = [dx[/dy]|b|i|r]$

  Report the min/max of the region to the nearest multiple of dx and dy, and output this in the form -Rw/e/s/n (http://docs.generic-mapping-tools.org/latest/grdinfo.html#i)

• L | force_scan :: [Type => Number | Str]

  Report stats after actually scanning the data. (http://docs.generic-mapping-tools.org/latest/grdinfo.html#l)

• M | minmax_pos :: [Type => Bool]

  Find and report the location of min/max z-values. (http://docs.generic-mapping-tools.org/latest/grdinfo.html#m)

• Q | cube :: [Type => Bool]

  Input files must be data 3-D netCDF data cube. Not compatible with D, E, F, and Ib (GMT6.2) (http://docs.generic-mapping-tools.org/latest/grdinfo.html#q)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• T | zmin_max :: [Type => Number | Str] Determine min and max z-value. (http://docs.generic-mapping-tools.org/latest/grdinfo.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdinterpolate(cmd0="", arg1=nothing, arg2=nothing; kwargs...)

Interpolate a 3-D cube, 2-D grids or 1-D series from a 3-D data cube or stack of 2-D grids.

Full option list at grdinterpolate

Parameters

• D | meta | metadata :: [Type => Str | NamedTuple]

  Give one or more combinations for values xname, yname, zname (3rd dimension in cube), and dname (data value name) and give the names of those variables and in square bracket their units (http://docs.generic-mapping-tools.org/latest/grdinterpolate.html#d)

• E | crossection :: [Type => Str | GMTdtaset | NamedTuple]

  Specify a crossectinonal profile via a file or from specified line coordinates and modifiers. If a file, it must be contain a single segment with either lon lat or lon lat dist records. These must be equidistant. (http://docs.generic-mapping-tools.org/latest/grdinterpolate.html#e)

• F | interp_type :: [Type => Str] $Arg = l|a|c|n[+1|+2]$

  Choose from l (Linear), a (Akima spline), c (natural cubic spline), and n (no interpolation: nearest point) [Default is Akima].

• G | outfile | outgrid :: [Type => Str]

  Output file name. If range only selects a single layer then the data cube collapses to a regular 2-D grid file (http://docs.generic-mapping-tools.org/latest/grdinterpolate.html#g)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | pt | track :: [Type => Str | Tuple | Dataset] Arg = x/y|pointfile[+hheader]

  Rather than compute gridded output, create tile/spatial series through the stacked grids at the given point (x/y) or the list of points in pointfile. (http://docs.generic-mapping-tools.org/latest/grdinterpolate.html#s)

• T | range :: [Type => Str] Arg = [min/max/]inc[+i|n] |-Tfile|list

  Make evenly spaced time-steps from min to max by inc [Default uses input times]. (http://docs.generic-mapping-tools.org/latest/grdinterpolate.html#t)

• Z | levels :: [Type => range] Arg = [levels]

  The levels may be specified the same way as in range. If not given then we default to an integer levels array starting at 0. (http://docs.generic-mapping-tools.org/latest/grdinterpolate.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• q | inrow | inrows :: [Type => Str] $Arg = [i|o][~]rows[+ccol][+a|f|s]$

  Select specific data rows to be read (-qi [Default]) or written (-qo) [all]. (http://docs.generic-mapping-tools.org/latest/gmt.html#q-full)

• s | skiprows | skip_NaN :: [Type => Str] $Arg = [cols][a|r]$

  Suppress output for records whose z-value equals NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#s-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

When using two numeric inputs and no G option, the order of the x,y and grid is not important. That is, both of this will work: D = grdinterpolate([0 0], G); or D = grdinterpolate(G, [0 0]);

When using the pt or crossection options the default is to NOT ouput the redundant horizontal x,y coordinates (contrary to the GMT default). If you want to have them, use option colinfo, e.g. colinfo="0-3"

grdlandmask([monolithic::String="";] area=, resolution=, bordervalues=, save=, maskvalues=, registration=, verbose=, cores=)

Create a grid file with set values for land and water.

Read the selected shoreline database and create a grid to specify which nodes in the specified grid are over land or over water. The nodes defined by the selected region and lattice spacing will be set according to one of two criteria: (1) land vs water, or (2) the more detailed (hierarchical) ocean vs land vs lake vs island vs pond.

Full option list at grdlandmask

Parameters

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/grdlandmask.html#i)

• A | area :: [Type => Str | Number]

  Features with an area smaller than minarea in km^2 or of hierarchical level that is lower than minlevel or higher than max_level will not be plotted. (http://docs.generic-mapping-tools.org/latest/grdlandmask.html#a)

• D | res | resolution :: [Type => Str]

  Selects the resolution of the data set to use ((f)ull, (h)igh, (i)ntermediate, (l)ow, and (c)rude). (http://docs.generic-mapping-tools.org/latest/grdlandmask.html#d)

• E | bordervalues :: [Type => Str | List] $Arg = cborder/lborder/iborder/pborder or bordervalue$

  Nodes that fall exactly on a polygon boundary should be considered to be outside the polygon [Default considers them to be inside]. (http://docs.generic-mapping-tools.org/latest/grdlandmask.html#e)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdlandmask(....) form. (http://docs.generic-mapping-tools.org/latest/grdlandmask.html#g)

• N | maskvalues | mask :: [Type => Str | List] $Arg = wet/dry or ocean/land/lake/island/pond$

  Sets the values that will be assigned to nodes. Values can be any number, including the textstring NaN (http://docs.generic-mapping-tools.org/latest/grdlandmask.html#n)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

• x | cores | n_threads :: [Type => Str or Number] $Arg = [[-]n]$

  Limit the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. (http://docs.generic-mapping-tools.org/latest/gmt.html#x-full)

grdmask(cmd0::String="", arg1=nothing, kwargs...)

1. It reads one or more pathfiles that each define a closed polygon.
2. The pathfiles simply represent data point locations and the mask is set to the inside or outside value depending on whether a node is within a maximum distance from the nearest data point.

Full option list at grdmask

Parameters

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/grdmask.html#i)

• A | steps | straight_lines :: [Type => Str | Number] $Arg = m|p|x|y$

  If the input data are geographic then the sides in the polygons will be approximated by great circle arcs. When using this option sides will be regarded as straight lines. (http://docs.generic-mapping-tools.org/latest/grdmask.html#a)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdmask(....) form. (http://docs.generic-mapping-tools.org/latest/grdmask.html#g)

• N | outedgein :: [Type => Str | List] $Arg = [z|Z|p|P]values$

  Sets the out/edge/in that will be assigned to nodes that are outside the polygons, on the edge, or inside. Values can be any number, including the textstring NaN [Default is 0/0/1]. (http://docs.generic-mapping-tools.org/latest/grdmask.html#n)

• S | search_radius :: [Type => Str | List] $Arg = search_radius[unit] |xlim/ylim$

  Set nodes to inside, on edge, or outside depending on their distance to the nearest data point.

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• j | spherical_dist | spherical :: [Type => Str] $Arg = e|f|g$

  Determine how spherical distances are calculated in modules that support this. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

• x | cores | n_threads :: [Type => Str or Number] $Arg = [[-]n]$

  Limit the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. (http://docs.generic-mapping-tools.org/latest/gmt.html#x-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

grdmath(cmd::String, args...)

Call grdmath with all commands in a single string 'cmd'. This is not useful in itself as compared to call gmt("grdmath ....") but it's very useful in 'movie' because it can generate shell scripts from the julai command

Full option list at grdmath

grdpaste(cmd0::String="", arg1=nothing, arg2=nothing, kwargs...)

Combine grids $grid1$ and $grid2$ into $grid3$ by pasting them together along their common edge. Both grids must have the same dx, dy and have one edge in common.

Full option list at grdpaste

Parameters

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdpaste(....) form. (http://docs.generic-mapping-tools.org/latest/grdpaste.html#g)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdproject(cmd0::String="", arg1=nothing, kwargs...)

Project a geographical gridded data set onto a rectangular grid or do the inverse projection.

Full option list at grdproject

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• C | center :: [Type => Str | []] $Arg = [dx/dy]$

  Let projected coordinates be relative to projection center [Default is relative to lower left corner]. (http://docs.generic-mapping-tools.org/latest/grdproject.html#c)

• D | inc :: [Type => Str | number] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]$

  Set the grid spacing for the new grid. Append m for arc minute, s for arc second. (http://docs.generic-mapping-tools.org/latest/grdproject.html#d)

• E | dpi :: [Type => Number]

  Set the resolution for the new grid in dots per inch. (http://docs.generic-mapping-tools.org/latest/grdproject.html#e)

• F | one2one :: [Type => Str] $Arg = [c|i|p|e|f|k|M|n|u]$

  Force 1:1 scaling, i.e., output (or input, see -I) data are in actual projected meters [e]. (http://docs.generic-mapping-tools.org/latest/grdproject.html#f)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdproject(....) form. (http://docs.generic-mapping-tools.org/latest/grdproject.html#g)

• I | inverse :: [Type => Bool]

  Do the Inverse transformation, from rectangular to geographical. (http://docs.generic-mapping-tools.org/latest/grdproject.html#i)

• M | projected_unit :: [Type => Str] $Arg = c|i|p$

  Append c, i, or p to indicate that cm, inch, or point should be the projected measure unit. (http://docs.generic-mapping-tools.org/latest/grdproject.html#m)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

grdrotater(cmd0::String="", arg1=nothing; kwargs...)

Takes a geographical grid and reconstructs it given total reconstruction rotations.

Full option list at grdrotater

Parameters

• A | rot_region :: [Type => Str | Tuple | Vec]

  Specify directly the region of the rotated grid. (http://docs.generic-mapping-tools.org/latest/grdrotater.html#a)

• D | rot_outline :: [Type => Bool or Str] $Arg = true | filename$

  Name of the grid polygon outline file. This represents the outline of the grid reconstructed to the specified time. (http://docs.generic-mapping-tools.org/latest/grdrotater.html#d)

• F | rot_polyg | rot_polygon :: [Type => Str | GMTdaset | Mx2 array] $Arg = filename | dataset)$

  Specify a multisegment closed polygon file that describes the inside area of the grid that should be rotated. (http://docs.generic-mapping-tools.org/latest/grdrotater.html#f)

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdrotater(....) form. (http://docs.generic-mapping-tools.org/latest/grdrotater.html#g)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• T | ages :: [Type => Str | Tuple]

  Sets the desired reconstruction times. For a single time append the desired time. (http://docs.generic-mapping-tools.org/latest/grdrotater.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

Example

G = grdmath("-R-5/5/-5/5 -I0.1 -fg X Y HYPOT");
tri = [-2.411 -1.629; -0.124 2.601; 2.201 -1.629; -2.410 -1.629];
Gr, tri_rot = grdrotater(G, rotation="-40.8/32.8/-12.9", rot_outline=true, rot_polygon=tri);
imshow(Gr, plot=(data=tri_rot,))

grdsample(cmd0::String="", arg1=nothing, kwargs...)

Reads a grid file and interpolates it to create a new grid file with either: a different registration; or a new grid-spacing or number of nodes, and perhaps also a new sub-region

Full option list at grdsample

Parameters

• G | save | outgrid | outfile :: [Type => Str]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = grdsample(....) form. (http://docs.generic-mapping-tools.org/latest/grdsample.html#g)

• I | inc | increment | spacing :: [Type => Str] $Arg = xinc[unit][+e|n][/yinc[unit][+e|n]]]$

  x_inc [and optionally y_inc] is the grid spacing. Optionally, append an increment unit. (http://docs.generic-mapping-tools.org/latest/grdsample.html#i)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• T | toggle :: [Type => Bool]

  Toggle the node registration for the output grid so as to become the opposite of the input grid (http://docs.generic-mapping-tools.org/latest/grdsample.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

• x | cores | n_threads :: [Type => Str or Number] $Arg = [[-]n]$

  Limit the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. (http://docs.generic-mapping-tools.org/latest/gmt.html#x-full)

grdtrack(cmd0::String="", arg1=nothing, arg2=nothing; kwargs...)

Interpolates the grid(s) at the positions in the table and returns the table with the interpolated values added as (one or more) new columns.

Full option list at grdtrack

Parameters

• A | interp_path :: [Type => Str] Arg = f|p|m|r|R[+l]

  For track resampling (if crossprofile or profile are set) we can select how this is to be performed. (http://docs.generic-mapping-tools.org/latest/grdtrack.html#a)

• C | crossprofile :: [Type => Str] Arg = length/ds[/spacing][+a|+v][l|r]

  Use input line segments to create an equidistant and (optionally) equally-spaced set of crossing profiles along which we sample the grid(s) (http://docs.generic-mapping-tools.org/latest/grdtrack.html#c)

• D | dfile :: [Type => Str]

  In concert with crossprofile we can save the (possibly resampled) original lines to the file dfile (http://docs.generic-mapping-tools.org/latest/grdtrack.html#d)

• E | profile :: [Type => Str]

  Instead of reading input track coordinates, specify profiles via coordinates and modifiers. (http://docs.generic-mapping-tools.org/latest/grdtrack.html#e)

• F | critical :: [Type => Str]

  Find critical points along each cross-profile as a function of along-track distance. Requires crossprofile and a single input grid. (http://docs.generic-mapping-tools.org/latest/grdtrack.html#e)

• G | grid :: [Type => Str | GMTgrid | Tuple(GMTgrid's)]

  (http://docs.generic-mapping-tools.org/latest/grdtrack.html#g)

• N | no_skip :: [Type => Bool]

  (http://docs.generic-mapping-tools.org/latest/grdtrack.html#n)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | stack :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/grdtrack.html#s)

• T | radius :: [Type => Number, Str | []]

  (http://docs.generic-mapping-tools.org/latest/grdtrack.html#t)

• Z | z_only :: [Type => Bool]

  (http://docs.generic-mapping-tools.org/latest/grdtrack.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• bo | binary_out :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary output. (http://docs.generic-mapping-tools.org/latest/gmt.html#bo-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• g | gap :: [Type => Str] $Arg = [a]x|y|d|X|Y|D|[col]z[+|-]gap[u]$

  Examine the spacing between consecutive data points in order to impose breaks in the line. (http://docs.generic-mapping-tools.org/latest/gmt.html#g-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• s | skiprows | skip_NaN :: [Type => Str] $Arg = [cols][a|r]$

  Suppress output for records whose z-value equals NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#s-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

When using two numeric inputs and no G option, the order of the x,y and grid is not important. That is, both of this will work: D = grdtrack([0 0], G); or D = grdtrack(G, [0 0]);

grdtrend(cmd0::String="", arg1=nothing, arg2=nothing; kwargs...)

reads a 2-D grid file and fits a low-order polynomial trend to these data by [optionally weighted] least-squares.

Full option list at grdtrend

Parameters

• N | model :: [Type => Str | Number]

  Sets the number of model parameters to fit. (http://docs.generic-mapping-tools.org/latest/grdtrend.html#n)

• D | diff :: [Type => Str | []]

  Compute the difference (input data - trend). Optionaly provide a file name to save result on disk. (http://docs.generic-mapping-tools.org/latest/grdtrend.html#d)

• T | trend :: [Type => Str | []]

  Compute the trend surface. Optionaly provide a file name to save result on disk. (http://docs.generic-mapping-tools.org/latest/grdtrend.html#t)

• W | weights :: [Type => Str]

  If weight.nc exists, it will be read and used to solve a weighted least-squares problem. (http://docs.generic-mapping-tools.org/latest/grdtrend.html#w)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

grdvector(cmd0::String="", arg1=nothing, arg2=nothing, kwargs...)

Takes two 2-D grid files which represents the x- and y-components of a vector field and produces a vector field plot by drawing vectors with orientation and length according to the information in the files. Alternatively, polar coordinate r, theta grids may be given instead.

Full option list at grdvector

Parameters

• A | polar :: [Type => Bool]

  The grid contain polar (r, theta) components instead of Cartesian (x, y) [Default is Cartesian components]. (http://docs.generic-mapping-tools.org/latest/grdvector.html#a)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• G | fill :: [Type => Str | Number]

  Sets color or shade for vector interiors [Default is no fill]. (http://docs.generic-mapping-tools.org/latest/grdvector.html#g)

• I | inc :: [Type => Sytr | Number] $Arg=[x]dx[/dy]$

  Only plot vectors at nodes every xinc, yinc apart (must be multiples of original grid spacing). (http://docs.generic-mapping-tools.org/latest/grdvector.html#i)

• N | noclip | no_clip :: [Type => Bool]

  Do NOT clip symbols that fall outside map border (http://docs.generic-mapping-tools.org/latest/grdvector.html#n)

• Q | vec | vector | arrow :: [Type => Str]

  Modify vector parameters. For vector heads, append vector head size [Default is 0, i.e., stick-plot]. (http://docs.generic-mapping-tools.org/latest/grdvector.html#q)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | vec_scale :: [Type => Str | Number] $Arg = [i|l]scale[unit]$

  Sets scale for vector plot length in data units per plot distance measurement unit [1]. (http://docs.generic-mapping-tools.org/latest/grdvector.html#s)

• T | sign_scale :: [Type => Bool]

  Means the azimuths of Cartesian data sets should be adjusted according to the signs of the scales in the x- and y-directions [Leave alone]. (http://docs.generic-mapping-tools.org/latest/grdvector.html#t)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | pen :: [Type => Str | Number]

  Sets the attributes for the particular line. (http://docs.generic-mapping-tools.org/latest/grdvector.html#w)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• Z | azimuth :: [Type => Bool]

  The theta grid provided contains azimuths rather than directions (implies -A). (http://docs.generic-mapping-tools.org/latest/grdvector.html#z)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

grdview(cmd0::String="", arg1=nothing, arg2=nothing, arg3=nothing; kwargs...)

Reads a 2-D grid and produces a 3-D perspective plot by drawing a mesh, painting a colored/grayshaded surface made up of polygons, or by scanline conversion of these polygons to a raster image.

Full option list at grdview

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• Jz | zscale | zsize :: [Type => String]

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | color | colormap | cmap | colorscale :: [Type => Str] $Arg = [cpt |master[+izinc] |color1,color2[,*color3*,…]]$

  Give a CPT name or specify -Ccolor1,color2[,color3,...] to build a linear continuous CPT from those colors automatically. (http://docs.generic-mapping-tools.org/latest/grdimage.html#c)

• G | drape | drapefile :: [Type => Str | GMTgrid | a Tuple with 3 GMTgrid types]

  Drape the image in drapefile on top of the relief provided by relief_file. (http://docs.generic-mapping-tools.org/latest/grdview.html#g)

• I | shade | shading | intensity :: [Type => Str | GMTgrid] $Arg = GMTgrid | filename$

  Gives the name of a grid file or GMTgrid with intensities in the (-1,+1) range, or a grdgradient shading flags. (http://docs.generic-mapping-tools.org/latest/grdview.html#i)

• N | plane :: [Type => Str | Int] $Arg = (level [,fill])$

  Draws a plane at this z-level. (http://docs.generic-mapping-tools.org/latest/grdview.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Q | surftype | surf :: [Type => Str | Int] $Arg = mesh=Bool, surface=Bool, image=Bool, wterfall=(:rows|cols,[fill])$

  Specify m for mesh plot, s for surface, i for image. (http://docs.generic-mapping-tools.org/latest/grdview.html#q)

• S | smoothfactor :: [Type => Number]

  Used to resample the contour lines at roughly every (gridbox_size/smoothfactor) interval.. (http://docs.generic-mapping-tools.org/latest/grdview.html#s)

• T | tiles | no_interp :: [Type => Str | NT] $Arg = (skip|skip_nan=Bool, outlines=Bool|pen)$

  Plot image without any interpolation. (http://docs.generic-mapping-tools.org/latest/grdview.html#t)

• W | pens | pen :: [Type => Str] $Arg = (contour=Bool|pen, mesh=Bool|pen, facade=Bool|pen)$

  Draw contour, mesh or facade. Append pen attributes. (http://docs.generic-mapping-tools.org/latest/grdview.html#w)

• isgeog :: [Type => Any]

  When drapping an image that has projection info over a grid that is in geographics but does not carry any information about this fact we may need to use this option to help the program finding the common BoundingBox.

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• n | interp | interpolation :: [Type => Str] $Arg = [b|c|l|n][+a][+bBC][+c][+tthreshold]$

  Select grid interpolation mode by adding b for B-spline smoothing, c for bicubic interpolation, l for bilinear interpolation, or n for nearest-neighbor value. (http://docs.generic-mapping-tools.org/latest/gmt.html#n-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")

grdvolume(cmd0::String="", arg1=nothing, kwargs...)

Reads one 2-D grid and returns xyz-triplets.

Full option list at grdvolume

Parameters

• C | cont | contour :: [Type => Str | List] $Arg = cval or low/high/delta or rlow/high or rcval$

  Find area, volume and mean height (volume/area) inside the cval contour. (http://docs.generic-mapping-tools.org/latest/grdvolume.html#c)

• L | base_level :: [Type => Number] $Arg = base$

  Also add in the volume from the level of the contour down to base [Default base is contour]. (http://docs.generic-mapping-tools.org/latest/grdvolume.html#l)

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• S | unit :: [Type => Str] $Arg = e|f|k|M|n|u$

  For geographical grids, append a unit from e|f|k|M|n|u [Default is meter (e)]. (http://docs.generic-mapping-tools.org/latest/grdvolume.html#s)

• T :: [Type => Str] $Arg = [c|h]$

  Determine the single contour that maximized the average height (= volume/area). (http://docs.generic-mapping-tools.org/latest/grdvolume.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• Z | scale :: [Type => Str or List] $Arg = fact[/shift]$

  Optionally subtract shift before scaling data by fact. [Default is no scaling]. (http://docs.generic-mapping-tools.org/latest/grdvolume.html#z)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

greenspline(cmd0::String="", arg1=nothing; kwargs...)

Reads randomly-spaced (x,y,z) triples and produces a binary grid file of gridded values z(x,y) by solving:

	(1 - T) * L (L (z)) + T * L (z) = 0

Full option list at greenspline

Parameters

• R | region | limits :: [Type => Str or list or GMTgrid|image] $Arg = (xmin,xmax,ymin,ymax)$

  Specify the region of interest. Set to data minimum BoundinBox if not provided. (http://docs.generic-mapping-tools.org/latest/gmt.html#r-full)

• I | inc :: [Type => Str | Number]

  x_inc [and optionally y_inc] is the grid spacing. (http://docs.generic-mapping-tools.org/latest/greenspline.html#i)

• A | gradient :: [Type => Str | Array] $Arg = gradfile+f1|2|3|4|5 | (data=Array, format=x)$

  The solution will partly be constrained by surface gradients v = v*n, where v is the gradient magnitude and n its unit vector direction. (http://docs.generic-mapping-tools.org/latest/greenspline.html#a)

• C | approx | approximate :: [Type => Str | Number] $Arg = [n]value[+ffile]$

  Find an approximate surface fit: Solve the linear system for the spline coefficients by SVD and eliminate the contribution from all eigenvalues whose ratio to the largest eigenvalue is less than value. (http://docs.generic-mapping-tools.org/latest/greenspline.html#c)

• G | grid :: [Type => Str | []]

  Output grid file name. Note that this is optional and to be used only when saving the result directly on disk. Otherwise, just use the G = greenspline(....) form. (http://docs.generic-mapping-tools.org/latest/greenspline.html#g)

• D | mode :: [Type => Number]

  Sets the distance flag that determines how we calculate distances between data points. (http://docs.generic-mapping-tools.org/latest/greenspline.html#d)

• E :|misfit :: [Type => Str | []] $Arg = [misfitfile]$

  Evaluate the spline exactly at the input data locations and report statistics of the misfit (mean, standard deviation, and rms). (http://docs.generic-mapping-tools.org/latest/greenspline.html#e)

• L | leave_trend :: [Type => Bool]

  Do not remove a linear (1-D) or planer (2-D) trend when -D selects mode 0-3. (http://docs.generic-mapping-tools.org/latest/greenspline.html#l)

• N | nodes :: [Type => Number | Array] $Arg = nodefile$

  ASCII file with coordinates of desired output locations x in the first column(s). (http://docs.generic-mapping-tools.org/latest/greenspline.html#n)

• Q | dir_derivative :: [Type => Str] $Arg = az|x/y/z$

  Rather than evaluate the surface, take the directional derivative in the az azimuth and return the magnitude of this derivative instead. (http://docs.generic-mapping-tools.org/latest/greenspline.html#q)

• S | splines :: [Type => Str] $Arg = c|t|l|r|p|q[pars]$

  Select one of six different splines. The first two are used for 1-D, 2-D, or 3-D Cartesian splines. (http://docs.generic-mapping-tools.org/latest/greenspline.html#s)

• T | mask :: [Type => Str] $Arg = maskgrid$

  For 2-D interpolation only. Only evaluate the solution at the nodes in the maskgrid that are not equal to NaN. (http://docs.generic-mapping-tools.org/latest/greenspline.html#t)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• W | uncertainties :: [Type => Str | []] $Arg = [w]$

Data one-sigma uncertainties are provided in the last column. We then compute weights that
are inversely proportional to the uncertainties squared.
(http://docs.generic-mapping-tools.org/latest/greenspline.html#w)

• b | binary :: [Type => Str]

  (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• d | nodata :: [Type => Str or Number] $Arg = [i|o]nodata$

  Control how user-coded missing data values are translated to official NaN values in GMT. (http://docs.generic-mapping-tools.org/latest/gmt.html#d-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• o | outcols | outcol :: [Type => Str] $Arg = cols[,…]$

  Select specific data columns for primary output, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#ocols-full)

• r | reg | registration :: [Type => Bool or []]

  Force pixel node registration [Default is gridline registration]. (http://docs.generic-mapping-tools.org/latest//gmt.html#r-full)

• x | cores | n_threads :: [Type => Str or Number] $Arg = [[-]n]$

  Limit the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. (http://docs.generic-mapping-tools.org/latest/gmt.html#x-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

histogram(cmd0::String="", arg1=nothing; kwargs...)

Examines the first data column to calculate histogram parameters based on the bin-width provided. Alternatively, show histograms of GMTimage & GMTgrid objects directly. The options 'auto=true' or 'thresholds=(0, 0.1)' will find the histogram bounds convenient for contrast enhancement (histogram stretch). The values represent the percentage of countings used to estimate the boundings. The option 'zoom=true' will set 'auto=true' and show histogram only on the region of interest.

Full option list at pshistogram

Parameters

• J | proj | projection :: [Type => String]

  Select map projection. Defaults to 14x9.5 cm with linear (non-projected) maps. (http://docs.generic-mapping-tools.org/latest/gmt.html#j-full)

• A | horizontal :: [Type => Bool]

  Plot the histogram horizontally from x = 0 [Default is vertically from y = 0]. (http://docs.generic-mapping-tools.org/latest/histogram.html#a)

• Jz | zscale | zsize :: [Type => String]

• B | frame | axis | xaxis yaxis:: [Type => Str]

  Set map boundary frame and axes attributes. (http://docs.generic-mapping-tools.org/latest/gmt.html#b-full)

• C | color | cmap :: [Type => Str | GMTcpt]

  Give a CPT. The mid x-value for each bar is used to look-up the bar color. (http://docs.generic-mapping-tools.org/latest/histogram.html#c)

• D | annot | annotate | counts :: [Type => Str | Tuple]

  Annotate each bar with the count it represents. (http://docs.generic-mapping-tools.org/latest/histogram.html#d)

• E | width :: [Type => Bool] Arg = width[+ooffset]

  Use an alternative histogram bar width than the default set via T, and optionally shift all bars by an offset. (http://docs.generic-mapping-tools.org/latest/histogram.html#e)

• binmethod | *BinMethod** :: [Type => Str] Arg = method

  Binning algorithm: "scott", "fd", "sturges" or "sqrt" for floating point data. "second", "minute", "hour", "day", "week", "month" or "year" for DateTime data.

• F | center :: [Type => Bool]

  Center bin on each value. [Default is left edge]. (http://docs.generic-mapping-tools.org/latest/histogram.html#f)

• G | fill :: [Type => Number | Str]

  Select filling of bars [if no G, L or C set G=100]. (http://docs.generic-mapping-tools.org/latest/histogram.html#g)

• I | inquire | bins :: [Type => Bool | :O | :o | bins=(all=true,) | bins=(no_zero=true,) ]

  Inquire about min/max x and y after binning OR output the binned array. (http://docs.generic-mapping-tools.org/latest/histogram.html#i)

• L | out_range :: [Type => Str] Arg = l|h|b

  Handling of extreme values that fall outside the range set by T. (http://docs.generic-mapping-tools.org/latest/histogram.html#l)

• N | distribution | normal :: [Type => Str]

  Draw the equivalent normal distribution; append desired pen [0.5p,black]. (http://docs.generic-mapping-tools.org/latest/histogram.html#n)

• P | portrait :: [Type => Bool or []]

  Tell GMT to NOT draw in portrait mode (that is, make a Landscape plot)

• Q | cumulative :: [Type => Bool | "r"]

  Draw a cumulative histogram. Append r to instead compute the reverse cumulative histogram. (http://docs.generic-mapping-tools.org/latest/histogram.html#q)

• R | region :: [Type => Str]

  Specifies the ‘region’ of interest in (r,azimuth) space. r0 is 0, r1 is max length in units. (http://docs.generic-mapping-tools.org/latest/histogram.html#r)

• S | stairs :: [Type => Str | number]

  Draws a stairs-step diagram which does not include the internal bars of the default histogram. (http://docs.generic-mapping-tools.org/latest/histogram.html#s)

• T | range | bin :: [Type => Str] Arg = [min/max/]inc[+n] | file|list]

  Make evenly spaced array of bin boundaries from min to max by inc. If min/max are not given then we default to the range in region. For constant bin width use bin=val.. (http://docs.generic-mapping-tools.org/latest/histogram.html#t)

• W | pen :: [Type => Str | Tuple]

  Set pen attributes for sector outline or rose plot. [Default is no outline]. (http://docs.generic-mapping-tools.org/latest/histogram.html#w)

• Z | kind :: [Type => Number | Str]

  Choose between 6 types of histograms. (http://docs.generic-mapping-tools.org/latest/histogram.html#z)

• U | time_stamp | timestamp :: [Type => Str or Bool or []] $Arg = [[just]/dx/dy/][c|label]$

  Draw GMT time stamp logo on plot. (http://docs.generic-mapping-tools.org/latest/gmt.html#u-full)

• V | verbose :: [Type => Bool or Str] $Arg = [level]$

  Select verbosity level, which will send progress reports to stderr. (http://docs.generic-mapping-tools.org/latest/gmt.html#v-full)

• X | x_offset | xshift :: [Type => Str] $Arg = [a|c|f|r][x-shift[u]]$

• Y | y_offset | yshift :: [Type => Str] $Arg = [a|c|f|r][y-shift[u]]$

  Shift plot origin relative to the current origin by (x-shift,y-shift) and optionally append the length unit (c, i, or p). (http://docs.generic-mapping-tools.org/latest/gmt.html#xy-full)

• bi | binary_in :: [Type => Str] $Arg = [ncols][type][w][+L|+B]$

  Select native binary format for primary input (secondary inputs are always ASCII). (http://docs.generic-mapping-tools.org/latest/gmt.html#bi-full)

• di | nodata_in :: [Type => Str or Number] $Arg = nodata$

  Examine all input columns and if any item equals nodata we interpret this value as a missing data item and substitute the value NaN. (http://docs.generic-mapping-tools.org/latest/gmt.html#di-full)

• e | pattern | find :: [Type => Str] $Arg = [~]”pattern” | -e[~]/regexp/[i]$

  Only accept ASCII data records that contains the specified pattern. (http://docs.generic-mapping-tools.org/latest/gmt.html#e-full)

• f | colinfo | coltypes | coltype :: [Type => Str] $Arg = [i|o]colinfo$

  Specify the data types of input and/or output columns (time or geographical data). (http://docs.generic-mapping-tools.org/latest/gmt.html#f-full)

• h | header :: [Type => Str] $Arg = [i|o][n][+c][+d][+rremark][+ttitle]$

  Primary input file(s) has header record(s). (http://docs.generic-mapping-tools.org/latest/gmt.html#h-full)

• i | incols | incol :: [Type => Str] $Arg = cols[+l][+sscale][+ooffset][,…]$

  Select specific data columns for primary input, in arbitrary order. (http://docs.generic-mapping-tools.org/latest/gmt.html#icols-full)

• p | view | perspective :: [Type => Str or List] $Arg = [x|y|z]azim[/elev[/zlevel]][+wlon0/lat0[/z0]][+vx0/y0]$

  Selects perspective view and sets the azimuth and elevation of the viewpoint [180/90]. (http://docs.generic-mapping-tools.org/latest/gmt.html#perspective-full)

• t | alpha | transparency :: [Type => Str] $Arg = transp$

  Set PDF transparency level for an overlay, in (0-100] percent range. [Default is 0, i.e., opaque]. (http://docs.generic-mapping-tools.org/latest/gmt.html#t-full)

• w | wrap | cyclic :: [Type => Str or Number] $Arg = [[-]n]$

  Convert input records to a cyclical coordinate. (http://docs.generic-mapping-tools.org/latest/gmt.html#w-full)

• yx :: [Type => Str or Bool or []] $Arg = [i|o]$

  Swap 1st and 2nd column on input and/or output. (http://docs.generic-mapping-tools.org/latest/gmt.html#colon-full)

• savefig | figname | name :: [Type => Str]

  Save the figure with the figname=name.ext where ext chooses the figure format (e.g. figname="name.png")