matplotlib 3.5.1

ParametersReturnsBackRef
hillshade(self, elevation, vert_exag=1, dx=1, dy=1, fraction=1.0)

This computes the normal vectors for the surface, and then passes them on to shade_normals

Parameters

elevation : 2D array-like

The height values used to generate an illumination map

vert_exag : number, optional

The amount to exaggerate the elevation values by when calculating illumination. This can be used either to correct for differences in units between the x-y coordinate system and the elevation coordinate system (e.g. decimal degrees vs. meters) or to exaggerate or de-emphasize topographic effects.

dx : number, optional

The x-spacing (columns) of the input elevation grid.

dy : number, optional

The y-spacing (rows) of the input elevation grid.

fraction : number, optional

Increases or decreases the contrast of the hillshade. Values greater than one will cause intermediate values to move closer to full illumination or shadow (and clipping any values that move beyond 0 or 1). Note that this is not visually or mathematically the same as vertical exaggeration.

Returns

ndarray

A 2D array of illumination values between 0-1, where 0 is completely in shadow and 1 is completely illuminated.

Calculate the illumination intensity for a surface using the defined azimuth and elevation for the light source.

Examples

See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

matplotlib.colors.LightSource

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/colors.py#2046
type: <class 'function'>
Commit: