pygmt.Figure.logo

Figure.logo(position=None, position_type='plotcoords', anchor=None, anchor_offset=None, height=None, width=None, 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. The position can be changed by specifying the reference point (via position_type and position) and anchor point (via anchor and anchor_offset). Refer to /techref/reference_anchor_points for details about the positioning.

Full GMT docs at https://docs.generic-mapping-tools.org/6.6/gmtlogo.html.

Aliases:

D = position/position_type, +j: anchor, +o: anchor_offset, +w: width, +h: height

F = box J = projection R = region

S = style V = verbose

c = panel t = transparency

Parameters:

• position (Union[Sequence[str | float], Literal['TL', 'TC', 'TR', 'ML', 'MC', 'MR', 'BL', 'BC', 'BR'], None], default: None) – Specify the reference point on the plot for the GMT logo. The method of defining the reference point is controlled by position_type, and the exact location is set by position.

• position_type (Literal['mapcoords', 'boxcoords', 'plotcoords', 'inside', 'outside'], default: 'plotcoords') –

  Specify the type of coordinates used to define the reference point. It can be one of the following values:

  • "mapcoords": position is specified as (longitude, latitude) in map coordinates. Example: (120, -45) places the reference point at 120°E, 45°S.

  • "boxcoords": position is specified as (nx, ny) in normalized coordinates, i.e., fractional values between 0 and 1 along the x- and y-axes. Example: (0, 0) corresponds to the lower-left corner, and (1, 1) to the upper-right corner of the plot bounding box.

  • "plotcoords": position is specified as (x, y) in plot coordinates, i.e., distances from the lower-left plot origin given in inches, centimeters, or points. Example: (“1c”, “2c”) places the reference point 1 cm to the right and 2 cm above the plot origin.

  • "inside" or "outside": position is one of the nine two-character justification codes, indicating a specific location relative to the plot bounding box. Example: "TL" places the reference point at the top-left corner, either inside or outside the bounding box.

• anchor (Optional[Literal['TL', 'TC', 'TR', 'ML', 'MC', 'MR', 'BL', 'BC', 'BR']], default: None) –

  Specify the anchor point of the GMT logo, using one of the 2-character justification codes. The default value depends on position_type.

  • position_type="inside": anchor defaults to the same as position.

  • position_type="outside": anchor defaults to the mirror opposite of position.

  • Otherwise, anchor defaults to "MC" (middle center).

• anchor_offset (Sequence[float | str] | None, default: None) – Specifies an offset for the anchor point as offset or (offset_x, offset_y). If a single value offset is given, both offset_x and offset_y are set to offset.

• width (float | str | None, default: None)

• height (float | str | None, default: None) – Width or height of the GMT logo. Since the aspect ratio is fixed, only one of the two can be specified.

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

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

• 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