pygmt.grdclip

pygmt.grdclip(grid, **kwargs)[source]

Sets specific values, or values above/below a set number, to a given value.

Produce a new outgrid file clipped version of``grid``.

The parameters above and below allow for a given value to be set for values above or below a set amount, respectively. This allows for extreme values in a grid, such as points below a certain depth when plotting Earth relief, to all be set to the same value.

Full option list at https://docs.generic-mapping-tools.org/latest/grdclip.html

Aliases:

  • G = outgrid

  • R = region

  • Sa = above

  • Sb = below

  • Si = interval

  • Sr = old

  • V = verbose

Parameters

  • grid (str or xarray.DataArray) – The file name of the input grid or the grid loaded as a DataArray.

  • outgrid (str or None) – The name of the output netCDF file with extension .nc to store the grid in.

  • region (str or list) – Required if this is the first plot command. xmin/xmax/ymin/ymax[+r][+uunit]. Specify the region of interest.

  • above (str) – high/above. Set all data[i] > high to above.

  • below (str) – low/below. Set all data[i] < low to below.

  • interval (str) – low/high/between Set all data[i] >= low and <= high to between. Repeat the option for as many intervals as are needed.

  • old (str) – old/new Set all data[i] == old to new. This is mostly useful when your data are known to be integer values. Repeat the option for as many replacements as are needed.

  • verbose (bool or str) –

    Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity:

    • q - Quiet, not even fatal error messages are produced

    • e - Error messages only

    • w - Warnings [Default]

    • t - Timings (report runtimes for time-intensive algorithms);

    • i - Informational messages (same as verbose=True)

    • c - Compatibility warnings

    • d - Debugging messages