Learn R Programming
whitebox (version 2.1.0)

wbt_shadow_image: Shadow image

Description

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

Usage

wbt_shadow_image(
  input,
  output,
  palette = "soft",
  max_dist = "",
  date = "21/06/2021",
  time = "1300",
  location = "43.5448/-80.2482/-4",
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE
)

Arguments

input

Name of the input digital surface model (DSM) raster file.

output

Name of the output raster file.

palette

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'.

max_dist

Optional maximum search distance, in xy unites. Minimum value is 5 x cell size.

date

Date in format DD/MM/YYYY.

time

Time in format HH::MM, e.g. 03:15AM or 14:30.

location

Location, defined as Lat/Long/UTC-offset (e.g. 43.5448/-80.2482/-4).

wd

Changes the working directory.

verbose_mode

Sets verbose mode. If verbose mode is False, tools will not print output messages.

compress_rasters

Sets the flag used by WhiteboxTools to determine whether to use compression for output rasters.

Value

Returns the tool text outputs.