Skip to content

Commit f3aa3f7

Browse files
weiji14seisman
andcommitted
Properly bold and italicize some more arguments and remove grid | image
Co-Authored-By: Dongdong Tian <[email protected]>
1 parent ccf6c1d commit f3aa3f7

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

pygmt/base_plotting.py

+11-11
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,6 @@ def grdimage(self, grid, **kwargs):
379379
Parameters
380380
----------
381381
grid : str or xarray.DataArray
382-
``grid | image``.
383382
The file name or a DataArray containing the input 2-D gridded data
384383
set or image to be plotted (See GRID FILE FORMATS at
385384
:gmt-docs:`grdimage.html#grid-file-formats`).
@@ -392,7 +391,7 @@ def grdimage(self, grid, **kwargs):
392391
*out_img* to select the image file name and extension. If the
393392
extension is one of .bmp, .gif, .jpg, .png, or .tif then no driver
394393
information is required. For other output formats you must append
395-
the required GDAL driver. The driver is the driver code name used
394+
the required GDAL driver. The *driver* is the driver code name used
396395
by GDAL; see your GDAL installation's documentation for available
397396
drivers. Append a **+c**\\ *options* string where options is a list
398397
of one or more concatenated number of GDAL **-co** options. For
@@ -418,8 +417,8 @@ def grdimage(self, grid, **kwargs):
418417
Sets the resolution of the projected grid that will be created if a
419418
map projection other than Linear or Mercator was selected [100]. By
420419
default, the projected grid will be of the same size (rows and
421-
columns) as the input file. Specify *i* to use the PostScript image
422-
operator to interpolate the image at the device resolution.
420+
columns) as the input file. Specify **i** to use the PostScript
421+
image operator to interpolate the image at the device resolution.
423422
bit_color : str
424423
``color[+b|f]``.
425424
This option only applies when a resulting 1-bit image otherwise
@@ -433,13 +432,14 @@ def grdimage(self, grid, **kwargs):
433432
Give the name of a grid file with intensities in the (-1,+1) range,
434433
or a constant intensity to apply everywhere (affects the ambient
435434
light). Alternatively, derive an intensity grid from the input data
436-
grid via a call to `grdgradient`; append **+aazimuth**, **+nargs**,
437-
and **+mambient** to specify azimuth, intensity, and ambient
438-
arguments for that module, or just give **+d** to select the
439-
default arguments (``+a-45+nt1+m0``). If you want a more specific
440-
intensity scenario then run `grdgradient` separately first. If we
441-
should derive intensities from another file than grid, specify the
442-
file with suitable modifiers [Default is no illumination].
435+
grid via a call to `grdgradient`; append **+a** \\ *azimuth*,
436+
**+n** \\ *args*, and **+m** \ *ambient* to specify azimuth,
437+
intensity, and ambient arguments for that module, or just give
438+
**+d** to select the default arguments (``+a-45+nt1+m0``). If you
439+
want a more specific intensity scenario then run `grdgradient`
440+
separately first. If we should derive intensities from another file
441+
than grid, specify the file with suitable modifiers [Default is no
442+
illumination].
443443
{J}
444444
monochrome : bool
445445
Force conversion to monochrome image using the (television) YIQ

0 commit comments

Comments
 (0)