Skip to content

Commit b8c3353

Browse files
authored
pygmt.grdgradient: Improve the docstrings of the azimuth parameter (#4431)
1 parent d992964 commit b8c3353

1 file changed

Lines changed: 15 additions & 17 deletions

File tree

pygmt/src/grdgradient.py

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -116,23 +116,21 @@ def grdgradient( # noqa: PLR0913
116116
$outgrid
117117
azimuth
118118
*azim* or (*azim*, *azim2*).
119-
Azimuthal direction for a directional derivative; *azim* is the
120-
angle in the x,y plane measured in degrees positive clockwise from
121-
north (the positive y-direction) toward east (the positive x-direction). The
122-
negative of the directional derivative,
123-
:math:`-(\frac{dz}{dx}\sin(\mbox{azim}) + \
124-
\frac{dz}{dy}\cos(\mbox{azim}))`, is found; negation yields
125-
positive values when the slope of :math:`z(x,y)` is downhill in the
126-
*azim* direction, the correct sense for shading the illumination of an
127-
image by a light source above the x,y plane shining from the *azim*
128-
direction. Optionally, supply two azimuths, *azim*/*azim2*, in which
129-
case the gradients in each of these directions are calculated and the
130-
one larger in magnitude is retained; this is useful for illuminating
131-
data with two directions of lineated structures, e.g., *0*/*270*
132-
illuminates from the north (top) and west (left). Finally, if *azim*
133-
is a file it must be a grid of the same domain, spacing and
134-
registration as *grid* that will update the azimuth at each output
135-
node when computing the directional derivatives.
119+
Azimuthal direction for a directional derivative; *azim* is the angle in the x-y
120+
plane measured in degrees positive clockwise from north (the +y direction)
121+
toward east (the +x direction). The negative of the directional derivative,
122+
:math:`-(\frac{dz}{dx}\sin(\mbox{azim}) + \frac{dz}{dy}\cos(\mbox{azim}))`, is
123+
found; negation yields positive values when the slope of :math:`z(x,y)` is
124+
downhill in the *azim* direction, the correct sense for shading the illumination
125+
of an image by (see :meth:`pygmt.Figure.grdimage` and
126+
:meth:`pygmt.Figure.grdview`) a light source above the x-y plane shining from
127+
the *azim* direction. Optionally, supply two azimuths, (*azim*, *azim2*), in
128+
which case the gradients in each of these directions are calculated and the one
129+
larger in magnitude is retained; this is useful for illuminating data with two
130+
directions of lineated structures, e.g., ``(0, 270)`` illuminates from the north
131+
(top) and west (left). Finally, if *azim* is a file it must be a grid of the
132+
same domain, spacing and registration as *grid* that will update the azimuth at
133+
each output node when computing the directional derivatives.
136134
direction : str
137135
[**a**][**c**][**o**][**n**].
138136
Find the direction of the positive (up-slope) gradient of the data.

0 commit comments

Comments
 (0)