Skip to content

Commit 1f07278

Browse files
Apply suggestions from code review
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
1 parent 8a74285 commit 1f07278

File tree

1 file changed

+8
-33
lines changed

1 file changed

+8
-33
lines changed

pygmt/src/grdproject.py

Lines changed: 8 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -64,50 +64,25 @@ def grdproject(grid, **kwargs):
6464
{J}
6565
{R}
6666
center : str or list
67-
[*dx/dy*]
67+
[*dx/dy*].
6868
Let projected coordinates be relative to projection center [Default
6969
is relative to lower left corner]. Optionally, add offsets in the
7070
projected units to be added (or subtracted when `inverse` is set) to
7171
(from) the projected coordinates, such as false eastings and
7272
northings for particular projection zones [0/0].
73-
spacing : str
74-
*xinc*\ [**+e**\|\ **n**][/\ *yinc*\ [**+e**\|\ **n**]]
75-
Set the grid spacing for the new grid. [Default is the same number of
76-
output nodes as there are input nodes]. Optionally append a suffix
77-
modifier.
78-
**Geographical (degrees) coordinates**: Append
79-
**m** to indicate arc minutes or **s** to indicate arc seconds. If one
80-
of the units **e**, **f**, **k**, **M**, **n** or **u** is appended
81-
instead, the increment is assumed to be given in meter, foot, km, Mile,
82-
nautical mile or US survey foot, respectively, and will be converted to
83-
the equivalent degrees longitude at the middle latitude of the region.
84-
If *y_inc* is given but set to 0 it will be reset equal to *x_inc*;
85-
otherwise it will be converted to degrees latitude.
86-
**All coordinates**: If **+e** is appended
87-
then the corresponding max *x* (*east*) or *y* (*north*) may be
88-
slightly adjusted to fit exactly the given increment [by default the
89-
increment may be adjusted slightly to fit the given domain]. Finally,
90-
instead of giving an increment you may specify the *number of nodes*
91-
desired by appending **+n** to the supplied integer argument; the
92-
increment is then
93-
recalculated from the number of nodes and the domain.
94-
**Note**: If `region` is used then the grid spacing (and registration)
95-
have already been initialized; use `spacing` and `registration` to
96-
override the values.
73+
{I}
9774
dpi : int
9875
Set the resolution for the new grid in dots per inch.
9976
scaling : str
10077
[**c**\|\ **i**\|\ **p**\|\ **e**\|\ **f**\|\
10178
**k**\|\ **M**\|\ **n**\|\ **u**].
102-
Force 1:1 scaling, i.e., output or output data are in
103-
actual projected meters [**e**]. To specify other units, append
104-
**f** (foot), **k** (km), **M** (statute mile), **n** (nautical
105-
mile), **u** (US survey foot), **i** (inch), **c** (cm), or **p**
106-
(point).
79+
Force 1:1 scaling, i.e., output or output data are in actual projected
80+
meters [**e**]. To specify other units, append **f** (foot),
81+
**k** (km), **M** (statute mile), **n** (nautical mile), **u**
82+
(US survey foot), **i** (inch), **c** (cm), or **p** (point).
10783
unit : str
108-
Append **c**, **i**, or **p** to indicate that cm, inch, or point
109-
should be the projected measure unit. Cannot be used with
110-
`scaling`.
84+
Append **c**, **i**, or **p** to indicate that cm, inch, or point
85+
should be the projected measure unit. Cannot be used with `scaling`.
11186
{V}
11287
{n}
11388
{r}

0 commit comments

Comments
 (0)