Skip to content

Commit a0771e6

Browse files
committed
Document shading (I) for grdimage
1 parent 581968a commit a0771e6

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

pygmt/base_plotting.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -421,6 +421,18 @@ def grdimage(self, grid, **kwargs):
421421
paint the mask with the given color. Append **+b** to paint the
422422
background pixels (1) or **+f** for the foreground pixels
423423
[Default].
424+
shading : str
425+
``[intensfile|intensity|modifiers]``.
426+
Give the name of a grid file with intensities in the (-1,+1) range,
427+
or a constant intensity to apply everywhere (affects the ambient
428+
light). Alternatively, derive an intensity grid from the input data
429+
grid via a call to `grdgradient`; append **+aazimuth**, **+nargs**,
430+
and **+mambient** to specify azimuth, intensity, and ambient
431+
arguments for that module, or just give **+d** to select the
432+
default arguments (``+a-45+nt1+m0``). If you want a more specific
433+
intensity scenario then run `grdgradient` separately first. If we
434+
should derive intensities from another file than grid, specify the
435+
file with suitable modifiers [Default is no illumination].
424436
{J}
425437
monochrome : bool
426438
Force conversion to monochrome image using the (television) YIQ

0 commit comments

Comments
 (0)