pygmt.Figure.logo

Figure.logo(projection=None, region=None, style='standard', box=False, verbose=False, panel=False, transparency=None, **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 GMT docs at https://docs.generic-mapping-tools.org/6.6/gmtlogo.html.

Aliases:

D = position F = box J = projection

R = region S = style V = verbose

c = panel t = transparency

Parameters:

• projection (str | None, default: None) – projcode[projparams/]width|scale. Select map projection.

• region (str or list) – xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.

• position (str) – [g|j|J|n|x]refpoint+wwidth[+jjustify][+odx[/dy]]. Set reference point on the map for the image.

• box (Box | bool, default: False) – Draw a background box behind the logo. If set to True, a simple rectangular box is drawn using MAP_FRAME_PEN. To customize the box appearance, pass a pygmt.params.Box object to control style, fill, pen, and other box properties.

• style (Literal['standard', 'url', 'no_label'], default: 'standard') –

  Control what is written beneath the map portion of the logo.

  • "standard": The text label “The Generic Mapping Tools”.

  • "no_label": Skip the text label.

  • "url": The URL to the GMT website.

• verbose (bool or str) – Select verbosity level [Full usage].

• panel (int | tuple[int, int] | bool, default: False) –

  Select a specific subplot panel. Only allowed when used in Figure.subplot mode.

  • True to advance to the next panel in the selected order.

  • index to specify the index of the desired panel.

  • (row, col) to specify the row and column of the desired panel.

  The panel order is determined by the Figure.subplot method. row, col and index all start at 0.

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

Examples using pygmt.Figure.logo

GMT logo

GMT logo