Skip to content

Commit 1b54365

Browse files
Add first version of intro text
1 parent 3403501 commit 1b54365

1 file changed

Lines changed: 10 additions & 4 deletions

File tree

examples/gallery/images/grdmask.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
"""
2-
Create grid masks from geospatial shapes
3-
========================================
4-
:func:`pygmt.grdmask`.
2+
Create grid masks from spatial shapes
3+
=====================================
54
6-
:func:`pygmt.grdlandmask` and gallery example https://www.pygmt.org/latest/gallery/images/grdlandmask.html.
5+
The functionn :func:`pygmt.grdmask` allows to create a grid mask based on spatial
6+
shapes given as closed polygons. These polygons can be provided as NumPy arrays or
7+
GeoPandas DataFrame. For the nodes falling inside, outside, and on the edges, different
8+
values can be defined. The create mask can then be applied to a desired grid.
9+
10+
To create a land-water mask based on the GMT built-in shoreline data you can directly
11+
use the function :func:`pygmt.grdlandmask` explained in the gallery example
12+
:doc:` Create 'wet-dry' mask grid </gallery/images/gradlandmask>`.
713
"""
814

915
# %%

0 commit comments

Comments
 (0)