shade_lambert: Function for calculation of lambert shading (also known as...

Description Usage Arguments Value

Description

This function is just a wrapper around lamb_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
shade_lambert_date_time(
  surface_raster,
  date = as.character(Sys.Date()),
  time = "noon",
  tzone = "UTC",
  only_facing_sun = FALSE,
  z_value = 1,
  verbose = FALSE
)

shade_lambert_sun_position(
  surface_raster,
  sun_elevation = 45,
  sun_azimuth = 180,
  only_facing_sun = FALSE,
  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".

only_facing_sun

Boolean value specifing if the value should be determined for all parts of the surface or only for parts oriented towards sun. Default value is FALSE, which means that it is calculated for all parts of the surface.

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. Default value is 45.

sun_azimuth

Numeric value that specifies azimuth from which the sun is shining on the surface. Value has to be from the range 0 - 360. Default value is 180.

Value

Object of class Raster.


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