Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion doc/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,6 @@ Operations on tabular data
blockmedian
blockmode
filter1d
grdmask
nearneighbor
project
select
Expand Down Expand Up @@ -157,6 +156,7 @@ Operations on raster data
grdhisteq.equalize_grid
grdhisteq.compute_bins
grdlandmask
grdmask
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

grdmask operates on tabular data and produces grid data. I think the old version is correct

grdpaste
grdproject
grdsample
Expand Down
16 changes: 8 additions & 8 deletions pygmt/src/grdmask.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,14 +128,14 @@ def grdmask(
"""
Create mask grid from polygons or point coverage.

Reads one or more files containing polygon or data point coordinates, and creates a
grid where nodes that fall inside, on the edge, or outside the polygons (or within
the search radius from data points) are assigned values based on the ``outside``,
``edge``, and ``inside`` parameters.
Takes one or more polygons or data point coordinates, and creates a grid where nodes
that fall inside, on the edge, or outside the polygons or within the search radius
from data points are assigned values based on the ``outside``, ``edge``, and
``inside`` parameters.

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.
The mask grid can be used to mask out specific regions from another grid. For
masking based on coastline features, consider using :func:`pygmt.grdlandmask`
instead.

Full GMT docs at :gmt-docs:`grdmask.html`.

Expand All @@ -156,7 +156,7 @@ def grdmask(
Pass in either a file name to an ASCII data table, a 2-D $table_classes
containing the polygon(s) or data points. Input can be:

- **Polygon mode**: One or more files containing closed polygon coordinates
- **Polygon mode**: One or more polygons with closed coordinates
- **Point coverage mode**: Data points (used with ``search_radius`` parameter)
$outgrid
$spacing
Expand Down
Loading