Skip to content

Commit d2b6997

Browse files
committed
Remove mention of RGB grid inputs, following GMT 6.2.0 grdimage docs
1 parent 4c1fcb2 commit d2b6997

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

pygmt/base_plotting.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -325,19 +325,17 @@ def grdimage(self, grid, **kwargs):
325325
"""
326326
Project and plot grids or images.
327327
328-
Reads one 2-D grid file and produces a gray-shaded (or colored) map by
329-
plotting rectangles centered on each grid node and assigning them a
330-
gray-shade (or color) based on the z-value. Alternatively, `grdimage`
331-
reads three 2-D grid files with the red, green, and blue components
332-
directly (all must be in the 0-255 range). Optionally, illumination may
333-
be added by providing a file with intensities in the (-1,+1) range or
334-
instructions to derive intensities from the input data grid. Values
328+
Reads a 2-D grid file and produces a gray-shaded (or colored) map by
329+
building a rectangular image and assigning pixels a gray-shade (or
330+
color) based on the z-value and the CPT file. Optionally, illumination
331+
may be added by providing a file with intensities in the (-1,+1) range
332+
or instructions to derive intensities from the input data grid. Values
335333
outside this range will be clipped. Such intensity files can be created
336334
from the grid using `grdgradient` and, optionally, modified by
337335
`grdmath` or `grdhisteq`. A third alternative is available when GMT is
338-
build with GDAL support. Pass *img* which can be an image file
339-
(geo-referenced or not). In this case the images can optionally be
340-
illuminated with the file provided via the *shading* option. Here, if
336+
build with GDAL support. Pass **image** which can be an image file
337+
(geo-referenced or not). In this case the image can optionally be
338+
illuminated with the file provided via the **shading** option. Here, if
341339
image has no coordinates then those of the intensity file will be used.
342340
343341
When using map projections, the grid is first resampled on a new
@@ -362,7 +360,10 @@ def grdimage(self, grid, **kwargs):
362360
Parameters
363361
----------
364362
grid : str or xarray.DataArray
365-
The file name of the input grid or the grid loaded as a DataArray.
363+
``grid | image``.
364+
The file name or a DataArray containing the input 2-D gridded data
365+
set or image to be plotted (See GRID FILE FORMATS at
366+
:gmt-docs:`grdimage.html#grid-file-formats`).
366367
img_out : str
367368
``out_img[=driver]``.
368369
Save an image in a raster format instead of PostScript. Use

0 commit comments

Comments
 (0)