Figure.grdview: Add parameters surftype/dpi/mesh_fill/nan_transparent/monochrome to control surfure types

[seisman]

This PR improves grdview's -Q option in a more Pythonic way by splitting it into multiple parameters:

• surftype
• dpi
• nan_transparent
• monochrome
• mesh_fill

Address #4208 (comment).

Example

import pygmt

grd_relief = pygmt.datasets.load_earth_relief(resolution="15m", region=[-25, -13, 63.2, 66.7])

args = dict(
    region=[-25, -13, 63.2, 66.7], 
    projection="M?", 
    perspective=(-150, 25),
    cmap="SCM/oleron",
    zsize="1.5c",
    plane="+ggray",
    panel=True,
)

fig = pygmt.Figure()
with fig.subplot(nrows=5, ncols=3, subsize=(5, 5), margins=(1, 0.2)):
    for surftype in ("surface", "mesh", "surface+mesh", "image", "waterfall_x", "waterfall_y"):
        fig.grdview(
            grid=grd_relief,
            frame=["xaf", "yaf", f"WSenZ+t{surftype}"],
            surftype=surftype,
            **args,
        )
    for surftype in ("surface", "mesh", "surface+mesh", "image", "waterfall_x", "waterfall_y"):
        fig.grdview(
            grid=grd_relief,
            frame=["xaf", "yaf", f"WSenZ+t{surftype}"],
            surftype=surftype,
            monochrome=True,
            **args,
        )
    for surtype in ("mesh", "waterfall_x", "waterfall_y"):
        fig.grdview(
            grid=grd_relief,
            frame=["xaf", "yaf", f"WSenZ+t{surftype}"],
            surftype=surftype,
            meshfill="red@50",
            **args,
        )
fig.show()

[weiji14]

Shouldn't +m be a suffix?

[seisman]

The full syntax is -Qc|i|m[x|y]|s[m][color][+m]. It's a suffix for the -Q option, but for monochrome, it's a prefix. Since monochrome is a boolean, monochrome would be +m, so here it makes no difference if +m is a prefix or a suffix.

[weiji14]

Ah right, got it now.

[weiji14]

Just a note that after the suffix feature is implemented in #4259, this +m does need to be a prefix, otherwise a list of values will be returned, xref #4259 (comment).

[weiji14]

Can you add a unit test to ensure that backwards compatibility is preserved when a user passes surftype="c", but did not set nan_transparent=True (which is added in this PR). The output grdview plot should still have NaN transparency.

[seisman]

Added in aa9eb73.

[github-actions]

Summary of changed images

This is an auto-generated report of images that have changed on the DVC remote

Status	Path
added	pygmt/tests/baseline/test_grdview_image_dpi.png
added	pygmt/tests/baseline/test_grdview_mesh_pen_and_mesh_fill.png
added	pygmt/tests/baseline/test_grdview_monochrome.png
added	pygmt/tests/baseline/test_grdview_surftype.png
deleted	pygmt/tests/baseline/test_grdview_with_cmap_for_image_plot.png
deleted	pygmt/tests/baseline/test_grdview_with_cmap_for_perspective_surface_plot.png
deleted	pygmt/tests/baseline/test_grdview_with_cmap_for_surface_monochrome_plot.png

Image diff(s)

Details

Added images

• test_grdview_image_dpi.png

• test_grdview_mesh_pen_and_mesh_fill.png

• test_grdview_monochrome.png

• test_grdview_surftype.png

Modified images

Path	Old	New

Report last updated at commit 13b00ee