diff --git a/doc/api/index.rst b/doc/api/index.rst index cce3f68f19d..950e245062a 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -18,8 +18,8 @@ All plotting is handled through the :class:`pygmt.Figure` class and its methods. Figure -Plotting map elements -~~~~~~~~~~~~~~~~~~~~~ +Plotting embellishments +~~~~~~~~~~~~~~~~~~~~~~~ .. autosummary:: :toctree: generated diff --git a/examples/gallery/3d_plots/scatter3d.py b/examples/gallery/3d_plots/scatter3d.py index cf1538a83db..a9b9e35958e 100644 --- a/examples/gallery/3d_plots/scatter3d.py +++ b/examples/gallery/3d_plots/scatter3d.py @@ -77,7 +77,7 @@ fill=df.species.cat.codes.astype(int), # Use colormap created by makecpt cmap=True, - # Set map dimensions (xmin, xmax, ymin, ymax, zmin, zmax) + # Set plot dimensions (xmin, xmax, ymin, ymax, zmin, zmax) region=region, # Set frame parameters frame=[ diff --git a/examples/intro/03_figure_element.py b/examples/intro/03_figure_element.py index 48fb21013e6..61d552c4243 100644 --- a/examples/intro/03_figure_element.py +++ b/examples/intro/03_figure_element.py @@ -6,7 +6,7 @@ - :meth:`pygmt.Figure()`: having a number of plotting methods. Every new figure must start with the creation of a :meth:`pygmt.Figure()` instance -- ``frame``: setting plot or map boundaries (a combination of the single +- ``frame``: setting plot boundaries (a combination of the single letters of **WSNE**, **wsne**, or **lbtr**), adding annotations, ticks, gridlines (**afg**), axis labels (**+l**), and title (**+t**), e.g., in :meth:`pygmt.Figure.basemap`. Detailed examples can be found at @@ -68,9 +68,9 @@ fig.plot(x=2, y=15, style="c0.5c", pen="2p,darkblue") fig.text(x=2, y=17, text="Grid", **mainexplain) fig.text(x=2.4, y=18, text='frame=["xg2", "yg5"]', **minorexplain) -# ============ Map Boundaries +# ============ Plot Boundaries fig.plot(x=10, y=9, style="c0.5c", pen="2p,darkblue", no_clip=True) -fig.text(x=11.5, y=8, text="Map Boundary", **mainexplain) +fig.text(x=11.5, y=8, text="Plot Boundary", **mainexplain) fig.text(x=11.5, y=6.8, text='frame="WStr"', **minorexplain) # ============ fig.plot (style) fig.plot(x=6, y=8, style="c0.7c", pen="2p,darkblue") diff --git a/examples/projections/nongeo/polar.py b/examples/projections/nongeo/polar.py index 05f8820272f..e2ef40c8e1e 100644 --- a/examples/projections/nongeo/polar.py +++ b/examples/projections/nongeo/polar.py @@ -56,9 +56,9 @@ # ============ # Top left fig.basemap( - # Set map limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1 + # Set plot limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1 region=[0, 360, 0, 1], - # Set map width to 5 cm + # Set plot width to 5 cm projection="P5c", # Set the frame and title; @^ allows for a line break within the title frame=["xa45f", "+gbisque+tprojection='P5c' @^ region=[0, 360, 0, 1]"], @@ -69,9 +69,9 @@ # ============ # Top middle fig.basemap( - # Set map limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1 + # Set plot limits to theta_min = 0, theta_max = 360, radius_min = 0, radius_max = 1 region=[0, 360, 0, 1], - # Set map width to 5 cm and interpret input data as geographic azimuth instead of + # Set plot width to 5 cm and interpret input data as geographic azimuth instead of # standard angle projection="P5c+a", # Set the frame and title; @^ allows for a line break within the title @@ -83,9 +83,9 @@ # ============ # Top right fig.basemap( - # Set map limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1 + # Set plot limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1 region=[0, 90, 0, 1], - # Set map width to 5 cm and interpret input data as geographic azimuth instead of + # Set plot width to 5 cm and interpret input data as geographic azimuth instead of # standard angle projection="P5c+a", # Set the frame and title; @^ allows for a line break within the title @@ -97,9 +97,9 @@ # ============ # Bottom left fig.basemap( - # Set map limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1 + # Set plot limits to theta_min = 0, theta_max = 90, radius_min = 0, radius_max = 1 region=[0, 90, 0, 1], - # Set map width to 5 cm and interpret input data as geographic azimuth instead of + # Set plot width to 5 cm and interpret input data as geographic azimuth instead of # standard angle, rotate coordinate system counterclockwise by 45 degrees projection="P5c+a+t45", # Set the frame and title; @^ allows for a line break within the title @@ -115,10 +115,10 @@ # ============ # Bottom middle fig.basemap( - # Set map limits to theta_min = 0, theta_max = 90, radius_min = 3480, + # Set plot limits to theta_min = 0, theta_max = 90, radius_min = 3480, # radius_max = 6371 (Earth's radius) region=[0, 90, 3480, 6371], - # Set map width to 5 cm and interpret input data as geographic azimuth instead of + # Set plot width to 5 cm and interpret input data as geographic azimuth instead of # standard angle, rotate coordinate system counterclockwise by 45 degrees projection="P5c+a+t45", # Set the frame, and title; @^ allows for a line break within the title @@ -134,10 +134,10 @@ # ============ # Bottom right fig.basemap( - # Set map limits to theta_min = 0, theta_max = 90, radius_min = 3480, + # Set plot limits to theta_min = 0, theta_max = 90, radius_min = 3480, # radius_max = 6371 (Earth's radius) region=[0, 90, 3480, 6371], - # Set map width to 5 cm and interpret input data as geographic azimuth instead of + # Set plot width to 5 cm and interpret input data as geographic azimuth instead of # standard angle, rotate coordinate system counterclockwise by 45 degrees, r-axis # is marked as depth projection="P5c+a+t45+z", diff --git a/examples/tutorials/advanced/configuration.py b/examples/tutorials/advanced/configuration.py index f7d6b70c057..b283470ac10 100644 --- a/examples/tutorials/advanced/configuration.py +++ b/examples/tutorials/advanced/configuration.py @@ -32,9 +32,9 @@ # # The ``MAP_FRAME_TYPE`` parameter specifies the style of map frame to use, of which # there are 5 options: ``fancy`` (default, see above), ``fancy+``, ``plain``, ``graph`` -# (which does not apply to geographical maps) and ``inside``. +# (which does not apply to geographic maps) and ``inside``. # -# The ``FORMAT_GEO_MAP`` parameter controls the format of geographical tick annotations. +# The ``FORMAT_GEO_MAP`` parameter controls the format of geographic tick annotations. # The default uses degrees and minutes. Here we specify the ticks to be a decimal number # of degrees. diff --git a/examples/tutorials/basics/text.py b/examples/tutorials/basics/text.py index 2b582a23e60..a60cdfb9b60 100644 --- a/examples/tutorials/basics/text.py +++ b/examples/tutorials/basics/text.py @@ -2,7 +2,7 @@ Plotting text ============= -It is often useful to add text annotations to a plot or map. This is handled by the +It is often useful to add text annotations to a plot. This is handled by the :meth:`pygmt.Figure.text` method of the :class:`pygmt.Figure` class. """ @@ -189,7 +189,7 @@ # specified to set the reference point for the text on the plot. As for the ``justify`` # parameter, the ``position`` parameter is specified by a # :doc:`2-character justification code `. -# This can be helpful to add a tag to a subplot or text labels out of the plot or map +# This can be helpful to add a tag to a subplot or text labels out of the plot # frame, e.g., for depth slices. fig = pygmt.Figure() @@ -208,7 +208,7 @@ fig.shift_origin(xshift="w+1c") # ----------------------------------------------------------------------------- -# Right: Add a text label outside of the plot or map frame +# Right: Add a text label outside of the plot frame fig.basemap(region=[-30, 30, 10, 60], projection="L0/35/23/47/5c", frame=["wSnE", "af"]) fig.text( @@ -216,7 +216,7 @@ position="TC", # Top Center justify="MC", # Middle Center offset="0c/0.2c", - no_clip=True, # Allow plotting outside of the map or plot frame + no_clip=True, # Allow plotting outside of the plot frame ) fig.show() diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index 8920c0ac408..b8f35ecbebd 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -91,7 +91,7 @@ matching. This does not apply to headers or segment headers.""", "frame": r""" frame : bool, str, or list - Set map boundary + Set plot boundary :doc:`frame and axes attributes `.""", "gap": r""" gap : str or list @@ -277,7 +277,7 @@ i.e., looking from south to north]. - *elevation*: Elevation angle of the viewpoint above the horizon [Default is 90, i.e., looking straight down at nadir]. - - *zlevel*: Z-level at which 2-D elements (e.g., the map frame) are drawn. + - *zlevel*: Z-level at which 2-D elements (e.g., the plot frame) are drawn. Only applied when used together with ``zsize`` or ``zscale``. [Default is at the bottom of the z-axis]. diff --git a/pygmt/src/contour.py b/pygmt/src/contour.py index ae36b4d8c22..9dec8f4379c 100644 --- a/pygmt/src/contour.py +++ b/pygmt/src/contour.py @@ -53,7 +53,7 @@ def contour( # noqa: PLR0913 Contour table data by direct triangulation. Takes a matrix, (x, y, z) triplets, or a file name as input and plots, - lines, polygons, or symbols at those locations on a map. + lines, polygons, or symbols at those locations on a plot. Must provide either ``data`` or ``x``, ``y``, and ``z``. diff --git a/pygmt/src/grdimage.py b/pygmt/src/grdimage.py index 8fce5bff0ec..7e336f2e138 100644 --- a/pygmt/src/grdimage.py +++ b/pygmt/src/grdimage.py @@ -69,7 +69,7 @@ def grdimage( # noqa: PLR0913 value. Interpolation and aliasing is controlled with the ``interpolation`` parameter. - The ``region`` parameter can be used to select a map region larger or + The ``region`` parameter can be used to select a plot region larger or smaller than that implied by the extent of the grid. Full GMT docs at :gmt-docs:`grdimage.html`. diff --git a/pygmt/src/image.py b/pygmt/src/image.py index 8d82fe4f568..c9cc2540af7 100644 --- a/pygmt/src/image.py +++ b/pygmt/src/image.py @@ -39,7 +39,7 @@ def image( # noqa: PLR0913 r""" Plot raster or EPS images. - Reads an Encapsulated PostScript file or a raster image file and plot it on a map. + Reads an Encapsulated PostScript file or a raster image file and plot it on a plot. The image can be scaled arbitrarily, and 1-bit raster images can be: - inverted, i.e., black pixels (on) become white (off) and vice versa. diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index 8f8873bde62..1e1b4a9f206 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -196,7 +196,7 @@ def plot( # noqa: PLR0912, PLR0913 [Default plots points whose coordinates are strictly inside the frame boundaries only]. The parameter does not apply to lines and polygons which are always - clipped to the map region. For periodic (360-longitude) maps we + clipped to the plot region. For periodic (360-longitude) maps we must plot all symbols twice in case they are clipped by the repeating boundary. ``no_clip=True`` will turn off clipping and not plot repeating symbols. Use ``no_clip="r"`` to turn off clipping diff --git a/pygmt/src/plot3d.py b/pygmt/src/plot3d.py index c6aa0e93d67..f9ef77f2392 100644 --- a/pygmt/src/plot3d.py +++ b/pygmt/src/plot3d.py @@ -171,7 +171,7 @@ def plot3d( # noqa: PLR0912, PLR0913 [Default plots points whose coordinates are strictly inside the frame boundaries only]. This parameter does not apply to lines and polygons which are always - clipped to the map region. For periodic (360° longitude) maps we + clipped to the plot region. For periodic (360° longitude) maps we must plot all symbols twice in case they are clipped by the repeating boundary. ``no_clip=True`` will turn off clipping and not plot repeating symbols. Use ``no_clip="r"`` to turn off clipping diff --git a/pygmt/src/rose.py b/pygmt/src/rose.py index ef819c0685a..67146010f43 100644 --- a/pygmt/src/rose.py +++ b/pygmt/src/rose.py @@ -118,7 +118,7 @@ def rose( # noqa: PLR0913 to 1. frame : str - Set map boundary frame and axes attributes. Remember that *x* + Set plot boundary frame and axes attributes. Remember that *x* here is radial distance and *y* is azimuth. The y label may be used to plot a figure caption. The scale bar length is determined by the radial gridline spacing. diff --git a/pygmt/src/text.py b/pygmt/src/text.py index a82afb4e3c0..e788fded7cb 100644 --- a/pygmt/src/text.py +++ b/pygmt/src/text.py @@ -105,12 +105,12 @@ def text_( # noqa: PLR0912, PLR0913 The x and y coordinates, or an array of x and y coordinates to plot the text. position - Set reference point on the map for the text by using x, y + Set reference point on the plot for the text by using x, y coordinates extracted from ``region`` instead of providing them through ``x``/``y``. Specify with a :doc:`2-character justification code `. For example, ``position="TL"`` plots the text at the Top Left corner - of the map. + of the plot. text The text string, or an array of strings to plot on the figure. angle: float, str, bool or list