PyGMT

v0.15.0

Getting Started

  • Overview
  • Installing
  • Intro to PyGMT

User Guide

  • Tutorials
  • Gallery
  • Projections
  • External Resources

Reference Documentation

  • API Reference
    • Main Features
    • Plotting
      • Figure class overview
      • Plotting map elements
        • pygmt.Figure.basemap
        • pygmt.Figure.coast
        • pygmt.Figure.colorbar
        • pygmt.Figure.hlines
        • pygmt.Figure.inset
        • pygmt.Figure.legend
        • pygmt.Figure.logo
        • pygmt.Figure.solar
        • pygmt.Figure.text
        • pygmt.Figure.timestamp
        • pygmt.Figure.vlines
      • Plotting tabular data
      • Plotting raster data
      • Configuring layout
      • Saving and displaying the figure
      • Configuring the display settings
      • Color palette table generation
    • Data Processing
    • Input/output
    • GMT Defaults
    • Metadata
    • Enums
    • Miscellaneous
    • Datasets
    • Exceptions
    • GMT C API
  • Technical Reference
  • Changelog
  • Minimum Supported Versions
  • Ecosystem

Development

  • PyGMT Team
  • Contributors Guide
  • Maintainers Guide

Getting help and contributing

  • Code of Conduct
  • License
  • Contact
  • Source Code
PyGMT
  • API Reference
  • pygmt.Figure.logo
  • Improve this page

pygmt.Figure.logo

Figure.logo(*, region=None, projection=None, position=None, box=None, style=None, verbose=None, panel=None, 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 option list at https://docs.generic-mapping-tools.org/6.5/gmtlogo.html.

Aliases:

  • D = position

  • F = box

  • J = projection

  • R = region

  • S = style

  • V = verbose

  • c = panel

  • t = transparency

Parameters:
  • projection (str) – 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 (bool or str) – If set to True, draw 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 (bool or str) – Select verbosity level [Full usage].

  • panel (bool, int, or list) – [row,col|index]. Select a specific subplot panel. Only allowed when in subplot mode. Use panel=True to advance to the next panel in the selected order. Instead of row,col you may also give a scalar value index which depends on the order you set via autolabel when the subplot was defined. Note: 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
Previous Next

© Copyright 2017-2025, The PyGMT Developers. Revision v0.15.0. Last updated on Mar 31, 2025.

Built with Sphinx using a theme provided by Read the Docs

This website uses Google Analytics to gather usage statistics. However, it does not use cookies or track you across different websites. Page view data are used to help us improve the site and provide an estimate of the software usage.