.TH r.sunmask 1grass "" "GRASS 6.4.2" "Grass User's Manual"
.SH NAME
\fI\fBr.sunmask\fR\fR  - Calculates cast shadow areas from sun position and elevation raster map.
.br
Either exact sun position (A) is specified, or date/time to calculate the sun position (B) by r.sunmask itself.
.SH KEYWORDS
raster, sun position
.SH SYNOPSIS
\fBr.sunmask\fR
.br
\fBr.sunmask help\fR
.br
\fBr.sunmask\fR [-\fBzvsg\fR] \fBelevation\fR=\fIname\fR  [\fBoutput\fR=\fIname\fR]   [\fBaltitude\fR=\fIfloat\fR]   [\fBazimuth\fR=\fIfloat\fR]   [\fByear\fR=\fIinteger\fR]   [\fBmonth\fR=\fIinteger\fR]   [\fBday\fR=\fIinteger\fR]   [\fBhour\fR=\fIinteger\fR]   [\fBminute\fR=\fIinteger\fR]   [\fBsecond\fR=\fIinteger\fR]   [\fBtimezone\fR=\fIinteger\fR]   [\fBeast\fR=\fIvalue\fR]   [\fBnorth\fR=\fIvalue\fR]   [--\fBoverwrite\fR]  [--\fBverbose\fR]  [--\fBquiet\fR] 
.SS Flags:
.IP "\fB-z\fR" 4m
.br
Don't ignore zero elevation
.IP "\fB-v\fR" 4m
.br
Verbose output (also print out sun position etc.)
.IP "\fB-s\fR" 4m
.br
Calculate sun position only and exit
.IP "\fB-g\fR" 4m
.br
Print the sun position output in shell script style
.IP "\fB--overwrite\fR" 4m
.br
Allow output files to overwrite existing files
.IP "\fB--verbose\fR" 4m
.br
Verbose module output
.IP "\fB--quiet\fR" 4m
.br
Quiet module output
.PP
.SS Parameters:
.IP "\fBelevation\fR=\fIname\fR" 4m
.br
Name of elevation raster map
.IP "\fBoutput\fR=\fIname\fR" 4m
.br
Name for output raster map
.IP "\fBaltitude\fR=\fIfloat\fR" 4m
.br
Altitude of the sun above horizon, degrees (A)
.br
Options: \fI0-89.999\fR
.IP "\fBazimuth\fR=\fIfloat\fR" 4m
.br
Azimuth of the sun from the north, degrees (A)
.br
Options: \fI0-360\fR
.IP "\fByear\fR=\fIinteger\fR" 4m
.br
Year (B)
.br
Options: \fI1950-2050\fR
.IP "\fBmonth\fR=\fIinteger\fR" 4m
.br
Month (B)
.br
Options: \fI0-12\fR
.IP "\fBday\fR=\fIinteger\fR" 4m
.br
Day (B)
.br
Options: \fI0-31\fR
.IP "\fBhour\fR=\fIinteger\fR" 4m
.br
Hour (B)
.br
Options: \fI0-24\fR
.IP "\fBminute\fR=\fIinteger\fR" 4m
.br
Minutes (B)
.br
Options: \fI0-60\fR
.IP "\fBsecond\fR=\fIinteger\fR" 4m
.br
Seconds (B)
.br
Options: \fI0-60\fR
.IP "\fBtimezone\fR=\fIinteger\fR" 4m
.br
Timezone
.br
East positive, offset from GMT, also use to adjust daylight savings
.IP "\fBeast\fR=\fIvalue\fR" 4m
.br
Easting coordinate (point of interest)
.br
Default: map center
.IP "\fBnorth\fR=\fIvalue\fR" 4m
.br
Northing coordinate (point of interest)
.br
Default: map center
.PP
.SH DESCRIPTION
\fIr.sunmask\fR creates an output map layer based on an input elevation
raster map layer and the sun position. The output map layer contains the
cast shadow areas arising from sun shine and elevations. The user can define
the sun position either directly or the module calculates it from given
location and date/time parameters using the
NREL sun position algorithm. So either
\(dqA:"-parameters to specify the exact known sun position or "B:-parameters"
to specify date/time for sun position calculation by r.sunmask itself have
to be used.
.PP
The module performs sunset/sunrise checks and refraction correction for sun
position calculation. Local coordinate systems are internally transformed to
latitude/longitude for the SOLPOS algorithm. The elevation is not considered
in the sunset/sunrise calculations.
.SH Notes
r.sunmask and daylight savings: Rather than convert time to GMT, the solpos
algorithm uses what is called Local Standard Time, which is generally
defined politically as an offset from GMT.  So the key is the offset from
GMT, which the solpos Time Zone parameter.  If the user specifies clock time
(different for winter and summer), he/she would have to change the Time Zone
parameter seasonally in r.sunmask (timezone parameter).
.PP
Note: In latitude/longitude locations the position coordinates pair
(east/west) has to be specified in decimal degree (not D:M:S). If
not specified, the map center's coordinates will be used.
Also \fIg.region -l\fR displays the map center's coordinates.
.PP
Note for module usage with \fI-g\fR flag and calculations
close to sunset/sunrise:
\fC
.DS
.br
 [...]
.br
 sunangleabovehorizont=0.434240
.br
 sunrise=07:59:19
.br
 sunset=16:25:17
.br
 Time (07:59:02) is before sunrise (07:59:19)!
.br
 WARNING: Nothing to calculate. Please verify settings.
.br
 No map calculation requested. Finished.
.br
.DE
\fR
In above calculation appears to be a mistake as
the program indicates that we are before sunrise while
the \fIsun angle above horizon\fR is already positive.
The reason is that \fIsun angle above horizon\fR is
calculated with correction for atmosphere refraction while
\fIsunrise\fR and \fIsunset\fR are calculated \fBwithout\fR
correction for atmosphere refraction. The output without 
\fI-g\fR flag contains related indications.
.SH Acknowledgements
Acknowledgements: National Renewable Energy Laboratory for their SOLPOS 2.0 sun position
algorithm.
.SH SEE ALSO
\fI
g.region,
r.sun,
r.slope.aspect
\fR
.SH AUTHOR
Janne Soimasuo, Finland 1994
.br
update to FP by Huidae Cho 2001
.br
added solpos algorithm feature by Markus Neteler 2001
.PP
\fILast changed: $Date: 2008-05-16 21:09:06 +0200 (Fri, 16 May 2008) $\fR
.PP
Full index
.PP
© 2003-2011 GRASS Development Team