.\" Man page generated from reStructuredText. . . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .TH "GDAL-RASTER-HILLSHADE" "1" "May 06, 2025" "" "GDAL" .SH NAME gdal-raster-hillshade \- Generate a shaded relief map .sp Added in version 3.11. .SH SYNOPSIS .INDENT 0.0 .INDENT 3.5 .sp .EX Usage: gdal raster hillshade [OPTIONS] Generate a shaded relief map Positional arguments: \-i, \-\-input Input raster dataset [required] \-o, \-\-output Output raster dataset [required] Common Options: \-h, \-\-help Display help message and exit \-\-json\-usage Display usage as JSON document and exit \-\-config = Configuration option [may be repeated] \-\-progress Display progress bar Options: \-f, \-\-of, \-\-format, \-\-output\-format Output format (\(dqGDALG\(dq allowed) \-\-co, \-\-creation\-option = Creation option [may be repeated] \-\-overwrite Whether overwriting existing output is allowed \-b, \-\-band Input band (1\-based index) (default: 1) \-z, \-\-zfactor Vertical exaggeration used to pre\-multiply the elevations \-\-xscale Ratio of vertical units to horizontal X axis units \-\-yscale Ratio of vertical units to horizontal Y axis units \-\-azimuth Azimuth of the light, in degrees (default: 315) \-\-altitude Altitude of the light, in degrees (default: 45) \-\-gradient\-alg Algorithm used to compute terrain gradient. GRADIENT\-ALG=Horn|ZevenbergenThorne (default: Horn) \-\-variant Variant of the hillshading algorithm. VARIANT=regular|combined|multidirectional|Igor (default: regular) \-\-no\-edges Do not try to interpolate values at dataset edges or close to nodata values Advanced Options: \-\-if, \-\-input\-format Input formats [may be repeated] \-\-oo, \-\-open\-option = Open options [may be repeated] .EE .UNINDENT .UNINDENT .SH DESCRIPTION .sp \fBgdal raster hillshade\fP generates a shaded relief map, from any GDAL\-supported elevation raster. .sp This subcommand is also available as a potential step of \fI\%gdal raster pipeline\fP .sp It generates an 8\-bit raster with a nice shaded relief effect. It is very useful for visualizing the terrain. You can optionally specify the azimuth and altitude of the light source, a vertical exaggeration factor and scaling factors to account for differences between vertical and horizontal units. .sp The value 0 is used as the output nodata value. A nodata value in the target dataset will be emitted if at least one pixel set to the nodata value is found in the 3x3 window centered around each source pixel. By default, the algorithm will compute values at image edges or if a nodata value is found in the 3x3 window, by interpolating missing values, unless \fI\%\-\-no\-edges\fP is specified, in which case a 1\-pixel border around the image will be set with the nodata value. .sp In general, it assumes that x, y and z units are identical. However, if none of \fI\%\-\-xscale\fP and \fI\%\-\-yscale\fP are specified, and the CRS is a geographic or projected CRS, it will automatically determine the appropriate ratio from the units of the CRS, as well as the potential value of the units of the raster band (as returned by \fBGDALRasterBand::GetUnitsType()\fP, if it is metre, foot international or US survey foot). Note that for geographic CRS, the result for source datasets at high latitudes may be incorrect, and prior reprojection to a polar projection might be needed using \fI\%gdal raster reproject\fP\&. .sp If x (east\-west) and y (north\-south) units are identical, but z (elevation) units are different, the \fI\%\-\-xscale\fP and \fI\%\-\-yscale\fP can be used to set the ratio of vertical units to horizontal. For geographic CRS near the equator, where units of latitude and units of longitude are similar, elevation (z) units can be converted to be compatible by using scale=370400 (if elevation is in feet) or scale=111120 (if elevation is in meters). For locations not near the equator, the \fI\%\-\-xscale\fP value can be taken as the \fI\%\-\-yscale\fP value multiplied by the cosine of the mean latitude of the raster. .SS Standard options .INDENT 0.0 .TP .B \-f, \-\-of, \-\-format, \-\-output\-format Which output raster format to use. Allowed values may be given by \fBgdal \-\-formats | grep raster | grep rw | sort\fP .UNINDENT .INDENT 0.0 .TP .B \-\-co = Many formats have one or more optional creation options that can be used to control particulars about the file created. For instance, the GeoTIFF driver supports creation options to control compression, and whether the file should be tiled. .sp May be repeated. .sp The creation options available vary by format driver, and some simple formats have no creation options at all. A list of options supported for a format can be listed with the \fI\%\-\-formats\fP command line option but the documentation for the format is the definitive source of information on driver creation options. See \fI\%Raster drivers\fP format specific documentation for legal creation options for each format. .UNINDENT .INDENT 0.0 .TP .B \-\-overwrite Allow program to overwrite existing target file or dataset. Otherwise, by default, \fBgdal\fP errors out if the target file or dataset already exists. .UNINDENT .INDENT 0.0 .TP .B \-b, \-\-band Index (starting at 1) of the band to which the hillshade must be computed. .UNINDENT .INDENT 0.0 .TP .B \-z, \-\-zfactor Vertical exaggeration used to pre\-multiply the elevations .UNINDENT .INDENT 0.0 .TP .B \-\-xscale Added in version 3.11. .sp Ratio of vertical units to horizontal X axis units. If the horizontal unit of the source DEM is degrees (e.g Lat/Long WGS84 projection), you can use scale=111120 if the vertical units are meters (or scale=370400 if they are in feet). .sp If none of \fI\%\-\-xscale\fP and \fI\%\-\-yscale\fP are specified, and the CRS is a geographic or projected CRS, \fBgdal raster hillshade\fP will automatically determine the appropriate ratio from the units of the CRS, as well as the potential value of the units of the raster band (as returned by \fBGDALRasterBand::GetUnitsType()\fP, if it is metre, foot international or US survey foot). Note that for geographic CRS, the result for source datasets at high latitudes may be incorrect, and prior reprojection to a polar projection might be needed. .sp If \fI\%\-\-xscale\fP is specified, \fI\%\-\-yscale\fP must also be specified. .UNINDENT .INDENT 0.0 .TP .B \-\-yscale Added in version 3.11. .sp Ratio of vertical units to horizontal Y axis units. If the horizontal unit of the source DEM is degrees (e.g Lat/Long WGS84 projection), you can use scale=111120 if the vertical units are meters (or scale=370400 if they are in feet) .sp If none of \fI\%\-\-xscale\fP and \fI\%\-\-yscale\fP are specified, and the CRS is a geographic or projected CRS, \fBgdal raster hillshade\fP will automatically determine the appropriate ratio from the units of the CRS, as well as the potential value of the units of the raster band (as returned by \fBGDALRasterBand::GetUnitsType()\fP, if it is metre, foot international or US survey foot). Note that for geographic CRS, the result for source datasets at high latitudes may be incorrect, and prior reprojection to a polar projection might be needed. .sp If \fI\%\-\-yscale\fP is specified, \fI\%\-\-xscale\fP must also be specified. .UNINDENT .INDENT 0.0 .TP .B \-\-azimuth Azimuth of the light, in degrees. 0 if it comes from the top of the raster, 90 from the east, ... The default value, 315, should rarely be changed as it is the value generally used to generate shaded maps. .sp This option is mutually exclusive with \fB\-\-variant=multidirectional\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-altitude Altitude of the light, in degrees. 90 if the light comes from above the DEM, 0 if it is raking light. The default value is 45 degree. .sp This option is mutually exclusive with \fB\-\-variant=Igor\fP\&. .UNINDENT .INDENT 0.0 .TP .B \-\-gradient\-alg Horn|ZevenbergenThorne Algorithm used to compute terrain gradient. The default is \fBHorn\fP\&. The literature suggests Zevenbergen & Thorne to be more suited to smooth landscapes, whereas Horn\(aqs formula to perform better on rougher terrain. .UNINDENT .INDENT 0.0 .TP .B \-\-variant regular|combined|multidirectional|Igor Variant of the hillshading algorithm: .INDENT 7.0 .IP \(bu 2 \fBregular\fP: the hillshade values combines the computed slope with the azimuth and altitude of the illumination according to: .INDENT 2.0 .INDENT 3.5 .sp .ce {Hillshade} = 1 + 254.0 * ((\esin(altitude) * cos(slope)) + (cos(altitude) * sin(slope) * cos(azimuth \- \efrac{\epi}{2} \- aspect))) .ce 0 .UNINDENT .UNINDENT .IP \(bu 2 \fBcombined\fP: combined shading, a combination of slope and oblique shading. .IP \(bu 2 \fBmultidirectional\fP: multidirectional shading, a combination of hillshading illuminated from 225 deg, 270 deg, 315 deg, and 360 deg azimuth. Applies the formula of \X'tty: link http://pubs.usgs.gov/of/1992/of92-422/of92-422.pdf'\fI\%http://pubs.usgs.gov/of/1992/of92\-422/of92\-422.pdf\fP\X'tty: link' .IP \(bu 2 \fBIgor\fP: shading which tries to minimize effects on other map features beneath. Igor\(aqs hillshading uses formula from Maperitive: \X'tty: link http://maperitive.net/docs/Commands/GenerateReliefImageIgor.html'\fI\%http://maperitive.net/docs/Commands/GenerateReliefImageIgor.html\fP\X'tty: link' .UNINDENT .UNINDENT .INDENT 0.0 .TP .B \-\-no\-edges Do not try to interpolate values at dataset edges or close to nodata values .UNINDENT .SH GDALG OUTPUT (ON-THE-FLY / STREAMED DATASET) .sp This program supports serializing the command line as a JSON file using the \fBGDALG\fP output format. The resulting file can then be opened as a raster dataset using the \fI\%GDALG: GDAL Streamed Algorithm\fP driver, and apply the specified pipeline in a on\-the\-fly / streamed way. .SH EXAMPLES .SS Example 1: Generates a shaded relief map from a DTED0 file, using a vertical exaggeration factor of 30. .INDENT 0.0 .INDENT 3.5 .sp .EX $ gdal raster hillshade \-\-zfactor=30 n43.dt0 out.tif \-\-overwrite .EE .UNINDENT .UNINDENT .SH AUTHOR Even Rouault .SH COPYRIGHT 1998-2025 .\" Generated by docutils manpage writer. .