hillshade

gma.etools.hillshade

function hillshade(in_src, out_dst, compute_edges = None, band = 1, z_factor = 1.0, scale = 1.0, azimuth = 315.0, altitude = 45.0, combined = False, algos = "Horn", **kwargs):

Calculate hillshade from any supported DEM raster file!

Parameters:

in_src: str.

The input raster file path.

out_dst: str.

The output raster file path.

Optional:

compute_edges = bool. Default True.

Whether to compute raster edge data and data near no data values.

Setting values that are not True are treated as False.

band = int. Default 1.

Number of the element calculation band. Start with 1.

z_factor = float. Default 1.0.

Vertical exaggeration.

scale = float. Default 1.0.

The ratio of vertical units to horizontal. If the vertical unit is m and the horizontal unit is ��, you can set Scale = 111120.

azimuth = float. Default 315.0.

Azimuth of the light(��).

altitude = float. Default 45.0.

Altitude of the light(��).

combined = bool. Default False.

Whether to compute blended shadows. Setting values that are not True are treated as False.

algos = str. Default 'Horn'.

Surface algorithm. May be 'Horn' or 'ZevenbergenThorne'.

OutFormat = str||aclassofgmaRasterFormat. Default 'GTiff'.

Output file format. For more, see rasp.Basic.ToOtherFormat.

**kwargs:

Other parameters passed to translate.

Returns:

Type: DataSet.