Skip to content

Wrap grdmask for creating mask grid from polygons or point coverage#4463

Merged
seisman merged 103 commits intomainfrom
grdmask1
Apr 4, 2026
Merged

Wrap grdmask for creating mask grid from polygons or point coverage#4463
seisman merged 103 commits intomainfrom
grdmask1

Conversation

@Chuan1937
Copy link
Copy Markdown
Member

@Chuan1937 Chuan1937 commented Mar 21, 2026 •
edited by seisman
Loading

Chuan1937 and others added 30 commits February 25, 2026 20:55
@Chuan1937
add grdmask for required arguments
dd3abe1
@Chuan1937
Merge branch 'main' into grdmask1
67da3c5
@Chuan1937
add grdmask doc api
caedc1a
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
44d969c 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
fdee109 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
change grdmask category
7f0ddff
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
68123cf 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
show the value of mask
e70ca8c
@Chuan1937
change parameter name from mask_values to outside, edge, inside.
1b0e057
@Chuan1937
reset the N parameter
7a166e9
@Chuan1937
set a private function
da0cc55
@Chuan1937
Merge branch 'main' into grdmask1
d9b3478
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
6302abe 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
1d6d753 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
delete docs
d4293de
@Chuan1937
fix type error
a0ded64
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
871bcff 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
a0519e6 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
simplified code logic
7d98d67
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
ad23794 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
8e2a998 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
check output
21b543d
@Chuan1937
Merge branch 'main' into grdmask1
115733d
@Chuan1937
Merge branch 'main' into grdmask1
68e654f
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
53b3346 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
8e9a3b6 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
2a19936 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
Merge branch 'main' into grdmask1
09bf961
@Chuan1937
fix format
813b8e2
@Chuan1937
fix static type error
1eb9667
seisman
seisman reviewed Apr 3, 2026
View reviewed changes
Chuan1937 and others added 4 commits April 3, 2026 19:53
@Chuan1937 @seisman
Update pygmt/tests/test_grdmask.py
f8c6388 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/tests/test_grdmask.py
83e05f4 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937 @seisman
Update pygmt/tests/test_grdmask.py
5b09e87 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
update test_grdmask.py
9b6a852
seisman
seisman reviewed Apr 3, 2026
View reviewed changes
seisman
seisman approved these changes Apr 3, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks.

@seisman seisman requested a review from Copilot April 3, 2026 12:31
@seisman seisman mentioned this pull request Apr 3, 2026
Closed
26 tasks
@Chuan1937 @seisman
Update pygmt/src/grdmask.py
5b07849 
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@Chuan1937
Copy link
Copy Markdown
Member Author

Chuan1937 commented Apr 3, 2026

Looks great! Thanks.

Thank you for your guidance.

Copilot AI reviewed Apr 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Chuan1937 and others added 2 commits April 3, 2026 20:37
@Chuan1937
Update pygmt/src/grdmask.py
8896beb 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Chuan1937
Fix typo in comment for edge parameter handling
6cb7a73
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Apr 3, 2026
yvonnefroehlich
yvonnefroehlich reviewed Apr 4, 2026
View reviewed changes
yvonnefroehlich
yvonnefroehlich reviewed Apr 4, 2026
View reviewed changes
@seisman 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 seisman merged commit 538d006 into main Apr 4, 2026
20 of 23 checks passed
@seisman seisman deleted the grdmask1 branch April 4, 2026 13:19
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Apr 4, 2026
yvonnefroehlich
yvonnefroehlich reviewed Apr 9, 2026
View reviewed changes
pygmt/src/grdmask.py
Comment on lines +136 to +138
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.
Copy link
Copy Markdown
Member

@yvonnefroehlich yvonnefroehlich Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far pygmt.grdmath is not available / wrapped.

Copy link
Copy Markdown
Member

@seisman seisman Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, please fix it.

Copy link
Copy Markdown
Member

@yvonnefroehlich yvonnefroehlich Apr 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See #4524

@yvonnefroehlich yvonnefroehlich mentioned this pull request Apr 9, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seisman seisman seisman approved these changes

@yvonnefroehlich yvonnefroehlich yvonnefroehlich left review comments

Copilot code review Copilot Copilot left review comments

Assignees

@Chuan1937 Chuan1937

Labels

feature Brand new feature

Projects

None yet

Milestone

0.19.0

Development

Successfully merging this pull request may close these issues.

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

4 participants

@Chuan1937 @seisman @yvonnefroehlich