inset

Manage figure inset setup and completion

The inset module is used to carve out a sub-region of the current plot canvas and restrict further plotting to that section of the canvas. The inset setup is started with the begin directive that defines the placement and size of the inset. Subsequent plot commands will be directed to that window. The inset is completed via the end directive, which reverts operations to the full canvas and restores the plot region and map projection that was in effect prior to the setup of the inset.

Synopsis (begin mode)

gmt inset begin -Dinset-box [ -Fbox ] [ -Mmargins ] [ -V[level] ] [ --PAR=value ]

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

Description

The begin directive of inset defines the dimension and placement of the inset canvas. It records the current region and projection so that we may return to the initial plot environment when the inset is completed.

Required Arguments

-D[unit]xmin/xmax/ymin/ymax[r] | -D[g|j|J|n|x]refpoint+wwidth[/height][+jjustify][+odx[/dy]]
Define the map inset box on the map. Specify the box in one of three ways: (a) Give west/east/south/north of geographic rectangle bounded by parallels and meridians; append r if the coordinates instead are the lower left and upper right corners of the desired rectangle. (b) Give uxmin/xmax/ymin/ymax of bounding rectangle in projected coordinates (here, u is the coordinate unit). (c) Give the reference point on the map for the inset using one of four coordinate systems: (1) Use -Dg for map (user) coordinates, (2) use -Dj or -DJ for setting refpoint via a 2-char justification code that refers to the (invisible) map domain rectangle, (3) use -Dn for normalized (0-1) coordinates, or (4) use -Dx for plot coordinates (inches, cm, etc.). Append +wwidth[/height] of bounding rectangle or box in plot coordinates (inches, cm, etc.). By default, the anchor point on the scale is assumed to be the bottom left corner (BL), but this can be changed by appending +j followed by a 2-char justification code justify (see text). Note: If -Dj is used then justify defaults to the same as refpoint, if -DJ is used then justify defaults to the mirror opposite of refpoint. Add +o to offset the inset fig by dx/dy away from the refpoint point in the direction implied by justify (or the direction implied by -Dj or -DJ). Specify inset box attributes via the -F option [outline only].

Optional Arguments

-F[+cclearances][+gfill][+i[[gap/]pen]][+p[pen]][+r[radius]][+s[[dx/dy/][shade]]]
Without further options, draws a rectangular border around the map inset using MAP_FRAME_PEN; specify a different pen with +ppen. Add +gfill to fill the logo box [no fill]. Append +cclearance where clearance is either gap, xgap/ygap, or lgap/rgap/bgap/tgap where these items are uniform, separate in x- and y-direction, or individual side spacings between logo and border. Append +i to draw a secondary, inner border as well. We use a uniform gap between borders of 2p and the MAP_DEFAULT_PEN unless other values are specified. Append +r to draw rounded rectangular borders instead, with a 6p corner radius. You can override this radius by appending another value. Finally, append +s to draw an offset background shaded region. Here, dx/dy indicates the shift relative to the foreground frame [4p/-4p] and shade sets the fill style to use for shading [gray50].
-Mmargins
This is clearance that is added around the inside of the inset. Plotting will take place within the inner region only. The margins can be a single value, a pair of values separated by slashes (for setting separate horizontal and vertical margins), or the full set of four margins (for setting separate left, right, bottom, and top margins) [0.5c].
-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.

Synopsis (end mode)

gmt inset end [ -V[level] ]

The end directive finalizes the current inset, which returns the plotting environment to the state prior to the start of the inset. The previous region and map projection will be in effect going forward.

Optional Arguments

-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.

Examples

To make a simple basemap plot called inset.pdf that demonstrates the inset module, try

gmt begin inset pdf
  gmt basemap -R0/40/20/60 -JM6.5i -Bafg -B+glightgreen
    gmt inset begin -DjTR+w2.5i+o0.2i -F+gpink+p0.5p -M0.25i
      gmt basemap -Rg -JA20/20/2i -Bafg
      echo INSET | gmt text -F+f18p+cTR -Dj-0.15i
    gmt inset end
  echo MAP | gmt text -F+f18p+cBL -Dj0.2i
gmt end

See Also

begin, clear, docs, end, figure, gmt, inset