Uh oh!
There was an error while loading. Please reload this page.
Figure.grdview: Improve parameters plane/facade_fill/facade_pen to set the plane and facade - #4235
Conversation
Uh oh!
There was an error while loading. Please reload this page.
Summary of changed imagesThis is an auto-generated report of images that have changed on the DVC remote
Image diff(s)Report last updated at commit 178dd65 |
There was a problem hiding this comment.
Pull request overview
This PR improves the Figure.grdview method by refactoring how plane and facade parameters are handled. It migrates facadepen to the new alias system and splits the GMT -N option into two separate parameters (plane and facadefill) for better API clarity.
Key changes:
- Split the
planeparameter into two distinct parameters:planefor z-level specification andfacadefillfor facade fill color - Migrated
facadepenfrom the old@use_aliasdecorator to the newAliasSystem - Added automatic plane enabling when
facadefillorfacadepenis specified
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| pygmt/src/grdview.py | Updated function signature with new parameters, migrated to AliasSystem for -N and -Wf options, added auto-enable logic for plane |
| pygmt/tests/test_grdview.py | Updated existing test to use new API, added new test for facadepen with default plane |
| pygmt/tests/baseline/test_grdview_facadepen_default_plane.png.dvc | Added baseline image for new test case |
| examples/tutorials/advanced/draping_on_3d_surface.py | Updated examples to use new facadefill parameter instead of plane="+g..." syntax |
| examples/tutorials/advanced/3d_perspective_image.py | Updated examples and comments to use new facadefill parameter |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
seisman
commented
Dec 4, 2025
Changes in this PR will affect our Figure 3, so ping @yvonnefroehlich for a review. |
…e_pen, meshpen->mesh_pen (Will be removed in v0.20.0)
3a637e5 to
2c13607Compare…o set the plane and facade
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
Uh oh!
There was an error while loading. Please reload this page.
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
Uh oh!
There was an error while loading. Please reload this page.

This PR splits the
-Noption into two parameters,planefor setting the z-level andfacade_fillfor setting the fill for facade.Preview: https://pygmt-dev--4235.org.readthedocs.build/en/4235/api/generated/pygmt.Figure.grdview.html#pygmt.Figure.grdview
Related to #4208