diff --git a/pygmt/helpers/decorators.py b/pygmt/helpers/decorators.py index bffa1ed8b3f..a6ab440f296 100644 --- a/pygmt/helpers/decorators.py +++ b/pygmt/helpers/decorators.py @@ -253,6 +253,11 @@ input and skip trailing text. **Note**: If ``incols`` is also used then the columns given to ``outcols`` correspond to the order after the ``incols`` selection has taken place.""", + "outgrid": """ + outgrid : str or None + Name of the output netCDF grid file. For writing a specific grid + file format or applying basic data operations to the output grid, + see :gmt-docs:`gmt.html#grd-inout-full` for the available modifiers.""", "panel": r""" panel : bool, int, or list [*row,col*\|\ *index*]. diff --git a/pygmt/src/binstats.py b/pygmt/src/binstats.py index 2524b8770c8..f8d0620d0f4 100644 --- a/pygmt/src/binstats.py +++ b/pygmt/src/binstats.py @@ -51,9 +51,7 @@ def binstats(data, **kwargs): data : str, {table-like} A file name of an ASCII data table or a 2-D {table-classes}. - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} statistic : str **a**\|\ **d**\|\ **g**\|\ **i**\|\ **l**\|\ **L**\|\ **m**\|\ **n**\ \|\ **o**\|\ **p**\|\ **q**\ [*quant*]\|\ **r**\|\ **s**\|\ **u**\ diff --git a/pygmt/src/dimfilter.py b/pygmt/src/dimfilter.py index 13828c52bb3..d653f02ba4b 100644 --- a/pygmt/src/dimfilter.py +++ b/pygmt/src/dimfilter.py @@ -54,9 +54,7 @@ def dimfilter(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} distance : int or str Distance flag tells how grid (x,y) relates to filter width, as follows: diff --git a/pygmt/src/grdclip.py b/pygmt/src/grdclip.py index 28b6c86d145..4d8c549fc22 100644 --- a/pygmt/src/grdclip.py +++ b/pygmt/src/grdclip.py @@ -51,9 +51,7 @@ def grdclip(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {region} above : str or list [*high*, *above*]. diff --git a/pygmt/src/grdcut.py b/pygmt/src/grdcut.py index d8bbbd79a8f..eb6cb36ee5d 100644 --- a/pygmt/src/grdcut.py +++ b/pygmt/src/grdcut.py @@ -47,9 +47,7 @@ def grdcut(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {projection} {region} extend : bool or float diff --git a/pygmt/src/grdfill.py b/pygmt/src/grdfill.py index c1c43030157..163c5c993b1 100644 --- a/pygmt/src/grdfill.py +++ b/pygmt/src/grdfill.py @@ -41,9 +41,7 @@ def grdfill(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} mode : str Specify the hole-filling algorithm to use. Choose from **c** for constant fill and append the constant value, **n** for nearest diff --git a/pygmt/src/grdfilter.py b/pygmt/src/grdfilter.py index 3e4e9965518..5dbee11f57c 100644 --- a/pygmt/src/grdfilter.py +++ b/pygmt/src/grdfilter.py @@ -49,9 +49,7 @@ def grdfilter(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} filter : str **b**\|\ **c**\|\ **g**\|\ **o**\|\ **m**\|\ **p**\|\ **h**\ *width*\ [/*width2*\][*modifiers*]. diff --git a/pygmt/src/grdgradient.py b/pygmt/src/grdgradient.py index 9088ef0ba4a..a05f7cb3ab6 100644 --- a/pygmt/src/grdgradient.py +++ b/pygmt/src/grdgradient.py @@ -46,9 +46,7 @@ def grdgradient(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} azimuth : float, str, or list *azim*\ [/*azim2*]. Azimuthal direction for a directional derivative; *azim* is the diff --git a/pygmt/src/grdhisteq.py b/pygmt/src/grdhisteq.py index ecc122631b7..4f26e5481af 100644 --- a/pygmt/src/grdhisteq.py +++ b/pygmt/src/grdhisteq.py @@ -76,9 +76,7 @@ def _grdhisteq(grid, output_type, **kwargs): Parameters ---------- {grid} - outgrid : str or bool or None - The name of the output netCDF file with extension .nc to store the - grid in. + {outgrid} outfile : str, bool, or None The name of the output ASCII file to store the results of the histogram equalization in. @@ -162,9 +160,7 @@ def equalize_grid( Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the - grid in. + {outgrid} divisions : int Set the number of divisions of the data range. gaussian : bool or int or float diff --git a/pygmt/src/grdlandmask.py b/pygmt/src/grdlandmask.py index 97945080dc7..f109a821e89 100644 --- a/pygmt/src/grdlandmask.py +++ b/pygmt/src/grdlandmask.py @@ -45,9 +45,7 @@ def grdlandmask(**kwargs): Parameters ---------- - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {spacing} {region} {area_thresh} diff --git a/pygmt/src/grdproject.py b/pygmt/src/grdproject.py index 22452effef3..68e75636164 100644 --- a/pygmt/src/grdproject.py +++ b/pygmt/src/grdproject.py @@ -57,9 +57,7 @@ def grdproject(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} inverse : bool When set to ``True`` transforms grid from rectangular to geographical [Default is False]. diff --git a/pygmt/src/grdsample.py b/pygmt/src/grdsample.py index c176f6c966a..ae0b8cfcf2c 100644 --- a/pygmt/src/grdsample.py +++ b/pygmt/src/grdsample.py @@ -52,9 +52,7 @@ def grdsample(grid, **kwargs): Parameters ---------- {grid} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {spacing} {region} translate : bool diff --git a/pygmt/src/nearneighbor.py b/pygmt/src/nearneighbor.py index f18ac453c09..ba839f91aa3 100644 --- a/pygmt/src/nearneighbor.py +++ b/pygmt/src/nearneighbor.py @@ -91,11 +91,7 @@ def nearneighbor(data=None, x=None, y=None, z=None, **kwargs): search_radius : str Set the search radius that determines which data points are considered close to a node. - - outgrid : str - Optional. The file name for the output netCDF file with extension .nc - to store the grid in. - + {outgrid} empty : str Optional. Set the value assigned to empty nodes. Defaults to NaN. diff --git a/pygmt/src/sph2grd.py b/pygmt/src/sph2grd.py index 1d571d5ba9e..b180b5823ad 100644 --- a/pygmt/src/sph2grd.py +++ b/pygmt/src/sph2grd.py @@ -45,9 +45,7 @@ def sph2grd(data, **kwargs): Pass in data with L, M, C[L,M], S[L,M] values by providing a file name to an ASCII data table, a 2-D {table-classes}. - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {spacing} {region} {verbose} diff --git a/pygmt/src/sphdistance.py b/pygmt/src/sphdistance.py index 953876e6982..fa634802754 100644 --- a/pygmt/src/sphdistance.py +++ b/pygmt/src/sphdistance.py @@ -52,9 +52,7 @@ def sphdistance(data=None, x=None, y=None, **kwargs): {table-classes}. x/y : 1-D arrays Arrays of x and y coordinates. - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {spacing} {region} {verbose} diff --git a/pygmt/src/sphinterpolate.py b/pygmt/src/sphinterpolate.py index f2f67809187..2a5d9e93b54 100644 --- a/pygmt/src/sphinterpolate.py +++ b/pygmt/src/sphinterpolate.py @@ -42,9 +42,7 @@ def sphinterpolate(data, **kwargs): Pass in (x, y, z) or (longitude, latitude, elevation) values by providing a file name to an ASCII data table, a 2-D {table-classes}. - outgrid : str or None - The name of the output netCDF file with extension .nc to store the grid - in. + {outgrid} {spacing} {region} {verbose} diff --git a/pygmt/src/surface.py b/pygmt/src/surface.py index 38dcff5dd71..473bca88eb7 100644 --- a/pygmt/src/surface.py +++ b/pygmt/src/surface.py @@ -84,10 +84,7 @@ def surface(data=None, x=None, y=None, z=None, **kwargs): {spacing} {region} - - outgrid : str - Optional. The file name for the output netCDF file with extension .nc - to store the grid in. + {outgrid} convergence : float Optional. Convergence limit. Iteration is assumed to have converged when the maximum absolute change in any grid value is less than diff --git a/pygmt/src/triangulate.py b/pygmt/src/triangulate.py index bf4f9404f6e..677976f448e 100644 --- a/pygmt/src/triangulate.py +++ b/pygmt/src/triangulate.py @@ -89,13 +89,12 @@ def _triangulate( {projection} {region} {spacing} - outgrid : bool or str - The name of the output netCDF file with extension .nc to store the - grid in. The interpolation is performed in the original - coordinates, so if your triangles are close to the poles you are - better off projecting all data to a local coordinate system before - using ``triangulate`` (this is true of all gridding routines) or - instead select :gmt-docs:`sphtriangulate `. + {outgrid} + The interpolation is performed in the original coordinates, so if + your triangles are close to the poles you are better off projecting + all data to a local coordinate system before using ``triangulate`` + (this is true of all gridding routines) or instead select + :gmt-docs:`sphtriangulate `. outfile : str, bool or None The name of the output ASCII file to store the results of the histogram equalization in. @@ -204,13 +203,12 @@ def regular_grid( # noqa: PLR0913 {projection} {region} {spacing} - outgrid : str or None - The name of the output netCDF file with extension .nc to store the - grid in. The interpolation is performed in the original - coordinates, so if your triangles are close to the poles you are - better off projecting all data to a local coordinate system before - using ``triangulate`` (this is true of all gridding routines) or - instead select :gmt-docs:`sphtriangulate `. + {outgrid} + The interpolation is performed in the original coordinates, so if + your triangles are close to the poles you are better off projecting + all data to a local coordinate system before using ``triangulate`` + (this is true of all gridding routines) or instead select + :gmt-docs:`sphtriangulate `. {verbose} {binary} {nodata} diff --git a/pygmt/src/xyz2grd.py b/pygmt/src/xyz2grd.py index 34e76aa0bdb..693d9f0eab7 100644 --- a/pygmt/src/xyz2grd.py +++ b/pygmt/src/xyz2grd.py @@ -55,9 +55,7 @@ def xyz2grd(data=None, x=None, y=None, z=None, **kwargs): providing a file name to an ASCII data table, a 2-D {table-classes}. x/y/z : 1-D arrays The arrays of x and y coordinates and z data points. - outgrid : str or None - Optional. The name of the output netCDF file with extension .nc to - store the grid in. + {outgrid} duplicate : str [**d**\|\ **f**\|\ **l**\|\ **m**\|\ **n**\|\ **r**\|\ **S**\|\ **s**\|\ **u**\|\ **z**].