This tool creates an animated GIF of shadows based on an input DEM.
Usage
wbt_shadow_animation(
input,
output,
palette = "atlas",
max_dist = "",
date = "21/06/2021",
interval = 15,
location = "43.5448/-80.2482/-4",
height = 600,
delay = 250,
label = "",
wd = NULL,
verbose_mode = NULL,
compress_rasters = NULL,
command_only = FALSE
)
Arguments
- input
Name of the input digital surface model (DSM) raster file.
- output
Name of the output HTML file (*.html).
- palette
DSM image palette; options are 'atlas', 'high_relief', 'arid', 'soft', 'muted', 'light_quant', 'purple', 'viridis', 'gn_yl', 'pi_y_g', 'bl_yl_rd', 'deep', and 'none'.
- max_dist
Optional maximum search distance, in xy units. Minimum value is 5 x cell size.
- date
Date in format DD/MM/YYYY.
- interval
Time interval, in minutes (1-60).
- location
Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4).
- height
Image height, in pixels.
- delay
GIF time delay in milliseconds.
- label
Label text (leave blank for none).
- wd
Changes the working directory. Default:
NULL
will use the value in WhiteboxTools settings, seewbt_wd()
for details.- verbose_mode
Sets verbose mode. If verbose mode is
FALSE
, tools will not print output messages. Default:NULL
will use the value in WhiteboxTools settings, seewbt_verbose()
for details.- compress_rasters
Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default:
NULL
will use the value in WhiteboxTools settings, seewbt_compress_rasters()
for details.- command_only
Return command that would be executed by
system()
rather than running tool. Default:FALSE
.