Skip to content

Commit 69c7de2

Browse files
committed
add additional parameters to docstring
1 parent af35c58 commit 69c7de2

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

pygmt/src/grdclip.py

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,34 @@ def grdclip(grid, **kwargs):
3434
for values above or below a set amount, respectively. This allows for
3535
extreme values in a grid, such as points below a certain depth when
3636
plotting Earth relief, to all be set to the same value.
37-
subregion is specified with ``region``; the specified range must not exceed
38-
the range of ``grid`` (but see ``extend``). If in doubt, run
39-
:meth:`pygmt.grdinfo` to check range. Alternatively, define the subregion
40-
indirectly via a range check on the node values or via distances from a
41-
given point. Finally, you can give ``projection`` for oblique projections
42-
to determine the corresponding rectangular ``region`` that will give a grid
43-
that fully covers the oblique domain.
4437
45-
Full option list at :gmt-docs:`grdcut.html`
38+
Full option list at :gmt-docs:`grdclip.html`
4639
4740
{aliases}
41+
Parameters
42+
----------
43+
grid : str or xarray.DataArray
44+
The file name of the input grid or the grid loaded as a DataArray.
45+
outgrid : str or None
46+
The name of the output netCDF file with extension .nc to store the grid
47+
in.
48+
{R}
49+
above : str
50+
*high/above*.
51+
Set all data[i] > *high* to *above*.
52+
below : str
53+
*low/below*.
54+
Set all data[i] < *low* to *below*.
55+
interval : str
56+
*low/high/between*
57+
Set all data[i] >= *low* and <= *high* to *between*.
58+
Repeat the option for as many intervals as are needed.
59+
old: str
60+
*old/new*
61+
Set all data[i] == *old* to *new*. This is mostly useful when
62+
your data are known to be integer values. Repeat the option
63+
for as many replacements as are needed.
64+
{V}
4865
"""
4966
with GMTTempFile(suffix=".nc") as tmpfile:
5067
with Session() as lib:

0 commit comments

Comments
 (0)