You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Figure.shift_origin method is a high-level wrapper for GMT's common option -X/-Y. With this method, we should disallow -X/-Y option in all plotting methods.
As mentioned in the upstream issue GenericMappingTools/gmt#7296, -Xc and -Xf make no sense in modern mode. So, we only focus on -Xr (the same as -X) and -Xa in PyGMT.
-Xr: move the origin relative to its current location.
-Xa: move the origin relative to its current location, and move the origin back to the original position after plotting
The following GMT bash script shows the behavior of -Xr and -Xa:
gmt begin
for mode in "r" "a"; do
echo "Shift plotting origin with -X${mode}10c"
gmt figure shift-X${mode}10c png
gmt basemap -R0/10/0/10 -JX10c -Baf -B+tFrame1
gmt basemap -R0/10/0/10 -JX10c -Baf -B+tFrame2 -X${mode}10c
gmt basemap -R0/5/0/5 -JX5c -Baf -B+tFrame3
done
gmt end show
-Xr
-Xa
Implementation of Figure.shift_origin
The Figure.shift_origin method should support both -Xr (shifting origins permanently) and -Xa (shiftiing origins temporarily). So, the most intuitive syntax is:
# Permanently shift the plotting origin
Figure.shift_origin(xshift="1c")
# Temporarily shift the plotting origin
with Figure.shift_origin(xshift="1c"):
...
...
seisman
changed the title
Figure.shift_origin: Allow shifting the origin back to the original position after plotting
Figure.shift_origin: Shifting plotting origins
Feb 19, 2025
I feel the Figure.shift_origin documentation https://www.pygmt.org/dev/api/generated/pygmt.Figure.shift_origin.html is good enough and we also have many gallery examples that calls Figure.shift_origin, so a separate tutorial or gallery example is not necessary. So I'm closing this issue, and move Figure.shift_origin to "ongoing maintainence" category in the project board (PyGMT: Wrapping GMT modules).
The
Figure.shift_origin
method is a high-level wrapper for GMT's common option-X
/-Y
. With this method, we should disallow-X
/-Y
option in all plotting methods.The syntax of
-X
/-Y
The full syntax of GMT's
-X
and-Y
options is (https://docs.generic-mapping-tools.org/dev/gmt.html#xy-full):-X[a|c|f|r][xshift]
As mentioned in the upstream issue GenericMappingTools/gmt#7296,
-Xc
and-Xf
make no sense in modern mode. So, we only focus on-Xr
(the same as-X
) and-Xa
in PyGMT.-Xr
: move the origin relative to its current location.-Xa
: move the origin relative to its current location, and move the origin back to the original position after plottingThe following GMT bash script shows the behavior of
-Xr
and-Xa
:-Xr
-Xa
Implementation of
Figure.shift_origin
The
Figure.shift_origin
method should support both-Xr
(shifting origins permanently) and-Xa
(shiftiing origins temporarily). So, the most intuitive syntax is:Issues to track
Figure.shift_origin()
Add a new method to shift plot origins #289with Figure.shift_origin(): ...
Figure.shift_origin: Support shifting origins temporarily when used as a context manager #2509The text was updated successfully, but these errors were encountered: