Skip to content

Commit

Permalink
Document shading (I) for grdimage
Browse files Browse the repository at this point in the history
  • Loading branch information
weiji14 committed Sep 21, 2020
1 parent 581968a commit a0771e6
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions pygmt/base_plotting.py
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,18 @@ def grdimage(self, grid, **kwargs):
paint the mask with the given color. Append **+b** to paint the
background pixels (1) or **+f** for the foreground pixels
[Default].
shading : str
``[intensfile|intensity|modifiers]``.
Give the name of a grid file with intensities in the (-1,+1) range,
or a constant intensity to apply everywhere (affects the ambient
light). Alternatively, derive an intensity grid from the input data
grid via a call to `grdgradient`; append **+aazimuth**, **+nargs**,
and **+mambient** to specify azimuth, intensity, and ambient
arguments for that module, or just give **+d** to select the
default arguments (``+a-45+nt1+m0``). If you want a more specific
intensity scenario then run `grdgradient` separately first. If we
should derive intensities from another file than grid, specify the
file with suitable modifiers [Default is no illumination].
{J}
monochrome : bool
Force conversion to monochrome image using the (television) YIQ
Expand Down

0 comments on commit a0771e6

Please sign in to comment.