geopyspark.geotrellis.hillshade module¶
-
geopyspark.geotrellis.hillshade.
hillshade
(tiled_raster_layer, zfactor_calculator, band=0, azimuth=315.0, altitude=45.0)¶ Computes Hillshade (shaded relief) from a raster.
The resulting raster will be a shaded relief map (a hill shading) based on the sun altitude, azimuth, and the
zfactor
. Thezfactor
is a conversion factor from map units to elevation units.The
hillshade`
operation will be carried out in aSQUARE
neighborhood with with anextent
of 1. Thezfactor
will be derived from thezfactor_calculator
for eachTile
in the Layer. The resulting Layer will have acell_type
ofINT16
regardless of the input Layer’scell_type
; as well as have a single band, that represents the calculatedhillshade
.Returns a raster of ShortConstantNoDataCellType.
For descriptions of parameters, please see Esri Desktop’s description of Hillshade.
Parameters: - tiled_raster_layer (
TiledRasterLayer
) – The base layer that contains the rasters used to compute the hillshade. - zfactor_calculator (py4j.JavaObject) – A
JavaObject
that represents the ScalaZFactorCalculator
class. This can be created using either thezfactor_lat_lng_calculator()
or thezfactor_calculator()
methods. - band (int, optional) – The band of the raster to base the hillshade calculation on. Default is 0.
- azimuth (float, optional) – The azimuth angle of the source of light. Default value is 315.0.
- altitude (float, optional) – The angle of the altitude of the light above the horizon. Default is 45.0.
Returns: - tiled_raster_layer (