Figure.image: Add parameter fgcolor/bgcolor/transparent_color and deprecate bitcolor [Will be removed in 0.24.0] (#4872)

Author: seisman

pygmt/helpers/caching.py

@@ -134,5 +134,6 @@ def cache_data() -> None:
         "@tut_quakes.ngdc",
         "@tut_ship.xyz",
         "@usgs_quakes_22.txt",
+        "@vader1.png",
     ]
     which(fname=datasets, download="auto")

pygmt/src/image.py

@@ -2,19 +2,20 @@
 image - Plot raster or EPS images.
 """
 
+import warnings
 from collections.abc import Sequence
 from typing import Literal
 
 from pygmt._typing import AnchorCode, PathLike
 from pygmt.alias import Alias, AliasSystem
 from pygmt.clib import Session
-from pygmt.helpers import build_arg_list, fmt_docstring, use_alias
+from pygmt.exceptions import GMTParameterError, GMTValueError
+from pygmt.helpers import build_arg_list, fmt_docstring
 from pygmt.params import Axis, Box, Frame, Position
 from pygmt.src._common import _parse_position
 
 
 @fmt_docstring
-@use_alias(G="bitcolor")
 def image(
     self,
     imagefile: PathLike,
@@ -26,6 +27,10 @@ def image(
     box: Box | bool = False,
     monochrome: bool = False,
     invert: bool = False,
+    bgcolor: str | None = None,
+    fgcolor: str | None = None,
+    transparent_color: str | None = None,
+    bitcolor: str | Sequence[str] | None = None,
     projection: str | None = None,
     region: Sequence[float | str] | str | None = None,
     frame: Frame | Axis | Literal["none"] | str | Sequence[str] | bool = False,
@@ -54,10 +59,15 @@ def image(
 
     Full GMT docs at :gmt-docs:`image.html`.
 
-    $aliases
+    **Aliases:**
+
+    .. hlist::
+       :columns: 3
+
        - B = frame
        - D = position, **+w**: width/height, **+r**: dpi, **+n**: replicate
        - F = box
+       - G = **+b**: bgcolor, **+f**: fgcolor, **+t**: transparent_color, bitcolor
        - I = invert
        - J = projection
        - M = monochrome
@@ -74,7 +84,7 @@ def image(
         contain an appropriate BoundingBox. A raster file can have a depth of 1, 8, 24,
         or 32 bits and is read via GDAL.
     position
-        Position of the GMT logo on the plot. It can be specified in multiple ways:
+        Position of the image on the plot. It can be specified in multiple ways:
 
         - A :class:`pygmt.params.Position` object to fully control the reference point,
           anchor point, and offset.
@@ -106,14 +116,25 @@ def image(
         box is drawn using :gmt-term:`MAP_FRAME_PEN`. To customize the box appearance,
         pass a :class:`pygmt.params.Box` object to control style, fill, pen, and other
         box properties.
-    bitcolor : str or list
+    bgcolor
+    fgcolor
+        For 1-bit images, set the background and foreground colors [Default is black and
+        white, respectively]. Setting either to an empty string makes those pixels
+        transparent. Cannot be both empty.
+    transparent_color
+        For color images, set a single color that should be made transparent.
+    bitcolor
         [*color*][**+b**\|\ **f**\|\ **t**].
-        Change certain pixel values to another color or make them transparent.
-        For 1-bit images you can specify an alternate *color* for the
-        background (**+b**) or the foreground (**+f**) pixels, or give no color
-        to make those pixels transparent. Can be repeated with different
-        settings. Alternatively, for color images you can select a single
-        *color* that should be made transparent instead (**+t**).
+        Change certain pixel values to another color or make them transparent. For 1-bit
+        images you can specify an alternate *color* for the background (**+b**) or the
+        foreground (**+f**) pixels, or give no color to make those pixels transparent.
+        Alternatively, for color images you can select a single *color* that should be
+        made transparent instead (**+t**). Pass a list to specify multiple settings.
+
+        .. deprecated:: 0.20.0
+
+            Use ``bgcolor``, ``fgcolor``, or ``transparent_color`` instead. Will be
+            removed in 0.24.0.
     monochrome
         Convert color image to monochrome grayshades using the (television)
         YIQ-transformation.
@@ -142,6 +163,38 @@ def image(
     if width is None and height is not None:
         width = 0
 
+    # TODO(PyGMT>=0.24.0): Remove the deprecated "bitcolor" parameter.
+    if bitcolor is not None:
+        msg = (
+            "The 'bitcolor' parameter has been deprecated since v0.20.0 and will be "
+            "removed in v0.24.0. Use 'bgcolor', 'fgcolor' or 'transparent_color' "
+            "instead."
+        )
+        warnings.warn(msg, category=FutureWarning, stacklevel=2)
+        if any(v is not None for v in [bgcolor, fgcolor, transparent_color]):
+            raise GMTParameterError(
+                conflicts_with=(
+                    "bitcolor",
+                    ["bgcolor", "fgcolor", "transparent_color"],
+                ),
+            )
+
+    # 'bgcolor' and 'fgcolor' cannot both be empty.
+    if bgcolor == "" and fgcolor == "":
+        _value = f"{bgcolor=}, {fgcolor=}"
+        raise GMTValueError(
+            _value,
+            description="bgcolor and fgcolor",
+            reason="'bgcolor' and 'fgcolor' cannot both be empty.",
+        )
+    # GMT requires a color for the "+t" modifier.
+    if transparent_color == "":
+        raise GMTValueError(
+            transparent_color,
+            description="value for 'transparent_color'",
+            reason="'transparent_color' cannot be empty.",
+        )
+
     aliasdict = AliasSystem(
         D=[
             Alias(position, name="position"),
@@ -151,6 +204,13 @@ def image(
             Alias(dpi, name="dpi", prefix="+r"),
         ],
         F=Alias(box, name="box"),
+        G=[
+            Alias(bgcolor, name="bgcolor", suffix="+b"),
+            Alias(fgcolor, name="fgcolor", suffix="+f"),
+            Alias(transparent_color, name="transparent_color", suffix="+t"),
+        ]
+        if bitcolor is None
+        else Alias(bitcolor, name="bitcolor"),
         M=Alias(monochrome, name="monochrome"),
         I=Alias(invert, name="invert"),
     ).add_common(

pygmt/tests/baseline/test_image_bgcolor_fgcolor.png

@@ -4,8 +4,8 @@
 
 import pytest
 from pygmt import Figure
-from pygmt.exceptions import GMTParameterError
-from pygmt.params import Box, Position
+from pygmt.exceptions import GMTParameterError, GMTValueError
+from pygmt.params import Box, Frame, Position
 
 
 @pytest.mark.mpl_image_compare
@@ -74,3 +74,84 @@ def test_image_position_mixed_syntax():
         fig.image(imagefile="@circuit.png", position="x0/0", dpi="300")
     with pytest.raises(GMTParameterError):
         fig.image(imagefile="@circuit.png", position="x0/0", replicate=(2, 1))
+
+
+@pytest.mark.mpl_image_compare
+def test_image_bgcolor_fgcolor():
+    """
+    Test setting the background and foreground colors of a 1-bit image.
+    """
+    fig = Figure()
+    fig.basemap(region=[0, 8, 0, 4], projection="x1c/1c", frame=Frame(fill="gray"))
+    fig.image(imagefile="@vader1.png", position=(0, 0), width="2c")
+    fig.image(imagefile="@vader1.png", position=(2, 0), width="2c", bgcolor="")
+    fig.image(imagefile="@vader1.png", position=(4, 0), width="2c", fgcolor="")
+    fig.image(imagefile="@vader1.png", position=(6, 0), width="2c", bgcolor="red")
+    fig.image(imagefile="@vader1.png", position=(0, 2), width="2c", fgcolor="blue")
+    fig.image(
+        imagefile="@vader1.png",
+        position=(2, 2),
+        width="2c",
+        bgcolor="red",
+        fgcolor="blue",
+    )
+    fig.image(
+        imagefile="@vader1.png",
+        position=(4, 2),
+        width="2c",
+        bgcolor="red",
+        fgcolor="",
+    )
+    fig.image(
+        imagefile="@vader1.png",
+        position=(6, 2),
+        width="2c",
+        bgcolor="",
+        fgcolor="blue",
+    )
+    return fig
+
+
+def test_image_invalid_colors():
+    """
+    Test that invalid 'bgcolor'/'fgcolor'/'transparent_color' values raise an error.
+    """
+    fig = Figure()
+    # Making both the background and the foreground transparent leaves nothing to paint.
+    with pytest.raises(GMTValueError):
+        fig.image(imagefile="@circuit.png", bgcolor="", fgcolor="")
+    # GMT requires a color for the "+t" modifier.
+    with pytest.raises(GMTValueError):
+        fig.image(imagefile="@circuit.png", transparent_color="")
+
+
+# TODO(PyGMT>=0.24.0): Remove the test for the deprecated "bitcolor" parameter.
+def test_image_bitcolor_deprecated():
+    """
+    Test that the deprecated 'bitcolor' parameter still works but warns.
+    """
+    fig = Figure()
+    with pytest.warns(FutureWarning):
+        fig.image(imagefile="@circuit.png", bitcolor="red+b")
+    with pytest.warns(FutureWarning):
+        fig.image(imagefile="@circuit.png", bitcolor=["red+b", "blue+f"])
+
+
+# TODO(PyGMT>=0.24.0): Remove the test for the deprecated "bitcolor" parameter.
+def test_image_bitcolor_conflict():
+    """
+    Test that the deprecated 'bitcolor' parameter raises an error when used with
+    'bgcolor', 'fgcolor', or 'transparent_color'.
+    """
+    fig = Figure()
+    with pytest.raises(GMTParameterError):
+        with pytest.warns(FutureWarning):
+            fig.image(imagefile="@circuit.png", bitcolor="red+b", bgcolor="blue")
+    with pytest.raises(GMTParameterError):
+        with pytest.warns(FutureWarning):
+            fig.image(imagefile="@circuit.png", bitcolor="red+b", fgcolor="blue")
+    with pytest.raises(GMTParameterError):
+        with pytest.warns(FutureWarning):
+            fig.image(
+                imagefile="@circuit.png", bitcolor="red+b", transparent_color="blue"
+            )