PyGMT

dev

Getting Started

  • Overview
  • Installing
  • Making your first figure

Examples

  • Gallery
  • External Resources

User Guide

  • Frames, ticks, titles, and labels
  • Projections
  • Coastlines and borders
  • Setting the region
  • Plotting data points
  • Plotting lines
  • Plotting vectors
  • Plotting datetime charts
  • Plotting text
  • Creating a map with contour lines
  • Plotting Earth relief
  • Creating a 3D perspective image
  • Adding an inset to the figure
  • Making subplots
  • Configuring PyGMT defaults

Reference documentation

  • API Reference
    • Main Features
    • Plotting
      • pygmt.Figure
      • pygmt.Figure.basemap
      • pygmt.Figure.coast
      • pygmt.Figure.colorbar
      • pygmt.Figure.contour
      • pygmt.Figure.grdcontour
      • pygmt.Figure.grdimage
      • pygmt.Figure.grdview
      • pygmt.Figure.histogram
      • pygmt.Figure.image
      • pygmt.Figure.inset
      • pygmt.Figure.legend
      • pygmt.Figure.logo
        • Examples using pygmt.Figure.logo
      • pygmt.Figure.meca
      • pygmt.Figure.plot
      • pygmt.Figure.plot3d
      • pygmt.Figure.rose
      • pygmt.Figure.set_panel
      • pygmt.Figure.shift_origin
      • pygmt.Figure.solar
      • pygmt.Figure.subplot
      • pygmt.Figure.text
      • pygmt.Figure.velo
      • pygmt.Figure.wiggle
      • pygmt.grd2cpt
      • pygmt.makecpt
      • pygmt.Figure.savefig
      • pygmt.Figure.show
      • pygmt.Figure.psconvert
      • pygmt.set_display
    • Data Processing
    • GMT Defaults
    • Metadata
    • Miscellaneous
    • Datasets
    • Exceptions
    • GMT C API
  • Changelog

Development

  • Team Gallery
  • 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, timestamp=None, verbose=None, xshift=None, yshift=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/latest/gmtlogo.html.

Aliases:

  • D = position

  • F = box

  • J = projection

  • R = region

  • S = style

  • U = timestamp

  • V = verbose

  • X = xshift

  • Y = yshift

  • c = panel

  • t = transparency

Parameters
  • projection (str) – Required if this is the first plot command. projcode[projparams/]width. 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 arguments, 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

  • timestamp (bool or str) – Draw GMT time stamp logo on plot.

  • verbose (bool or 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 algorithms);

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

  • panel (bool or int or list) – [row,col|index]. Selects 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 (int or 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¶

Logo

Logo¶

Next Previous

© Copyright 2017-2021, The PyGMT Developers. Revision 81c3afa. Last updated on Jul 31, 2021.

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.