-
Notifications
You must be signed in to change notification settings - Fork 234
Migrate the 'no_clip' parameter to the new alias system #4103
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.
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
Conversation
pygmt/src/contour.py
Outdated
| no_clip | ||
| Do **not** clip contours or image at the frame boundaries [Default is ``False`` | ||
| to fit inside ``region``]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am wondering to what "image" is refering here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It comes from the upstream documentation at https://docs.generic-mapping-tools.org/6.5/contour.html#n.
Here "image" is used because contour can color the triangles using a CPT. See the example below:
gmt begin map
gmt makecpt -Cseis -T600/1000/100
gmt basemap -R0.5/6/0.5/6 -JX10c/10c -Baf
gmt plot @Table_5_11.txt -Sc0.2c
gmt contour @Table_5_11.txt -Wthin -C -I -N -t50
gmt end show
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, thanks for the example 🙂!
Not really happy with this formulation, but do not have a good alternative.
Co-authored-by: Yvonne Fröhlich <[email protected]>
Co-authored-by: Yvonne Fröhlich <[email protected]>
Some wrappers have the
no_clipparameter, which can be either False or True. This PR migrates the parameter to the new alias system.no_clipinFigure.plotandFigure.plot3dare not updated in this PR, because in these two methods,no_clipcan be False, True,"c"or"r"and we need to discuss the long-form arguments for "c"/"r". So leave it to a separate PR instead.