pygmt.Figure.grdimage

Figure.grdimage(grid, **kwargs)

Project grids or images and plot them on maps.

Takes a grid file name or an xarray.DataArray object as input.

Full option list at https://docs.generic-mapping-tools.org/latest/grdimage.html

Aliases:

  • B = frame

  • C = cmap

  • I = shading

  • J = projection

  • R = region

  • W = pen

  • t = transparency

  • x = cores

Parameters

  • grid (str or xarray.DataArray) – The file name of the input grid or the grid loaded as a DataArray.

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

  • cores (int) – [[-]n]. Limit the number of cores to be used in any OpenMP-enabled multi-threaded algorithms. By default we try to use all available cores. Set a number n to only use n cores (if too large it will be truncated to the maximum cores available). Finally, give a negative number -n to select (all - n) cores (or at least 1 if n equals or exceeds all).