pygmt.grdproject: Migrate the dpi/unit/scaling/inverse parameters to the new alias system

Author: seisman

pygmt/src/grdproject.py

@@ -16,12 +16,16 @@
 
 
 @fmt_docstring
-@use_alias(E="dpi", F="scaling", I="inverse", M="unit", n="interpolation")
-def grdproject(
+@use_alias(n="interpolation")
+def grdproject(  # noqa: PLR0913
     grid: PathLike | xr.DataArray,
     outgrid: PathLike | None = None,
     center: Sequence[float | str] | bool = False,
     spacing: float | str | Sequence[float | str] | None = None,
+    dpi: int | None = None,
+    inverse: bool = False,
+    unit: Literal["c", "i", "p"] | None = None,
+    scaling: Literal["c", "i", "p", "e", "f", "k", "M", "n", "u"] | bool = False,
     projection: str | None = None,
     region: Sequence[float | str] | str | None = None,
     registration: Literal["gridline", "pixel"] | bool = False,
@@ -32,27 +36,30 @@ def grdproject(
     r"""
     Forward and inverse map transformation of grids.
 
-    This method will project a geographical gridded data set onto a
-    rectangular grid. If ``inverse`` is ``True``, it will project a
-    rectangular coordinate system to a geographic system. To obtain the value
-    at each new node, its location is inversely projected back onto the input
-    grid after which a value is interpolated between the surrounding input
-    grid values. By default bi-cubic interpolation is used. Aliasing is
-    avoided by also forward projecting the input grid nodes. If two or more
-    nodes are projected onto the same new node, their average will dominate in
-    the calculation of the new node value. Interpolation and aliasing is
-    controlled with the ``interpolation`` parameter. The new node spacing may
-    be determined in one of several ways by specifying the grid spacing,
-    number of nodes, or resolution. Nodes not constrained by input data are
-    set to NaN. The ``region`` parameter can be used to select a map region
-    large or smaller than that implied by the extent of the grid file.
+    This method will project a geographical gridded data set onto a rectangular grid. If
+    ``inverse`` is ``True``, it will project a rectangular coordinate system to a
+    geographic system. To obtain the value at each new node, its location is inversely
+    projected back onto the input grid after which a value is interpolated between the
+    surrounding input grid values. By default bi-cubic interpolation is used. Aliasing
+    is avoided by also forward projecting the input grid nodes. If two or more nodes are
+    projected onto the same new node, their average will dominate in the calculation of
+    the new node value. Interpolation and aliasing is controlled with the
+    ``interpolation`` parameter. The new node spacing may be determined in one of
+    several ways by specifying the grid spacing, number of nodes, or resolution. Nodes
+    not constrained by input data are set to NaN. The ``region`` parameter can be used
+    to select a map region large or smaller than that implied by the extent of the grid
+    file.
 
     Full GMT docs at :gmt-docs:`grdproject.html`.
 
     $aliases
        - C = center
        - D = spacing
+       - E = dpi
+       - F = scaling
+       - I = inverse
        - J = projection
+       - M = unit
        - R = region
        - V = verbose
        - r = registration
@@ -61,32 +68,31 @@ def grdproject(
     ----------
     $grid
     $outgrid
-    inverse : bool
-        When set to ``True`` transforms grid from rectangular to geographical
-        [Default is ``False``].
-    $projection
-    $region
     center
         If ``True``, let the projected coordinates be relative to the projection center
         [Default is relative to the lower left corner]. Optionally, set offsets
         (*dx*, *dy*) in the projected units to be added (or subtracted when ``inverse``
         is set) to (from) the projected coordinates, such as false eastings and
         northings for particular projection zones [Default is ``(0, 0)``].
     $spacing
-    dpi : int
+    dpi
         Set the resolution for the new grid in dots per inch.
-    scaling : str
-        [**c**\|\ **i**\|\ **p**\|\ **e**\|\ **f**\|\
-        **k**\|\ **M**\|\ **n**\|\ **u**].
-        Force 1:1 scaling, i.e., output or input data are in actual projected
-        meters [**e**]. To specify other units, append **f** (feet),
+    inverse
+        When set to ``True``, do the inverse transformation, from rectangular to
+        geographical [Default is ``False``].
+    unit
+        Set the projected measure unit. Valid values are ``"c"`` for centimeters,
+        ``"i"`` for inches, and ``"p"`` for points [Default is set by
+        :gmt-term:`PROJ_LENGTH_UNIT`]. Cannot be used with ``scaling``.
+    scaling
+        Force 1:1 scaling, i.e., output (or input, see ``inverse``) data are in actual
+        projected meters. To specify other units, set it to **f** (feet),
         **k** (kilometers), **M** (statute miles), **n** (nautical miles),
-        **u** (US survey feet), **i** (inches), **c** (centimeters), or
-        **p** (points).
-    unit : str
-        Append **c**, **i**, or **p** to indicate that centimeters, inches, or
-        points should be the projected measure unit. Cannot be used with
-        ``scaling``.
+        **u** (US survey feet), **i** (inches), **c** (centimeters), or **p** (points).
+        Without ``scaling``, the output (or input, see ``inverse``) are in the units
+        specified by :gmt-term:`PROJ_LENGTH_UNIT` (but see ``unit``).
+    $projection
+    $region
     $verbose
     $interpolation
     $registration
@@ -117,6 +123,10 @@ def grdproject(
     aliasdict = AliasSystem(
         C=Alias(center, name="center", sep="/", size=2),
         D=Alias(spacing, name="spacing", sep="/", size=2),
+        E=Alias(dpi, name="dpi"),
+        F=Alias(scaling, name="scaling"),
+        I=Alias(inverse, name="inverse"),
+        M=Alias(unit, name="unit"),
     ).add_common(
         J=projection,
         R=region,