Add Figure.directional_rose for adding directional rose on maps

Author: seisman

doc/api/index.rst

@@ -27,6 +27,7 @@ Plotting map elements
     Figure.basemap
     Figure.coast
     Figure.colorbar
+    Figure.directional_rose
     Figure.hlines
     Figure.inset
     Figure.legend

pygmt/figure.py

@@ -413,6 +413,7 @@ def _repr_html_(self) -> str:
         coast,
         colorbar,
         contour,
+        directional_rose,
         grdcontour,
         grdimage,
         grdview,

pygmt/src/__init__.py

@@ -10,6 +10,7 @@
 from pygmt.src.config import config
 from pygmt.src.contour import contour
 from pygmt.src.dimfilter import dimfilter
+from pygmt.src.directional_rose import directional_rose
 from pygmt.src.filter1d import filter1d
 from pygmt.src.grd2cpt import grd2cpt
 from pygmt.src.grd2xyz import grd2xyz

pygmt/src/directional_rose.py

@@ -0,0 +1,111 @@
+"""
+directional_rose - Add a map directional rose.
+"""
+
+from collections.abc import Sequence
+from typing import Literal
+
+from pygmt._typing import AnchorCode
+from pygmt.alias import Alias, AliasSystem
+from pygmt.clib import Session
+from pygmt.exceptions import GMTInvalidInput
+from pygmt.helpers import build_arg_list, fmt_docstring
+from pygmt.params import Box, Position
+from pygmt.src._common import _parse_position
+
+
+@fmt_docstring
+def directional_rose(
+    self,
+    position: Position | Sequence[float | str] | AnchorCode | None = None,
+    width: float | str | None = None,
+    labels: Sequence[str] | bool = False,
+    fancy: Literal[1, 2, 3] | bool = False,
+    box: Box | bool = False,
+    verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
+    | bool = False,
+    panel: int | Sequence[int] | bool = False,
+    perspective: str | bool = False,
+    transparency: float | None = None,
+):
+    """
+    Add a directional rose on the map.
+
+    Parameters
+    ----------
+    position
+        Position of the directional rose 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.
+        - A sequence of two values representing the x and y coordinates in plot
+          coordinates, e.g., ``(1, 2)`` or ``("1c", "2c")``.
+        - A :doc:`2-character justification code </techref/justification_codes>` for a
+          position inside the plot, e.g., ``"TL"`` for Top Left corner inside the plot.
+
+        If not specified, defaults to the lower-left corner of the plot.
+    width
+        Width of the rose in plot coordinates, or append % for a size in percentage of
+        map width [Default is 10%].
+    labels
+        A sequence of four strings to label the cardinal points W,E,S,N. Use an empty
+        string to skip a specific label. If set to ``True``, the default labels
+        ``["W", "E", "S", "N"]`` are used.
+    fancy
+        Get a fancy rose. The fanciness level can be set to 1, 2, or 3:
+
+        - Level 1 draws the two principal E-W, N-S orientations
+        - Level 2 adds the two intermediate NW-SE and NE-SW orientations
+        - Level 3 adds the four minor orientations WNW-ESE, NNW-SSE, NNE-SSW, and
+          ENE-WSW
+
+        If set to ``True``, defaults to level 1.
+    box
+        Draw a background box behind the directional rose. If set to ``True``, a simple
+        rectangular 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.
+    $verbose
+    $panel
+    $perspective
+    $transparency
+
+    Examples
+    --------
+    >>> import pygmt
+    >>> fig = pygmt.Figure()
+    >>> fig.basemap(region=[0, 80, -30, 30], projection="M10c", frame=True)
+    >>> fig.directional_rose(position=Position((10, 10), cstype="mapcoords"))
+    >>> fig.show()
+    """
+    self._activate_figure()
+
+    position = _parse_position(
+        position,
+        kwdict={"width": width, "fancy": fancy, "labels": labels},
+        default=Position((0, 0), cstype="plotcoords"),  # Default to (0,0) in plotcoords
+    )
+
+    # width is mandatory.
+    if width is None and not isinstance(position, str):
+        msg = "Parameter 'width' is required."
+        raise GMTInvalidInput(msg)
+
+    aliasdict = AliasSystem(
+        F=Alias(box, name="box"),
+        Td=[
+            Alias(position, name="position"),
+            Alias(width, name="width", prefix="+w"),
+            Alias(fancy, name="fancy", prefix="+f"),  # +F is not supported yet.
+            Alias(labels, name="labels", prefix="+l", sep=",", size=4),
+        ],
+    ).add_common(
+        V=verbose,
+        c=panel,
+        p=perspective,
+        t=transparency,
+    )
+
+    with Session() as lib:
+        lib.call_module(module="basemap", args=build_arg_list(aliasdict))

pygmt/tests/baseline/test_directional_rose_complex.png.dvc

@@ -0,0 +1,5 @@
+outs:
+- md5: 4bf9dc9a74af3df5fe03ba4cdfaf27ca
+  size: 14424
+  hash: md5
+  path: test_directional_rose_complex.png

pygmt/tests/baseline/test_directional_rose_default_position.png.dvc

@@ -0,0 +1,5 @@
+outs:
+- md5: 4d113eabadf8acafed3d8a73da7f4b7e
+  size: 13902
+  hash: md5
+  path: test_directional_rose_default_position.png

pygmt/tests/test_directional_rose.py

@@ -0,0 +1,56 @@
+"""
+Test Figure.directional_rose.
+"""
+
+import pytest
+from pygmt import Figure
+from pygmt.exceptions import GMTInvalidInput
+from pygmt.params import Position
+
+
+@pytest.mark.mpl_image_compare(filename="test_basemap_rose.png")
+def test_directional_rose():
+    """
+    Test the Figure.directional_rose method.
+    """
+    fig = Figure()
+    fig.basemap(region=[127.5, 128.5, 26, 27], projection="H15c", frame=True)
+    fig.directional_rose(position="MC", width="5c")
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_directional_rose_default_position():
+    """
+    Test the Figure.directional_rose method with default position.
+    """
+    fig = Figure()
+    fig.basemap(region=[0, 80, -30, 30], projection="M10c", frame=True)
+    fig.directional_rose(width="3c")
+    return fig
+
+
+@pytest.mark.mpl_image_compare
+def test_directional_rose_complex():
+    """
+    Test the Figure.directional_rose method with more parameters.
+    """
+    fig = Figure()
+    fig.basemap(region=[0, 80, -30, 30], projection="M10c", frame=True)
+    fig.directional_rose(
+        position=Position((50, 0), cstype="mapcoords", anchor="MC", offset=(1, 1)),
+        width="1c",
+        labels=["", "", "", "N"],
+        fancy=2,
+    )
+    return fig
+
+
+def test_directional_rose_no_width():
+    """
+    Test the Figure.directional_rose method without width parameter.
+    """
+    fig = Figure()
+    fig.basemap(region=[0, 80, -30, 30], projection="M10c", frame=True)
+    with pytest.raises(GMTInvalidInput):
+        fig.directional_rose()

pygmt/tests/test_inset.py

@@ -30,5 +30,6 @@ def test_inset_context_manager():
     fig.basemap(region=[-74, -69.5, 41, 43], projection="M9c", frame=True)
     with fig.inset(position="jBL+w3c+o0.2c", clearance=0, box=Box(pen="black")):
         fig.basemap(region=[-80, -65, 35, 50], projection="M3c", frame="afg")
-    fig.basemap(rose="jTR+w3c")  # Pass rose argument with basemap after the inset
+    # Plot an rose after the inset
+    fig.directional_rose(position="TR", width="3c")
     return fig