Skip to content

Commit 6c49a3d

Browse files
authored
Standardize figure/map/plot terminology in codes and docs [Part 1] (#4418)
1 parent ef31cd7 commit 6c49a3d

19 files changed

Lines changed: 45 additions & 44 deletions

File tree

doc/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ All plotting is handled through the :class:`pygmt.Figure` class and its methods.
1818

1919
Figure
2020

21-
Plotting map elements
22-
~~~~~~~~~~~~~~~~~~~~~
21+
Plotting figure elements
22+
~~~~~~~~~~~~~~~~~~~~~~~~
2323

2424
.. autosummary::
2525
:toctree: generated

examples/gallery/3d_plots/scatter3d.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
fill=df.species.cat.codes.astype(int),
8080
# Use colormap created by makecpt
8181
cmap=True,
82-
# Set map dimensions (xmin, xmax, ymin, ymax, zmin, zmax)
82+
# Set plot dimensions (xmin, xmax, ymin, ymax, zmin, zmax)
8383
region=region,
8484
# Set frame parameters
8585
frame=Frame(

examples/intro/03_figure_element.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
77
- :meth:`pygmt.Figure()`: having a number of plotting methods. Every new
88
figure must start with the creation of a :meth:`pygmt.Figure()` instance
9-
- ``frame``: setting plot or map boundaries (a combination of the single
9+
- ``frame``: setting plot boundaries (a combination of the single
1010
letters of **WSNE**, **wsne**, or **lbtr**), adding annotations, ticks,
1111
gridlines (**afg**), axis labels (**+l**), and title (**+t**), e.g.,
1212
in :meth:`pygmt.Figure.basemap`. Detailed examples can be found at
@@ -68,9 +68,9 @@
6868
fig.plot(x=2, y=15, style="c0.5c", pen="2p,darkblue")
6969
fig.text(x=2, y=17, text="Grid", **mainexplain)
7070
fig.text(x=2.4, y=18, text='frame=["xg2", "yg5"]', **minorexplain)
71-
# ============ Map Boundaries
71+
# ============ Plot Boundaries
7272
fig.plot(x=10, y=9, style="c0.5c", pen="2p,darkblue", no_clip=True)
73-
fig.text(x=11.5, y=8, text="Map Boundary", **mainexplain)
73+
fig.text(x=11.5, y=8, text="Plot Boundary", **mainexplain)
7474
fig.text(x=11.5, y=6.8, text='frame="WStr"', **minorexplain)
7575
# ============ fig.plot (style)
7676
fig.plot(x=6, y=8, style="c0.7c", pen="2p,darkblue")

examples/projections/nongeo/polar.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@
5757
# ============
5858
# Top left
5959
fig.basemap(
60-
# Set map limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1
60+
# Set plot limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1
6161
region=[0, 360, 0, 1],
62-
# Set map width to 5 cm
62+
# Set plot width to 5 cm
6363
projection="P5c",
6464
# Set the frame and title; @^ allows for a line break within the title
6565
frame=Frame(
@@ -74,9 +74,9 @@
7474
# ============
7575
# Top middle
7676
fig.basemap(
77-
# Set map limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1
77+
# Set plot limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1
7878
region=[0, 360, 0, 1],
79-
# Set map width to 5 cm and interpret input data as geographic azimuth instead of
79+
# Set plot width to 5 cm and interpret input data as geographic azimuth instead of
8080
# standard angle
8181
projection="P5c+a",
8282
# Set the frame and title; @^ allows for a line break within the title
@@ -92,9 +92,9 @@
9292
# ============
9393
# Top right
9494
fig.basemap(
95-
# Set map limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1
95+
# Set plot limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1
9696
region=[0, 90, 0, 1],
97-
# Set map width to 5 cm and interpret input data as geographic azimuth instead of
97+
# Set plot width to 5 cm and interpret input data as geographic azimuth instead of
9898
# standard angle
9999
projection="P5c+a",
100100
# Set the frame and title; @^ allows for a line break within the title
@@ -112,9 +112,9 @@
112112
# ============
113113
# Bottom left
114114
fig.basemap(
115-
# Set map limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1
115+
# Set plot limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1
116116
region=[0, 90, 0, 1],
117-
# Set map width to 5 cm and interpret input data as geographic azimuth instead of
117+
# Set plot width to 5 cm and interpret input data as geographic azimuth instead of
118118
# standard angle, rotate coordinate system counterclockwise by 45 degrees
119119
projection="P5c+a+t45",
120120
# Set the frame and title; @^ allows for a line break within the title
@@ -132,10 +132,10 @@
132132
# ============
133133
# Bottom middle
134134
fig.basemap(
135-
# Set map limits to theta_min = 0, theta_max = 90, radius_min = 3480,
135+
# Set plot limits to theta_min = 0, theta_max = 90, radius_min = 3480,
136136
# radius_max = 6371 (Earth's radius)
137137
region=[0, 90, 3480, 6371],
138-
# Set map width to 5 cm and interpret input data as geographic azimuth instead of
138+
# Set plot width to 5 cm and interpret input data as geographic azimuth instead of
139139
# standard angle, rotate coordinate system counterclockwise by 45 degrees
140140
projection="P5c+a+t45",
141141
# Set the frame, and title; @^ allows for a line break within the title
@@ -153,10 +153,10 @@
153153
# ============
154154
# Bottom right
155155
fig.basemap(
156-
# Set map limits to theta_min = 0, theta_max = 90, radius_min = 3480,
156+
# Set plot limits to theta_min = 0, theta_max = 90, radius_min = 3480,
157157
# radius_max = 6371 (Earth's radius)
158158
region=[0, 90, 3480, 6371],
159-
# Set map width to 5 cm and interpret input data as geographic azimuth instead of
159+
# Set plot width to 5 cm and interpret input data as geographic azimuth instead of
160160
# standard angle, rotate coordinate system counterclockwise by 45 degrees, r-axis
161161
# is marked as depth
162162
projection="P5c+a+t45+z",

examples/tutorials/advanced/configuration.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@
3232
#
3333
# The ``MAP_FRAME_TYPE`` parameter specifies the style of map frame to use, of which
3434
# there are 5 options: ``fancy`` (default, see above), ``fancy+``, ``plain``, ``graph``
35-
# (which does not apply to geographical maps) and ``inside``.
35+
# (which does not apply to geographic maps) and ``inside``.
3636
#
37-
# The ``FORMAT_GEO_MAP`` parameter controls the format of geographical tick annotations.
37+
# The ``FORMAT_GEO_MAP`` parameter controls the format of geographic tick annotations.
3838
# The default uses degrees and minutes. Here we specify the ticks to be a decimal number
3939
# of degrees.
4040

examples/tutorials/basics/text.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Plotting text
33
=============
44
5-
It is often useful to add text annotations to a plot or map. This is handled by the
5+
It is often useful to add text annotations to a plot. This is handled by the
66
:meth:`pygmt.Figure.text` method of the :class:`pygmt.Figure` class.
77
"""
88

@@ -190,7 +190,7 @@
190190
# specified to set the reference point for the text on the plot. As for the ``justify``
191191
# parameter, the ``position`` parameter is specified by a
192192
# :doc:`2-character justification code </techref/justification_codes>`.
193-
# This can be helpful to add a tag to a subplot or text labels out of the plot or map
193+
# This can be helpful to add a tag to a subplot or text labels out of the plot
194194
# frame, e.g., for depth slices.
195195

196196
fig = pygmt.Figure()
@@ -213,7 +213,7 @@
213213
fig.shift_origin(xshift="w+1c")
214214

215215
# -----------------------------------------------------------------------------
216-
# Right: Add a text label outside of the plot or map frame
216+
# Right: Add a text label outside of the plot frame
217217
fig.basemap(
218218
region=[-30, 30, 10, 60],
219219
projection="L0/35/23/47/5c",
@@ -225,7 +225,7 @@
225225
position="TC", # Top Center
226226
justify="MC", # Middle Center
227227
offset="0c/0.2c",
228-
no_clip=True, # Allow plotting outside of the map or plot frame
228+
no_clip=True, # Allow plotting outside of the plot frame
229229
)
230230

231231
fig.show()

pygmt/helpers/decorators.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@
280280
i.e., looking from south to north].
281281
- *elevation*: Elevation angle of the viewpoint above the horizon [Default
282282
is 90, i.e., looking straight down at nadir].
283-
- *zlevel*: Z-level at which 2-D elements (e.g., the map frame) are drawn.
283+
- *zlevel*: Z-level at which 2-D elements (e.g., the plot frame) are drawn.
284284
Only applied when used together with ``zsize`` or ``zscale``. [Default is
285285
at the bottom of the z-axis].
286286

pygmt/src/contour.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def contour( # noqa: PLR0913
5353
Contour table data by direct triangulation.
5454
5555
Takes a matrix, (x, y, z) triplets, or a file name as input and plots,
56-
lines, polygons, or symbols at those locations on a map.
56+
lines, polygons, or symbols at those locations on a plot.
5757
5858
Must provide either ``data`` or ``x``, ``y``, and ``z``.
5959

pygmt/src/grdimage.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def grdimage( # noqa: PLR0913
6969
value. Interpolation and aliasing is controlled with the
7070
``interpolation`` parameter.
7171
72-
The ``region`` parameter can be used to select a map region larger or
72+
The ``region`` parameter can be used to select a plot region larger or
7373
smaller than that implied by the extent of the grid.
7474
7575
Full GMT docs at :gmt-docs:`grdimage.html`.

pygmt/src/grdproject.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ def grdproject( # noqa: PLR0913
4747
``interpolation`` parameter. The new node spacing may be determined in one of
4848
several ways by specifying the grid spacing, number of nodes, or resolution. Nodes
4949
not constrained by input data are set to NaN. The ``region`` parameter can be used
50-
to select a map region large or smaller than that implied by the extent of the grid
51-
file.
50+
to select a plot region larger or smaller than that implied by the extent of the
51+
grid file.
5252
5353
Full GMT docs at :gmt-docs:`grdproject.html`.
5454

0 commit comments

Comments
 (0)