pygmt.grdgradient: Add parameters 'normalize'/'norm_ambient'/'norm_amp'/'norm_sigma'/'norm_offset' for normalization #4365
+162
−70
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seisman
force-pushed
the
grdgradient/normalize
branch
from
c64f483 to
80afd26
Compare
seisman
changed the title
…p'/'norm_sigma'/'norm_offset' for normalization
seisman
force-pushed
the
grdgradient/normalize
branch
from
80afd26 to
c3d9ee3
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refactors the grdgradient function to provide a more Pythonic interface for the normalization option (-N in GMT). Instead of requiring users to provide GMT CLI-style strings, the PR introduces dedicated parameters for normalization control.
Changes:
- Adds new parameters
normalize,norm_amp,norm_ambient,norm_sigma, andnorm_offsettopygmt.grdgradientfor more intuitive normalization control - Implements backward compatibility by allowing the old GMT CLI string syntax while preventing mixed usage of old and new syntax
- Updates documentation to explain the new Pythonic parameter interface and mathematical formulas
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| pygmt/src/grdgradient.py | Adds helper function _alias_option_N to handle new normalization parameters and their conversion to GMT CLI format; updates function signature and documentation |
| pygmt/tests/test_grdgradient.py | Adds tests to verify that mixing old GMT syntax with new parameters raises appropriate errors |
| examples/gallery/images/grdgradient_shading.py | Updates example to demonstrate new Pythonic normalization syntax with normalize="cauchy"/"laplace" and norm_amp parameter |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
seisman
added
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of proposed changes
This PR provides a more Pythonic implementation for the -N option.
Preview: https://pygmt-dev--4365.org.readthedocs.build/en/4365/api/generated/pygmt.grdgradient.html
https://pygmt-dev--4365.org.readthedocs.build/en/4365/gallery/images/grdgradient_shading.html