Wrap grdmask for creating mask grid from polygons or point coverage by Chuan1937 · Pull Request #4463 · GenericMappingTools/pygmt

Chuan1937 · 2026-03-21T08:51:06Z

Preview: https://pygmt-dev--4463.org.readthedocs.build/en/4463/api/generated/pygmt.grdmask.html

Related to #4427.

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

pygmt/tests/test_grdmask.py

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

pygmt/src/grdmask.py

seisman

Looks great! Thanks.

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Chuan1937 · 2026-04-03T12:34:07Z

Looks great! Thanks.

Thank you for your guidance.

Copilot

Pull request overview

Adds a new pygmt.grdmask wrapper (and corresponding API/docs/tests) to generate mask grids from polygon/point inputs, aligning PyGMT functionality with GMT’s grdmask module and addressing the “required arguments” behavior discussed in #4427.

Changes:

Implement pygmt.grdmask wrapper with -N option construction via a dedicated _alias_option_N helper.
Add a new test module pygmt/tests/test_grdmask.py covering outgrid vs in-memory returns and several -N behaviors.
Export grdmask at the package level and include it in the API docs index.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
pygmt/src/grdmask.py	New `grdmask` implementation and `-N` option alias helper.
pygmt/tests/test_grdmask.py	New unit tests for `grdmask` output, metadata, and selected option behaviors.
pygmt/src/init.py	Re-export `grdmask` from `pygmt.src`.
pygmt/init.py	Expose `grdmask` at the top-level `pygmt` namespace.
doc/api/index.rst	Add `grdmask` to the autosummary API listing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pygmt/tests/test_grdmask.py

pygmt/src/grdmask.py

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

pygmt/src/grdmask.py

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

…grdmask1

yvonnefroehlich · 2026-04-09T13:38:01Z

pygmt/src/grdmask.py

+    The mask grid can be used to mask out specific regions in other grids using
+    :func:`pygmt.grdmath` or similar tools. For masking based on coastline features,
+    consider using :func:`pygmt.grdlandmask` instead.


So far pygmt.grdmath is not available / wrapped.

Yes, please fix it.

Chuan1937 and others added 30 commits February 25, 2026 20:55

add grdmask for required arguments

dd3abe1

Merge branch 'main' into grdmask1

67da3c5

add grdmask doc api

caedc1a

Update pygmt/src/grdmask.py

44d969c

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdmask.py

fdee109

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

change grdmask category

7f0ddff

Update pygmt/src/grdmask.py

68123cf

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

show the value of mask

e70ca8c

change parameter name from mask_values to outside, edge, inside.

1b0e057

reset the N parameter

7a166e9

set a private function

da0cc55

Merge branch 'main' into grdmask1

d9b3478

Update pygmt/src/grdmask.py

6302abe

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdmask.py

1d6d753

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

delete docs

d4293de

fix type error

a0ded64

Update pygmt/src/grdmask.py

871bcff

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdmask.py

a0519e6

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

simplified code logic

7d98d67

Update pygmt/src/grdmask.py

ad23794

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdmask.py

8e2a998

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

check output

21b543d

Merge branch 'main' into grdmask1

115733d

Merge branch 'main' into grdmask1

68e654f

Update pygmt/src/grdmask.py

53b3346

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdmask.py

8e9a3b6

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/src/grdmask.py

2a19936

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Merge branch 'main' into grdmask1

09bf961

fix format

813b8e2

fix static type error

1eb9667

seisman reviewed Apr 3, 2026

View reviewed changes

Chuan1937 and others added 4 commits April 3, 2026 19:53

Update pygmt/tests/test_grdmask.py

f8c6388

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/tests/test_grdmask.py

83e05f4

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Update pygmt/tests/test_grdmask.py

5b09e87

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

update test_grdmask.py

9b6a852

seisman reviewed Apr 3, 2026

View reviewed changes

pygmt/src/grdmask.py Outdated Show resolved Hide resolved

seisman approved these changes Apr 3, 2026

View reviewed changes

seisman requested a review from Copilot April 3, 2026 12:31

seisman removed the status in PyGMT: Wrapping GMT modules Apr 3, 2026

Copilot started reviewing on behalf of seisman April 3, 2026 12:32 View session

seisman mentioned this pull request Apr 3, 2026

pygmt.grdmask: Create mask grid from polygons or point coverage #4427

Closed

26 tasks

Update pygmt/src/grdmask.py

5b07849

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>

Copilot AI reviewed Apr 3, 2026

View reviewed changes

pygmt/tests/test_grdmask.py Show resolved Hide resolved

pygmt/src/grdmask.py Show resolved Hide resolved

pygmt/src/grdmask.py Show resolved Hide resolved

pygmt/src/grdmask.py Outdated Show resolved Hide resolved

pygmt/src/grdmask.py Show resolved Hide resolved

Chuan1937 and others added 2 commits April 3, 2026 20:37

Update pygmt/src/grdmask.py

8896beb

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Fix typo in comment for edge parameter handling

6cb7a73

seisman added the final review call This PR requires final review and approval from a second reviewer label Apr 3, 2026

yvonnefroehlich reviewed Apr 4, 2026

View reviewed changes

pygmt/src/grdmask.py Show resolved Hide resolved

pygmt/src/grdmask.py Show resolved Hide resolved

pygmt/src/grdmask.py Outdated Show resolved Hide resolved

yvonnefroehlich reviewed Apr 4, 2026

View reviewed changes

pygmt/src/grdmask.py Show resolved Hide resolved

seisman and others added 4 commits April 4, 2026 20:13

Apply suggestions from code review

5f5ad7a

Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>

fix docstring

cf2e70b

Merge branch 'grdmask1' of github.com:GenericMappingTools/pygmt into …

de4ded9

…grdmask1

Merge branch 'main' into grdmask1

2e1db9b

seisman changed the title ~~pygmt.grdmask: Create mask grid from polygons or point coverage(required arguments)~~ Wrap grdmask for creating mask grid from polygons or point coverage Apr 4, 2026

seisman merged commit 538d006 into main Apr 4, 2026
20 of 23 checks passed

seisman deleted the grdmask1 branch April 4, 2026 13:19

seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 4, 2026

yvonnefroehlich reviewed Apr 9, 2026

View reviewed changes

yvonnefroehlich mentioned this pull request Apr 9, 2026

DOC: Improve docs of grdmask #4524

Open

seisman removed this from PyGMT: Wrapping GMT modules Apr 10, 2026

Conversation

Chuan1937 commented Mar 21, 2026 • edited by seisman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

seisman left a comment

Choose a reason for hiding this comment

Uh oh!

Chuan1937 commented Apr 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

yvonnefroehlich Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

seisman Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

yvonnefroehlich Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Chuan1937 commented Mar 21, 2026 •

edited by seisman

Loading