Skip to content

Add inline example for grdclip #1711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 2, 2022
Merged
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
20 changes: 20 additions & 0 deletions pygmt/src/grdclip.py
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,26 @@ def grdclip(grid, **kwargs):
- :class:`xarray.DataArray` if ``outgrid`` is not set
- None if ``outgrid`` is set (grid output will be stored in file set by
``outgrid``)

Examples
--------
>>> import pygmt # doctest: +SKIP
>>> # Load a grid of @earth_relief_30m data, with an x-range of 10 to 30,
>>> # and a y-range of 15 to 25
>>> grid = pygmt.datasets.load_earth_relief(
... resolution="30m", region=[10, 30, 15, 25]
... ) # doctest: +SKIP
>>> # Report the minimum and maximum data values
>>> [grid.data.min(), grid.data.max()] # doctest: +SKIP
[179.0, 2103.0]
>>> # Create a new grid from an input grid. Set all values below 1,000 to
>>> # 0 and all values above 1,500 to 10,000
>>> new_grid = pygmt.grdclip(
... grid=grid, below=[1000, 0], above=[1500, 10000]
... ) # doctest: +SKIP
>>> # Report the minimum and maximum data values
>>> [new_grid.data.min(), new_grid.data.max()] # doctest: +SKIP
[0.0, 10000.0]
"""
with GMTTempFile(suffix=".nc") as tmpfile:
with Session() as lib:
Expand Down