pygmt.Figure.logo¶
-
Figure.
logo
(**kwargs)¶ Plot the GMT logo.
By default, the GMT logo is 2 inches wide and 1 inch high and will be positioned relative to the current plot origin. Use various options to change this and to place a transparent or opaque rectangular map panel behind the GMT logo.
Full option list at https://docs.generic-mapping-tools.org/latest/gmtlogo.html.
Aliases:
D = position
F = box
J = projection
R = region
S = style
U = timestamp
V = verbose
X = xshift
Y = yshift
t = transparency
- Parameters
projection (str) – Required if this is the first plot command. Select map projection.
region (str or list) – Required if this is the first plot command.
'xmin/xmax/ymin/ymax[+r][+uunit]'
. Specify the region of interest.position (str) –
'[g|j|J|n|x]refpoint+wwidth[+jjustify][+odx[/dy]]'
. Sets reference point on the map for the image.box (bool or str) – Without further options, draws a rectangular border around the GMT logo.
style (str) –
l|n|u
. Control what is written beneath the map portion of the logo.l to plot the text label “The Generic Mapping Tools” [Default]
n to skip the label placement
u to place the URL to the GMT site
verbose (str) –
Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity:
q - Quiet, not even fatal error messages are produced
e - Error messages only
w - Warnings [Default]
t - Timings (report runtimes for time-intensive algorthms);
i - Informational messages (same as “verbose=True”)
c - Compatibility warnings
d - Debugging messages
xshift (str) –
[a|c|f|r][xshift]
. Shift plot origin in x-direction.yshift (str) –
[a|c|f|r][yshift]
. Shift plot origin in y-direction. Full documentation is at https://docs.generic-mapping-tools.org/latest/gmt.html#xy-full.transparency (float) – Set transparency level, in [0-100] percent range. Default is 0, i.e., opaque. Only visible when PDF or raster format output is selected. Only the PNG format selection adds a transparency layer in the image (for further processing).