figure

Set attributes for the current modern mode session figure

Synopsis

gmt figure prefix [formats] [options] [ -V[level] ] [ --PAR=value ]

Note: No space is allowed between the option flag and the associated arguments.

Description

A GMT modern session can make any number of illustrations (including none). In situations when multiple illustrations will be made during a single session or when you need specific control over the conversion from PostScript to the output format, the figure module is used to specify the name and format(s) to use for the next plot. It must be issued before you start plotting to the intended figure, and each new figure call changes plotting focus to the next figure. You may go back and forth between different figures but the optional arguments (formats and options) can only be given the first time you specify a new figure. In addition to prefix and formats, you can supply a comma-separated series of psconvert options that will override the default settings provided via PS_CONVERT [A]. The only other available options control verbosity and default parameter settings.

Required Arguments

prefix
Name stem used to construct the figure name. The extension(s) are appended automatically from your formats selection(s).

Optional Arguments

formats
Give one or more comma-separated graphics extensions from the list of allowable graphics formats [pdf].
options
Sets one or more comma-separated options (and possibly arguments) that can be passed to psconvert when preparing this figure [A]. The valid subset of options are A[args],Cargs,Ddir,Edpi,Hfactor,Margs,Qargs,S. See the psconvert documentation for details on these options.
-V[level] (more …)
Select verbosity level [c].
-^ or just -
Print a short message about the syntax of the command, then exits (NOTE: on Windows just use -).
-+ or just +
Print an extensive usage (help) message, including the explanation of any module-specific option (but not the GMT common options), then exits.
-? or no arguments
Print a complete usage (help) message, including the explanation of all options, then exits.
--PAR=value
Temporarily override a GMT default setting; repeatable. See gmt.conf for parameters.

Note on PostScript

If the user selects ps as one of the formats, then please be aware that it is recommended you first set the desired paper size. With ps, GMT needs to work with a fixed paper size since, unlike the eps format, there will be no cropping to BoundingBox. If no paper size is specified via PS_MEDIA then GMT will default to A4 and issue a warning; GMT is unable to determine if that size is adequate for your plot but if the canvas width exceeds A4 paper width we will switch page orientation to landscape. For all other formats the final dimension will be determined automatically.

Examples

To start a new figure in your current modern mode session by the name Regional and request we make both a PDF and an EPS file, try

gmt figure Regional pdf,eps

To start a new figure GlobalMap that should be returned as a JPEG file with a 1 cm padding around the image, try

gmt figure GlobalMap jpg A1c

See Also

begin, clear, docs, end, subplot, gmt