Merge branch 'main' into optional-context

Author: seisman

AUTHORS.md

@@ -19,7 +19,7 @@ The following people have contributed code and/or documentation to the project
 * [Liam Toney](https://liam.earth/) | [0000-0003-0167-9433](https://orcid.org/0000-0003-0167-9433) | University of Alaska Fairbanks, USA
 * [Malte Ziebarth](https://github.com/mjziebarth) | [0000-0002-5190-4478](https://orcid.org/0000-0002-5190-4478) | GFZ German Research Centre for Geosciences, Germany
 * [Max Jones](https://github.com/maxrjones) | [0000-0003-0180-8928](https://orcid.org/0000-0003-0180-8928) | University of Hawai'i at Mānoa, USA
-* [Michael Grund](https://github.com/michaelgrund) | [0000-0001-8759-2018](https://orcid.org/0000-0001-8759-2018) | Innoplexia GmbH, Germany
+* [Michael Grund](https://github.com/michaelgrund) | [0000-0001-8759-2018](https://orcid.org/0000-0001-8759-2018) | SNP Innovation Lab GmbH, Germany
 * [Tyler Newton](http://www.tnewton.com/) | [0000-0002-1560-6553](https://orcid.org/0000-0002-1560-6553) | University of Oregon, USA
 * [Wei Ji Leong](https://github.com/weiji14) | [0000-0003-2354-1988](https://orcid.org/0000-0003-2354-1988) | Development Seed, USA
 * [William Schlitzer](https://github.com/willschlitzer) | [0000-0002-5843-2282](https://orcid.org/0000-0002-5843-2282) | Unaffiliated

CITATION.cff

@@ -22,7 +22,7 @@ authors:
   orcid: https://orcid.org/0000-0002-5843-2282
 - given-names: Michael
   family-names: Grund
-  affiliation: Innoplexia GmbH, Germany
+  affiliation: SNP Innovation Lab GmbH, Germany
   orcid: https://orcid.org/0000-0001-8759-2018
 - given-names: Max
   family-names: Jones

pygmt/src/grdfill.py

@@ -20,6 +20,7 @@
 @use_alias(
     A="mode",
     G="outgrid",
+    N="no_data",
     R="region",
     V="verbose",
 )
@@ -28,10 +29,10 @@ def grdfill(grid, **kwargs):
     r"""
     Fill blank areas from a grid file.
 
-    Read a grid that presumably has unfilled holes that the user
-    wants to fill in some fashion. Holes are identified by NaN values but
-    this criteria can be changed. There are several different algorithms that
-    can be used to replace the hole values.
+    Read a grid that presumably has unfilled holes that the user wants to
+    fill in some fashion. Holes are identified by NaN values but this
+    criteria can be changed via the ``no_data`` parameter. There are several
+    different algorithms that can be used to replace the hole values.
 
     Full option list at :gmt-docs:`grdfill.html`
 
@@ -52,6 +53,9 @@ def grdfill(grid, **kwargs):
         where (*X,Y*) are the node dimensions of the grid]), or
         **s** for bicubic spline (optionally append a *tension*
         parameter [Default is no tension]).
+    no_data : int or float
+        Set the node value used to identify a point as a member of a hole
+        [Default is NaN].
 
     {region}
     {verbose}

pygmt/src/grdfilter.py

@@ -119,13 +119,12 @@ def grdfilter(grid, **kwargs):
         - None if ``outgrid`` is set (grid output will be stored in file set by
           ``outgrid``)
 
-    Example
-    -------
+    Examples
+    --------
     >>> import os
     >>> import pygmt
-
-    >>> # Apply a filter of 600km (full width) to the @earth_relief_30m file
-    >>> # and return a filtered field (saved as netcdf)
+    >>> # Apply a filter of 600 km (full width) to the @earth_relief_30m_g file
+    >>> # and return a filtered field (saved as NetCDF)
     >>> pygmt.grdfilter(
     ...     grid="@earth_relief_30m_g",
     ...     filter="m600",
@@ -134,10 +133,9 @@ def grdfilter(grid, **kwargs):
     ...     spacing=0.5,
     ...     outgrid="filtered_pacific.nc",
     ... )
-    >>> os.remove("filtered_pacific.nc")  # cleanup file
-
-    >>> # Apply a gaussian smoothing filter of 600 km in the input data array,
-    >>> # and returns a filtered data array with the smoothed field.
+    >>> os.remove("filtered_pacific.nc")  # Cleanup file
+    >>> # Apply a Gaussian smoothing filter of 600 km to the input DataArray
+    >>> # and return a filtered DataArray with the smoothed field
     >>> grid = pygmt.datasets.load_earth_relief()
     >>> smooth_field = pygmt.grdfilter(grid=grid, filter="g600", distance="4")
     """

pygmt/src/image.py

@@ -7,11 +7,12 @@
 
 @fmt_docstring
 @use_alias(
-    R="region",
-    J="projection",
     D="position",
     F="box",
+    G="bitcolor",
+    J="projection",
     M="monochrome",
+    R="region",
     V="verbose",
     c="panel",
     p="perspective",
@@ -49,6 +50,14 @@ def image(self, imagefile, **kwargs):
         [**+p**\ [*pen*]][**+r**\ [*radius*]][**+s**\ [[*dx*/*dy*/][*shade*]]].
         If set to ``True``, draw a rectangular border around the image
         using :gmt-term:`MAP_FRAME_PEN`.
+    bitcolor : str or list
+        [*color*][**+b**\|\ **f**\|\ **t**].
+        Change certain pixel values to another color or make them transparent.
+        For 1-bit images you can specify an alternate *color* for the
+        background (**+b**) or the foreground (**+f**) pixels, or give no color
+        to make those pixels transparent. Can be repeated with different
+        settings. Alternatively, for color images you can select a single
+        *color* that should be made transparent instead (**+t**).
     monochrome : bool
         Convert color image to monochrome grayshades using the (television)
         YIQ-transformation.