wbt_shadow_image

This tool creates a raster of shadow areas based on an input DEM.

GeomorphometricAnalysis

An R frontend for the 'WhiteboxTools' library, which is an advanced geospatial data analysis platform developed by Prof. John Lindsay at the University of Guelph's Geomorphometry and Hydrogeomatics Research Group. 'WhiteboxTools' can be used to perform common geographical information systems (GIS) analysis operations, such as cost-distance analysis, distance buffering, and raster reclassification. Remote sensing and image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), and common image transformations. 'WhiteboxTools' also contains advanced tooling for spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices such as slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), and LiDAR data processing. Suggested citation: Lindsay (2016) <doi:10.1016/j.cageo.2016.07.003>.

Andrew Brown

whitebox

'WhiteboxTools' R Frontend

Qiusheng Wu

wbt_shadow_image function

<dl><dt>input</dt>
<dd>Name of the input digital surface model (DSM) raster file.</dd>
<dt>output</dt>
<dd>Name of the output raster file.</dd>
<dt>palette</dt>
<dd>DSM image palette; options are 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', and 'none'.</dd>
<dt>max_dist</dt>
<dd>Optional maximum search distance, in xy unites. Minimum value is 5 x cell size.</dd>
<dt>date</dt>
<dd>Date in format DD/MM/YYYY.</dd>
<dt>time</dt>
<dd>Time in format HH::MM, e.g. 03:15AM or 14:30.</dd>
<dt>location</dt>
<dd>Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4).</dd>
<dt>wd</dt>
<dd>Changes the working directory.</dd>
<dt>verbose_mode</dt>
<dd>Sets verbose mode. If verbose mode is <code>FALSE</code>, tools will not print output messages.</dd>
<dt>compress_rasters</dt>
<dd>Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.</dd>
<dt>command_only</dt>
<dd>Return command that would be executed by <code><a href="/link/system()?package=whitebox&version=2.3.1" data-mini-rdoc="whitebox::system()">system()</a></code> rather than running tool.</dd></dl>

Arguments

Shadow image — wbt_shadow_image

<dl>

<dt>input</dt>
<dd>Name of the input digital surface model (DSM) raster file.</dd>


<dt>output</dt>
<dd>Name of the output raster file.</dd>


<dt>palette</dt>
<dd>DSM image palette; options are 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridi', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', and 'none'.</dd>


<dt>max_dist</dt>
<dd>Optional maximum search distance, in xy unites. Minimum value is 5 x cell size.</dd>


<dt>date</dt>
<dd>Date in format DD/MM/YYYY.</dd>


<dt>time</dt>
<dd>Time in format HH::MM, e.g. 03:15AM or 14:30.</dd>


<dt>location</dt>
<dd>Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4).</dd>


<dt>wd</dt>
<dd>Changes the working directory.</dd>


<dt>verbose_mode</dt>
<dd>Sets verbose mode. If verbose mode is <code>FALSE</code>, tools will not print output messages.</dd>


<dt>compress_rasters</dt>
<dd>Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.</dd>


<dt>command_only</dt>
<dd>Return command that would be executed by <code><a href='https://rdrr.io/r/base/system.html'>system()</a></code> rather than running tool.</dd>

</dl>

wbt_shadow_image: Shadow image

Description

Usage

Value

Arguments