Skip to content

Commit 4c1fcb2

Browse files
committed
Alias bit_color (G) for grdimage
1 parent 4584c32 commit 4c1fcb2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

pygmt/base_plotting.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -308,6 +308,7 @@ def grdcontour(self, grid, **kwargs):
308308
C="cmap",
309309
D="img_in",
310310
E="dpi",
311+
G="bit_color",
311312
I="shading",
312313
J="projection",
313314
M="monochrome",
@@ -399,6 +400,14 @@ def grdimage(self, grid, **kwargs):
399400
default, the projected grid will be of the same size (rows and
400401
columns) as the input file. Specify *i* to use the PostScript image
401402
operator to interpolate the image at the device resolution.
403+
bit_color : str
404+
``color[+b|f]``.
405+
This option only applies when a resulting 1-bit image otherwise
406+
would consist of only two colors: black (0) and white (255). If
407+
so, this option will instead use the image as a transparent mask
408+
and paint the mask with the given color. Append **+b** to paint
409+
the background pixels (1) or **+f** for the foreground pixels
410+
[Default].
402411
{J}
403412
monochrome : bool
404413
Force conversion to monochrome image using the (television) YIQ

0 commit comments

Comments
 (0)