def test_grdview_grid_dataarray(xrgrid):
"""
Run grdview by passing in a grid as an xarray.DataArray.
"""
fig = Figure()
fig.grdview(grid=xrgrid)
return fig
def test_grdview_with_cmap_for_surface_monochrome_plot(xrgrid):
"""
Run grdview by passing in a grid and setting a colormap for producing a
surface monochrome plot.
"""
fig = Figure()
fig.grdview(grid=xrgrid, cmap="oleron", surftype="s+m")
return fig
def test_grdview_on_a_plane(xrgrid):
"""
Run grdview by passing in a grid and plotting it on a z-plane, while
setting a 3D perspective viewpoint.
"""
fig = Figure()
fig.grdview(grid=xrgrid, plane=100, perspective=[225, 30], zscale=0.005)
return fig
def test_grdview_grid_dataarray(gridfile, xrgrid):
"""
Run grdview by passing in a grid as an xarray.DataArray.
"""
fig_ref, fig_test = Figure(), Figure()
fig_ref.grdview(grid=gridfile)
fig_test.grdview(grid=xrgrid)
return fig_ref, fig_test
def test_grdview_with_cmap_for_image_plot(xrgrid):
"""
Run grdview by passing in a grid and setting a colormap for producing an
image plot.
"""
fig = Figure()
fig.grdview(grid=xrgrid, cmap="oleron", surftype="i")
return fig
def test_grdview_with_perspective_and_zsize(xrgrid):
"""
Run grdview by passing in a grid and setting a perspective viewpoint with
an azimuth from the SouthWest and an elevation angle 30 degrees from the
z-plane, plus a z-axis size of 10cm.
"""
fig = Figure()
fig.grdview(grid=xrgrid, perspective=[225, 30], zsize="10c")
return fig
def test_grdview_grid_file_with_region_subset(region):
"""
Run grdview by passing in a grid filename, and cropping it to a region.
"""
gridfile = which("@earth_relief_01d_g", download="a")
fig = Figure()
fig.grdview(grid=gridfile, region=region)
return fig
def test_grdview_on_a_plane_with_colored_frontal_facade(gridfile, xrgrid):
"""
Run grdview by passing in a grid and plotting it on a z-plane whose frontal
facade is colored gray, while setting a 3D perspective viewpoint.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(plane="-4000+ggray", perspective=[225, 30], zscale=0.005)
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_with_cmap_for_perspective_surface_plot(gridfile, xrgrid):
"""
Run grdview by passing in a grid and setting a colormap for producing a
surface plot with a 3D perspective viewpoint.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(cmap="oleron", surftype="s", perspective=[225, 30], zscale=0.005)
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_wrong_kind_of_grid(xrgrid):
"""
Run grdview using grid input that is not an xarray.DataArray or file.
"""
dataset = xrgrid.to_dataset() # convert xarray.DataArray to xarray.Dataset
assert data_kind(dataset) == "matrix"
fig = Figure()
with pytest.raises(GMTInvalidInput):
fig.grdview(grid=dataset)
def test_grdview_with_cmap_for_surface_monochrome_plot(gridfile, xrgrid):
"""
Run grdview by passing in a grid and setting a colormap for producing a
surface monochrome plot.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(cmap="oleron", surftype="s+m")
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_with_perspective(gridfile, xrgrid):
"""
Run grdview by passing in a grid and setting a perspective viewpoint with
an azimuth from the SouthEast and an elevation angle 15 degrees from the
z-plane.
"""
fig_ref, fig_test = Figure(), Figure()
fig_ref.grdview(grid=gridfile, perspective=[135, 15])
fig_test.grdview(grid=xrgrid, perspective=[135, 15])
return fig_ref, fig_test
def test_grdview_drapegrid_dataarray(xrgrid):
"""
Run grdview by passing in both a grid and drapegrid as an xarray.DataArray,
setting a colormap for producing an image plot.
"""
drapegrid = 1.1 * xrgrid
fig = Figure()
fig.grdview(grid=xrgrid, drapegrid=drapegrid, cmap="oleron", surftype="c")
return fig
def test_grdview_surface_mesh_plot_styled_with_meshpen(gridfile, xrgrid):
"""
Run grdview by passing in a grid with styled mesh lines plotted on top of a
surface mesh plot.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(cmap="relief", surftype="sm", meshpen="0.5p,black,dash")
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_on_a_plane(gridfile, xrgrid):
"""
Run grdview by passing in a grid and plotting it on a z-plane, while
setting a 3D perspective viewpoint.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(plane=-4000, perspective=[225, 30], zscale=0.005)
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_on_a_plane_with_colored_frontal_facade(xrgrid):
"""
Run grdview by passing in a grid and plotting it on a z-plane whose frontal
facade is colored gray, while setting a 3D perspective viewpoint.
"""
fig = Figure()
fig.grdview(grid=xrgrid,
plane="100+ggray",
perspective=[225, 30],
zscale=0.005)
return fig
def test_grdview_with_perspective_and_zsize(gridfile, xrgrid):
"""
Run grdview by passing in a grid and setting a perspective viewpoint with
an azimuth from the SouthWest and an elevation angle 30 degrees from the
z-plane, plus a z-axis size of 10cm.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(perspective=[225, 30], zsize="10c")
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_surface_mesh_plot_styled_with_meshpen(xrgrid):
"""
Run grdview by passing in a grid with styled mesh lines plotted on top of a
surface mesh plot.
"""
fig = Figure()
fig.grdview(grid=xrgrid,
cmap="relief",
surftype="sm",
meshpen="0.5p,black,dash")
return fig
def test_grdview_with_perspective(gridfile):
"""
Run grdview by passing in a grid and setting a perspective viewpoint with
an azimuth from the SouthEast and an elevation angle 15 degrees from the
z-plane.
"""
fig = Figure()
fig.grdview(grid=gridfile,
projection="Q15c+",
perspective=[135, 15],
frame=True)
return fig
def test_grdview_with_cmap_for_perspective_surface_plot(xrgrid):
"""
Run grdview by passing in a grid and setting a colormap for producing a
surface plot with a 3D perspective viewpoint.
"""
fig = Figure()
fig.grdview(grid=xrgrid,
cmap="oleron",
surftype="s",
perspective=[225, 30],
zscale=0.005)
return fig
def test_grdview_on_a_plane_styled_with_facadepen(gridfile, xrgrid):
"""
Run grdview by passing in a grid and plotting it on a z-plane with styled
lines for the frontal facade.
"""
fig_ref, fig_test = Figure(), Figure()
kwargs = dict(
plane=-4000, perspective=[225, 30], zscale=0.005, facadepen="0.5p,blue,dash"
)
fig_ref.grdview(grid=gridfile, **kwargs)
fig_test.grdview(grid=xrgrid, **kwargs)
return fig_ref, fig_test
def test_grdview_on_a_plane_styled_with_facadepen(xrgrid):
"""
Run grdview by passing in a grid and plotting it on a z-plane with styled
lines for the frontal facade.
"""
fig = Figure()
fig.grdview(
grid=xrgrid,
plane=100,
perspective=[225, 30],
zscale=0.005,
facadepen="0.5p,blue,dash",
)
return fig
def test_grdview_with_perspective_and_zaxis_frame(xrgrid, region):
"""
Run grdview by passing in a grid and plotting an annotated vertical z-axis
frame on a Transverse Mercator (T) projection.
"""
fig = Figure()
projection = f"T{(region[0]+region[1])/2}/{abs((region[2]+region[3])/2)}"
fig.grdview(
grid=xrgrid,
projection=projection,
perspective=[225, 30],
zscale=0.005,
frame=["xaf", "yaf", "zaf"],
)
return fig