@@ -34,17 +34,34 @@ def grdclip(grid, **kwargs):
34
34
for values above or below a set amount, respectively. This allows for
35
35
extreme values in a grid, such as points below a certain depth when
36
36
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.
44
37
45
- Full option list at :gmt-docs:`grdcut .html`
38
+ Full option list at :gmt-docs:`grdclip .html`
46
39
47
40
{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}
48
65
"""
49
66
with GMTTempFile (suffix = ".nc" ) as tmpfile :
50
67
with Session () as lib :
0 commit comments