Skip to content
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.

Sign up for GitHub

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

Use xarray.testing rather than pygmt.grdinfo in grdcut tests #1574

Merged
merged 5 commits into from
Oct 12, 2021
Merged

Use xarray.testing rather than pygmt.grdinfo in grdcut tests #1574

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
44e26b8
Use xarray.testing rather than pygmt.grdinfo in grdcut tests
maxrjones Oct 5, 2021
1673fd9
Update pygmt/tests/test_grdcut.py
maxrjones Oct 7, 2021
a90ebd3
Apply suggestions from code review
maxrjones Oct 9, 2021
f569a46
Merge branch 'main' into tests-grdinfo-grdcut
maxrjones Oct 12, 2021
1d6045c
Merge branch 'main' into tests-grdinfo-grdcut
maxrjones Oct 12, 2021
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
65 changes: 31 additions & 34 deletions pygmt/tests/test_grdcut.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
import numpy as np
import pytest
import xarray as xr
from pygmt import grdcut, grdinfo
from pygmt import grdcut, load_dataarray
from pygmt.datasets import load_earth_relief
from pygmt.exceptions import GMTInvalidInput
from pygmt.helpers import GMTTempFile
Expand All @@ -20,67 +20,64 @@ def fixture_grid():
return load_earth_relief(registration="pixel")


def test_grdcut_file_in_file_out():
@pytest.fixture(scope="module", name="expected_grid")
def fixture_grid_result():
"""
Load the expected grdhisteq grid result.
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
"""
return xr.DataArray(
data=[
[-5069.5, -5105.0, -4937.0, -4708.0],
[-4115.5, -4996.0, -4762.0, -4599.0],
[-656.0, -160.0, -3484.5, -3897.5],
],
coords=dict(lon=[-2.5, -1.5, -0.5, 0.5], lat=[2.5, 3.5, 4.5]),
dims=["lat", "lon"],
)


def test_grdcut_file_in_file_out(expected_grid):
"""
grdcut an input grid file, and output to a grid file.
"""
with GMTTempFile(suffix=".nc") as tmpfile:
result = grdcut("@earth_relief_01d", outgrid=tmpfile.name, region="0/180/0/90")
result = grdcut("@earth_relief_01d", outgrid=tmpfile.name, region="-3/1/2/5")
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
assert result is None # return value is None
assert os.path.exists(path=tmpfile.name) # check that outgrid exists
result = grdinfo(tmpfile.name, per_column=True)
assert result == "0 180 0 90 -8182 5651.5 1 1 180 90 1 1\n"
temp_grid = load_dataarray(tmpfile.name)
xr.testing.assert_allclose(a=temp_grid, b=expected_grid)


def test_grdcut_file_in_dataarray_out():
def test_grdcut_file_in_dataarray_out(expected_grid):
"""
grdcut an input grid file, and output as DataArray.
"""
outgrid = grdcut("@earth_relief_01d", region="0/180/0/90")
outgrid = grdcut("@earth_relief_01d", region="-3/1/2/5")
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
assert isinstance(outgrid, xr.DataArray)
assert outgrid.gmt.registration == 1 # Pixel registration
assert outgrid.gmt.gtype == 1 # Geographic type
# check information of the output grid
# the '@earth_relief_01d' is in pixel registration, so the grid range is
# not exactly 0/180/0/90
assert outgrid.coords["lat"].data.min() == 0.5
assert outgrid.coords["lat"].data.max() == 89.5
assert outgrid.coords["lon"].data.min() == 0.5
assert outgrid.coords["lon"].data.max() == 179.5
assert outgrid.data.min() == -8182.0
assert outgrid.data.max() == 5651.5
assert outgrid.sizes["lat"] == 90
assert outgrid.sizes["lon"] == 180
xr.testing.assert_allclose(a=outgrid, b=expected_grid)


def test_grdcut_dataarray_in_file_out(grid):
def test_grdcut_dataarray_in_file_out(grid, expected_grid):
"""
grdcut an input DataArray, and output to a grid file.
"""
with GMTTempFile(suffix=".nc") as tmpfile:
result = grdcut(grid, outgrid=tmpfile.name, region="0/180/0/90")
result = grdcut(grid, outgrid=tmpfile.name, region="-3/1/2/5")
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
assert result is None # grdcut returns None if output to a file
result = grdinfo(tmpfile.name, per_column=True)
assert result == "0 180 0 90 -8182 5651.5 1 1 180 90 1 1\n"
temp_grid = load_dataarray(tmpfile.name)
xr.testing.assert_allclose(a=temp_grid, b=expected_grid)


def test_grdcut_dataarray_in_dataarray_out(grid):
def test_grdcut_dataarray_in_dataarray_out(grid, expected_grid):
"""
grdcut an input DataArray, and output as DataArray.
"""
outgrid = grdcut(grid, region="0/180/0/90")
outgrid = grdcut(grid, region="-3/1/2/5")
maxrjones marked this conversation as resolved.
Show resolved Hide resolved
assert isinstance(outgrid, xr.DataArray)
# check information of the output grid
# the '@earth_relief_01d' is in pixel registration, so the grid range is
# not exactly 0/180/0/90
assert outgrid.coords["lat"].data.min() == 0.5
assert outgrid.coords["lat"].data.max() == 89.5
assert outgrid.coords["lon"].data.min() == 0.5
assert outgrid.coords["lon"].data.max() == 179.5
assert outgrid.data.min() == -8182.0
assert outgrid.data.max() == 5651.5
assert outgrid.sizes["lat"] == 90
assert outgrid.sizes["lon"] == 180
xr.testing.assert_allclose(a=outgrid, b=expected_grid)


def test_grdcut_fails():
Expand Down