gmt-fork/doc/GMT_Quick_reference.tex

%------------------------------------------
%	$Id$
%
%	The GMT Documentation Project
%	Copyright (c) 2000-2012.
%	P. Wessel, W. H. F. Smith, R. Scharroo, and J. Luis
%------------------------------------------
%
\documentclass{article}
\begin{document}

\par FILTERING OF 1-D AND 2-D DATA:\par 

\par 	blockmean/median/mode	L2, L1, and mode estimate (\emph{x},\emph{y},\emph{z}) data filters/decimators\par 

\par 	filter1d	Filter 1-D data (time series)\par 

\par 	grdfilter	Filter 2-D data in space domain\par 

\par \par 

\par PLOTTING OF 1-D and 2-D DATA:\par 

\par 	grdcontour	Contouring of 2-D gridded data \par 

\par 	grdimage	Produce images from 2-D gridded data \par 

\par 	grdvector	Plot vector fields from 2-D gridded data\par 

\par 	grdview	3-D perspective imaging of 2-D gridded data \par 

\par 	psbasemap	Create a basemap frame\par 

\par 	psclip	Use polygon files as clipping paths\par 

\par 	pscoast	Plot coastlines, filled continents, rivers, and political borders\par 

\par 	pscontour	Direct contouring or imaging of \emph{xyz} data by triangulation \par 

\par 	pshistogram	Plot a histogram\par 

\par 	psimage	Plot Sun raster files on a map\par 

\par 	psmask	Create overlay to mask specified regions of a map\par 

\par 	psrose	Plot sector or rose diagrams\par 

\par 	psscale	Plot gray scale or color scale\par 

\par 	pstext	Plot text strings\par 

\par 	pswiggle	Draw anomalies along track\par 

\par 	psxy	Plot symbols, polygons, and lines in 2-D\par 

\par 	psxyz	Plot symbols, polygons, and lines in 3-D\par 

\par \par 

\par GRIDDING OF (X,Y,Z) TABLE DATA:\par 

\par 	nearneighbor	Nearest-neighbor gridding scheme\par 

\par 	greenspline	Interpolation using Green's functions\par 

\par 	surface	Continuous curvature gridding algorithm\par 

\par 	triangulate	Perform optimal Delauney triangulation on \emph{xyz} data\par 

\par \par 

\par SAMPLING OF 1-D AND 2-D DATA:\par 

\par 	gmtdp		Line reduction using the Douglas-Peucker algorithm\par 

\par 	grdsample	Resample a 2-D gridded data onto new grid\par 

\par 	grdtrack	Sampling of 2-D data along 1-D track\par 

\par 	sample1d	Resampling of 1-D data\par 

\par \par 

\par PROJECTION AND MAP-TRANSFORMATION:\par 

\par 	grdproject	Transform gridded data to a new coordinate system\par 

\par 	mapproject	Transform table data to a new coordinate system\par 

\par 	project	Project data onto lines or great circles\par 

\par \par 

\par INFORMATION:\par 

\par 	gmtdefaults	List the current default settings\par 

\par 	gmtset	Command-line editing of parameters in the \filename{gmt.conf} file\par 

\par 	gmtwhich	Find full path to specified data files\par 

\par 	grdinfo	Get information about the content of grid files\par 

\par 	minmax	Report extreme values in table data files\par 

\par \par 

\par CONVERT OR EXTRACT SUBSETS OF DATA:\par 

\par 	gmtconvert	Convert table data from one format to another\par 

\par 	gmtselect	Select table data subsets based on multiple spatial criteria\par 

\par 	gmtspatial	Geospatial operations on lines and polygons\par 

\par 	gmtstitch	Join segments into more complete lines or polygons\par 

\par 	grd2xyz	Convert 2-D gridded data to table data\par 

\par 	grdcut	Cut a sub-region from a grid file\par 

\par 	grdpaste	Paste together grid files along common edge\par 

\par 	grdreformat	Convert from one grid format to another\par 

\par 	splitxyz	Split \emph{xyz} table data into several segments\par 

\par 	xyz2grd	Convert table data to 2-D grid file\par 

\par \par 

\par MISCELLANEOUS:\par 

\par 	gmtmath	Reverse Polish Notation (RPN) calculator for data tables\par 

\par 	makecpt	Create GMT color palette tables\par 

\par 	spectrum1d	Compute spectral estimates from time-series\par 

\par 	triangulate	Perform optimal Delauney triangulation on xyz data\par 

\par \par 

\par DETERMINE TRENDS IN 1-D AND 2-D DATA:\par 

\par 	fitcircle	Finds best-fitting great or small circles\par 

\par 	grdtrend	Fits polynomial trends to grid files (\emph{z} = f(\emph{x},\emph{y}))\par 

\par 	trend1d	Fits polynomial or Fourier trends to \emph{y} = f(\emph{x}) series\par 

\par 	trend2d	Fits polynomial trends to \emph{z} = f(\emph{x},\emph{y}) series\par 

\par \par 

\par OTHER OPERATIONS ON 2-D GRIDS:\par 

\par 	grd2cpt	Make color palette table from grid files\par 

\par 	grdclip	Limit the \emph{z}-range in gridded data sets\par 

\par 	grdedit	Modify grid header information\par 

\par 	grdfft	Operate on grid files in frequency domain\par 

\par 	grdgradient	Compute directional gradients from grid files\par 

\par 	grdhisteq	Histogram equalization for grid files\par 

\par 	grdlandmask	Creates mask grid file from coastline database\par 

\par 	grdmask	Set grid nodes in/outside a clip path to constants\par 

\par 	grdmath	Reverse Polish Notation (RPN) calculator for grid files\par 

\par 	grdvolume	Calculate volume under a surface within a contour\par 

\par \par 

\par	 gmt2kml	Convert GMT data tables to KML files for Google Earth\par

\par	 kml2gmt	Extract GMT data from a Google Earth KML file\par

\par	 ps2raster	Crop and convert PostScript files to raster images, EPS, and PDF\par

\par \par 

\par STANDARDIZED COMMAND LINE OPTIONS:\par 

\par \Opt{B}\emph{xtick}[\emph{:text:}][\emph{/ytick}[\emph{:text:}]][\emph{/ztick}[\emph{:text:}]][\emph{WESNZwesnz+}][\emph{:.title:}]	Tickmarks\par 

\par \Opt{J} Map projection.  Give \underline{width} or use lower case code and specify map \underline{scale}\par 

\par 	\Opt{JA}\emph{lon0/lat0/width}	Lambert azimuthal equal area\par 

\par 	\Opt{JB}\emph{lon0/lat0/lat1/lat2/width}	Albers conic equal area\par 

\par 	\Opt{JC}\emph{lon0/lat0/width}	Cassini cylindrical\par 

\par 	\Opt{JCyl\_stere}\emph{lon0/lat0/width}	Cylindrical stereographic\par 

\par 	\Opt{JE}\emph{lon0/lat0/width}	Azimuthal equidistant\par 

\par 	\Opt{JF}\emph{lon0/lat0horizon/width}	Azimuthal Gnomonic\par 

\par 	\Opt{JG}\emph{lon0/lat0/width}	Azimuthal orthographic\par 

\par 	\Opt{JH}\emph{lon0/width}	Hammer equal area\par 

\par 	\Opt{JI}\emph{lon0/width}	Sinusoidal equal area\par 

\par 	\Opt{JJ}\emph{lon0/width}	Miller cylindrical\par 

\par 	\Opt{JK}\emph{lon0/width}	Eckert IV equal area\par 

\par 	\Opt{JL}\emph{lon0/lat0/lat1/lat2/width}	Lambert conic conformal\par 

\par 	\Opt{JM}\emph{width }or\emph{}\Opt{JM}\emph{lon0/lat0/width}	Mercator cylindrical\par 

\par 	\Opt{JN}\emph{lon0/width}	Robinson\par 

\par 	\Opt{JOa}\emph{lon0/lat0/az/width}	Oblique Mercator, 1:	origin and azimuth\par 

\par 	\Opt{JOb}\emph{lon0/lat0/lon1/lat1/width}	Oblique Mercator, 2:	two points\par 

\par 	\Opt{JOc}\emph{lon0/lat0/lonp/latp/width}	Oblique Mercator, 3:	origin and pole\par 

\par 	\Opt{JP}\emph{width}	Polar (\emph{q}, \emph{r}) (or cylindrical)\par 

\par 	\Opt{JPoly}\emph{lon0/width}	Polyconic\par 

\par 	\Opt{JQ}\emph{lon0/width}	Equidistant cylindrical (Plate Carr\'{e})\par 

\par 	\Opt{JR}\emph{lon0/width}	Winkel Tripel\par 

\par 	\Opt{JS}\emph{lon0/lat0/width}	General stereographic\par 

\par 	\Opt{JT}\emph{lon0/width}	Transverse Mercator\par 

\par 	\Opt{JU}\emph{zone/width}	Universal Transverse Mercator (UTM)\par 

\par 	\Opt{JW}\emph{lon0/width}	Mollweide\par 

\par 	\Opt{JX}\emph{width}[\textbf{l}|\textbf{p}][/\emph{heigh}t[\textbf{l}|\textbf{p}]][\textbf{d}]	Linear, log$_{10}$, and $x^a$--$y^b$\par 

\par 	\Opt{JY}\emph{lon0/lats/width}	General cylindrical equal area\par 

\par \Opt{K}	Append more PostScript later\par 

\par \Opt{O}	This is an overlay plot\par 

\par \Opt{P}	Select Portrait orientation\par 

\par \Opt{R}\emph{west/east/south/north}[\emph{/zmin/zmax}][\textbf{r}]	Specify Region of interest\par 

\par \Opt{U}[\emph{/dx/dy}/][\emph{label}]	Plot time-stamp on plot\par 

\par \Opt{V}	Run in verbose mode\par 

\par \Opt{X}\emph{off} \Opt{Y}\emph{off}	Shift lower left corner of plot [1/1]\par 

\par \Opt{a}\emph{name=col,}	Set aspatial column associations\par 

\par \Opt{c}\emph{copies}	Set number of plot copies [1]\par 

\par \Opt{f}\emph{info}	Specifies the data format on a per column basis  \par

\par \Opt{g}\emph{info}	Identify data gaps based on supplied criteria  \par

\par \Opt{h}\emph{[n\_headers]}	Input/output ASCII tables have header record[s]\par 

\par \Opt{p}\emph{azim/elev}[\emph{zlevel}][\textbf{+}\emph{lon0/lat0}[/\emph{z0}]][\textbf{+v}\emph{x0/y0}]	Perspective views\par

\par \Opt{s}[\textbf{r}]	Controls output of records where \emph{z} is NaN	\par

\par \Opt{t}[\emph{trans}]	Sets layer PDF transparency  \par

\par \Opt{:}	Expect \emph{y}/\emph{x} input rather than \emph{x}/\emph{y}\par 

\end{document}