wbt_time_in_daylight {whitebox} | R Documentation |
Calculates the proportion of time a location is within an area of shadow.
wbt_time_in_daylight( dem, output, lat, long, az_fraction = 10, max_dist = 100, utc_offset = "0000", start_day = 1, end_day = 365, start_time = "000000", end_time = "235959", wd = NULL, verbose_mode = FALSE )
dem |
Input raster DEM file. |
output |
Output raster file. |
lat |
Centre point latitude. |
long |
Centre point longitude. |
az_fraction |
Azimuth fraction in degrees. |
max_dist |
Optional maximum search distance. Minimum value is 5 x cell size. |
utc_offset |
UTC time offset, in hours (e.g. -04:00, +06:00). |
start_day |
Start day of the year (1-365). |
end_day |
End day of the year (1-365). |
start_time |
Starting hour to track shadows (e.g. 5, 5:00, 05:00:00). Assumes 24-hour time: HH:MM:SS. 'sunrise' is also a valid time. |
end_time |
Starting hour to track shadows (e.g. 21, 21:00, 21:00:00). Assumes 24-hour time: HH:MM:SS. 'sunset' is also a valid time. |
wd |
Changes the working directory. |
verbose_mode |
Sets verbose mode. If verbose mode is False, tools will not print output messages. |
Returns the tool text outputs.