Skip to content

pygmt.grdclip: Use the new alias system for parameters above/below/between/replace #4034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 1, 2025
Merged

pygmt.grdclip: Use the new alias system for parameters above/below/between/replace #4034

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions pygmt/src/grdclip.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

import xarray as xr
from pygmt._typing import PathLike
from pygmt.alias import Alias, AliasSystem
from pygmt.clib import Session
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import (
build_arg_list,
deprecate_parameter,
fmt_docstring,
kwargs_to_strings,
sequence_join,
use_alias,
)

Expand All @@ -23,9 +23,7 @@
# TODO(PyGMT>=0.19.0): Remove the deprecated "new" parameter.
@fmt_docstring
@deprecate_parameter("new", "replace", "v0.15.0", remove_version="v0.19.0")
@use_alias(
R="region", Sa="above-", Sb="below-", Si="between-", Sr="replace-", V="verbose"
)
@use_alias(R="region", V="verbose")
@kwargs_to_strings(R="sequence")
def grdclip(
grid: PathLike | xr.DataArray,
Expand Down Expand Up @@ -54,6 +52,10 @@ def grdclip(
Full GMT docs at :gmt-docs:`grdclip.html`.

{aliases}
- Sa=above
- Sb=below
- Si=between
- Sr=replace

Parameters
----------
Expand Down Expand Up @@ -113,19 +115,20 @@ def grdclip(
)
raise GMTInvalidInput(msg)

# Parse the -S option.
kwargs["Sa"] = sequence_join(above, size=2, name="above")
kwargs["Sb"] = sequence_join(below, size=2, name="below")
kwargs["Si"] = sequence_join(between, size=3, ndim=2, name="between")
kwargs["Sr"] = sequence_join(replace, size=2, ndim=2, name="replace")
aliasdict = AliasSystem(
Sa=Alias(above, name="above", sep="/", size=2),
Sb=Alias(below, name="below", sep="/", size=2),
Si=Alias(between, name="between", sep="/", size=3, ndim=2),
Sr=Alias(replace, name="replace", sep="/", size=2, ndim=2),
).merge(kwargs)

with Session() as lib:
with (
lib.virtualfile_in(check_kind="raster", data=grid) as vingrd,
lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd,
):
kwargs["G"] = voutgrd
aliasdict["G"] = voutgrd
lib.call_module(
module="grdclip", args=build_arg_list(kwargs, infile=vingrd)
module="grdclip", args=build_arg_list(aliasdict, infile=vingrd)
)
return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
Loading