Skip to content

Commit

Permalink
Add missing aliases to grdproject (GenericMappingTools#1514)
Browse files Browse the repository at this point in the history
*Add center, spacing, dpi, scaling, and unit aliases to grdproject

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Dongdong Tian <[email protected]>
  • Loading branch information
3 people authored and Josh Sixsmith committed Dec 21, 2022
1 parent d6b5d51 commit 837e81f
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion pygmt/src/grdproject.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,20 @@

@fmt_docstring
@use_alias(
C="center",
D="spacing",
E="dpi",
F="scaling",
G="outgrid",
J="projection",
I="inverse",
M="unit",
R="region",
V="verbose",
n="interpolation",
r="registration",
)
@kwargs_to_strings(R="sequence")
@kwargs_to_strings(C="sequence", R="sequence")
def grdproject(grid, **kwargs):
r"""
Change projection of gridded data between geographical and rectangular.
Expand Down Expand Up @@ -58,6 +63,26 @@ def grdproject(grid, **kwargs):
geographical [Default is False].
{J}
{R}
center : str or list
[*dx*, *dy*].
Let projected coordinates be relative to projection center [Default
is relative to lower left corner]. Optionally, add offsets in the
projected units to be added (or subtracted when ``inverse`` is set) to
(from) the projected coordinates, such as false eastings and
northings for particular projection zones [0/0].
{I}
dpi : int
Set the resolution for the new grid in dots per inch.
scaling : str
[**c**\|\ **i**\|\ **p**\|\ **e**\|\ **f**\|\
**k**\|\ **M**\|\ **n**\|\ **u**].
Force 1:1 scaling, i.e., output or output data are in actual projected
meters [**e**]. To specify other units, append **f** (foot),
**k** (km), **M** (statute mile), **n** (nautical mile), **u**
(US survey foot), **i** (inch), **c** (cm), or **p** (point).
unit : str
Append **c**, **i**, or **p** to indicate that cm, inch, or point
should be the projected measure unit. Cannot be used with ``scaling``.
{V}
{n}
{r}
Expand Down

0 comments on commit 837e81f

Please sign in to comment.