Skip to content

pygmt.grdlandmask: Refactor to use the new alias system for bordervalues/maskvalues #4031

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 2 commits into from
Aug 1, 2025
Merged

pygmt.grdlandmask: Refactor to use the new alias system for bordervalues/maskvalues #4031

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7164163
pygmt.grdlandmask: Refactor to use the new alias system for borderval…
seisman Jul 30, 2025
070d8e8
bordervalues should be scalar or a sequence with 4 values
seisman Jul 31, 2025
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
17 changes: 10 additions & 7 deletions pygmt/src/grdlandmask.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

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,
fmt_docstring,
kwargs_to_strings,
sequence_join,
use_alias,
)
from pygmt.src._common import _parse_coastline_resolution
Expand All @@ -25,9 +25,7 @@
@use_alias(
A="area_thresh",
D="resolution-",
E="bordervalues-",
I="spacing",
N="maskvalues-",
R="region",
V="verbose",
r="registration",
Expand Down Expand Up @@ -55,6 +53,8 @@ def grdlandmask(
Full GMT docs at :gmt-docs:`grdlandmask.html`.

{aliases}
- E=bordervalues
- N=maskvalues

Parameters
----------
Expand Down Expand Up @@ -119,11 +119,14 @@ def grdlandmask(
raise GMTInvalidInput(msg)

kwargs["D"] = kwargs.get("D", _parse_coastline_resolution(resolution))
kwargs["N"] = sequence_join(maskvalues, size=(2, 5), name="maskvalues")
kwargs["E"] = sequence_join(bordervalues, size=(1, 4), name="bordervalues")

aliasdict = AliasSystem(
N=Alias(maskvalues, name="maskvalues", sep="/", size=(2, 5)),
E=Alias(bordervalues, name="bordervalues", sep="/", size=4),
).merge(kwargs)

with Session() as lib:
with lib.virtualfile_out(kind="grid", fname=outgrid) as voutgrd:
kwargs["G"] = voutgrd
lib.call_module(module="grdlandmask", args=build_arg_list(kwargs))
aliasdict["G"] = voutgrd
lib.call_module(module="grdlandmask", args=build_arg_list(aliasdict))
return lib.virtualfile_to_raster(vfname=voutgrd, outgrid=outgrid)
Loading