diff --git a/doc/api/index.rst b/doc/api/index.rst index 4b42fef0b9f..6e543bb3cb7 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -127,7 +127,6 @@ Operations on tabular data blockmedian blockmode filter1d - grdmask nearneighbor project select @@ -157,6 +156,7 @@ Operations on raster data grdhisteq.equalize_grid grdhisteq.compute_bins grdlandmask + grdmask grdpaste grdproject grdsample diff --git a/pygmt/src/grdmask.py b/pygmt/src/grdmask.py index d1ad20e6bb8..d2262ef5aa2 100644 --- a/pygmt/src/grdmask.py +++ b/pygmt/src/grdmask.py @@ -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`. @@ -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