Skip to content

Commit

Permalink
Remove mention of RGB grid inputs, following GMT 6.2.0 grdimage docs
Browse files Browse the repository at this point in the history
  • Loading branch information
weiji14 committed Sep 20, 2020
1 parent 4c1fcb2 commit d2b6997
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions pygmt/base_plotting.py
Original file line number Diff line number Diff line change
Expand Up @@ -325,19 +325,17 @@ def grdimage(self, grid, **kwargs):
"""
Project and plot grids or images.
Reads one 2-D grid file and produces a gray-shaded (or colored) map by
plotting rectangles centered on each grid node and assigning them a
gray-shade (or color) based on the z-value. Alternatively, `grdimage`
reads three 2-D grid files with the red, green, and blue components
directly (all must be in the 0-255 range). Optionally, illumination may
be added by providing a file with intensities in the (-1,+1) range or
instructions to derive intensities from the input data grid. Values
Reads a 2-D grid file and produces a gray-shaded (or colored) map by
building a rectangular image and assigning pixels a gray-shade (or
color) based on the z-value and the CPT file. Optionally, illumination
may be added by providing a file with intensities in the (-1,+1) range
or instructions to derive intensities from the input data grid. Values
outside this range will be clipped. Such intensity files can be created
from the grid using `grdgradient` and, optionally, modified by
`grdmath` or `grdhisteq`. A third alternative is available when GMT is
build with GDAL support. Pass *img* which can be an image file
(geo-referenced or not). In this case the images can optionally be
illuminated with the file provided via the *shading* option. Here, if
build with GDAL support. Pass **image** which can be an image file
(geo-referenced or not). In this case the image can optionally be
illuminated with the file provided via the **shading** option. Here, if
image has no coordinates then those of the intensity file will be used.
When using map projections, the grid is first resampled on a new
Expand All @@ -362,7 +360,10 @@ def grdimage(self, grid, **kwargs):
Parameters
----------
grid : str or xarray.DataArray
The file name of the input grid or the grid loaded as a DataArray.
``grid | image``.
The file name or a DataArray containing the input 2-D gridded data
set or image to be plotted (See GRID FILE FORMATS at
:gmt-docs:`grdimage.html#grid-file-formats`).
img_out : str
``out_img[=driver]``.
Save an image in a raster format instead of PostScript. Use
Expand Down

0 comments on commit d2b6997

Please sign in to comment.