shade_ambient: Function for calculation of ambient shading on raster data

Description Usage Arguments Value

Description

This function is just a wrapper around ambient_shade that supports directly using Raster in the function. The function also tries to set "reasonable" default values for parameters.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
shade_ambient_date_time(
  surface_raster,
  date = as.character(Sys.Date()),
  time = "noon",
  tzone = "UTC",
  rays_number = 36,
  search_distance = 200,
  z_value = 1,
  verbose = FALSE
)

shade_ambient_sun_position(
  surface_raster,
  sun_elevation = 45,
  rays_number = 36,
  search_distance = 200,
  z_value = 1,
  verbose = FALSE
)

Arguments

surface_raster

Object of class Raster.

date

Date specified as character in form YYYY-MM-DD. Default value is Sys.Date.

time

Either character representation of time (in format HH:MM:SS), or hms class, or one of text values: "noon", "sunrise", "sunset", "goldenHour", "goldenHourEnd". The textual representation is used to determine sun elevation using function getSunlightPosition. Value "sunrise" represents end of sunrise, while "sunset" represents start of sunset. Default value is "noon".

tzone

a character string that specifies which time zone to parse the date with. The string must be a time zone that is recognized by the user's OS. If no time zone is given the default value "UTC" is used. Default value "UTC".

rays_number

Number of rays that are calculated around each pixel. Default value is 36, which means that one ray per 10 degrees of orientation.

search_distance

Distance in which sun blocking objects are searched for, specified in map units. Default value is 200 map units.

z_value

numeric value indicating the scale between xy and z. Typical use is if the distance is measured in meters and elevation in foots, in such case the z value needs to be recalculated to meters. Default value is 1, which means that both measures use the same units.

verbose

Should informative message be printed? Default FALSE.

sun_elevation

Numeric value, from range 0 - 90, with 0 being sun elevation directly on horizon while 90 means that sun is directly above the surface.

Value

Object of class Raster.


JanCaha/rasterShade documentation built on Dec. 16, 2019, 3:46 p.m.