@@ -1641,18 +1641,15 @@ def shade(self, data, cmap, norm=None, blend_mode='overlay', vmin=None,
16411641 def shade_rgb (self , rgb , elevation , fraction = 1. , blend_mode = 'hsv' ,
16421642 vert_exag = 1 , dx = 1 , dy = 1 , ** kwargs ):
16431643 """
1644- Take the input RGB array (ny*nx*3) adjust their color values
1645- to given the impression of a shaded relief map with a
1646- specified light source using the elevation (ny*nx).
1647- A new RGB array ((ny*nx*3)) is returned.
1644+ Use this light source to adjust the colors of the *rgb* input array to
1645+ give the impression of a shaded relief map with the given `elevation`.
16481646
16491647 Parameters
16501648 ----------
16511649 rgb : array-like
1652- An MxNx3 RGB array, assumed to be in the range of 0 to 1.
1650+ An (M, N, 3) RGB array, assumed to be in the range of 0 to 1.
16531651 elevation : array-like
1654- A 2d array (or equivalent) of the height values used to generate a
1655- shaded map.
1652+ An (M, N) array of the height values used to generate a shaded map.
16561653 fraction : number
16571654 Increases or decreases the contrast of the hillshade. Values
16581655 greater than one will cause intermediate values to move closer to
@@ -1684,7 +1681,7 @@ def shade_rgb(self, rgb, elevation, fraction=1., blend_mode='hsv',
16841681 Returns
16851682 -------
16861683 shaded_rgb : ndarray
1687- An MxNx3 array of floats ranging between 0-1.
1684+ An (m, n, 3) array of floats ranging between 0-1.
16881685 """
16891686 # Calculate the "hillshade" intensity.
16901687 intensity = self .hillshade (elevation , vert_exag , dx , dy , fraction )
0 commit comments