man/man1/rsensor.1

.\" RCSid "$Id: rsensor.1,v 1.1 2008/04/15 00:14:22 greg Exp $"
.TH RSENSOR 1 4/11/2008 RADIANCE
.SH NAME
rsensor - compute sensor signal from a RADIANCE scene
.SH SYNOPSIS
.B rsensor
[
.B -n nprocs
][
.B -h
][
.B render options
]
[
.B $EVAR
]
[
.B @file
]
{
[
.B -rd nrays
][
.B -dn nsrc
][
.B sensor_view
]
.B sensor_file ..
}
.B octree
.br
.B "rsensor [ options ] \-defaults"
.SH DESCRIPTION
.I Rsensor
traces rays outward from one or more specified illumination
sensors into the RADIANCE scene given by
.I octree,
sending the computed sensor value to the standard output.
(The octree may be given as the output of a command enclosed in quotes
and preceded by a `!'.)\0
In the second form, the default values
for the options (modified by those options present)
are printed with a brief explanation.
.PP
Options may be given on the command line and/or read from the
environment and/or read from a file.
A command argument beginning with a dollar sign ('$') is immediately
replaced by the contents of the given environment variable.
A command argument beginning with an at sign ('@') is immediately
replaced by the contents of the given file.
.PP
The sensor files themselves will be searched for in the path
locations specified by the
.I RAYPATH
environment variable, similar to other types of Radiance
auxiliary files.
If the sensor file path begins with '/', '.' or '~', no search
will take place.
Before each sensor file, a separate view may be specified.
In this case, the view origin and direction will correspond to
the position and orientation of the sensor, and the view up
vector will determine the zero azimuthal direction of the sensor.
The fore clipping distance may be used as well, but other view
options will be ignored.
(See
.I rpict\.1
for details on how to specify a view.)\0
The actual data contained in the sensor file corresponds to the
.I SPOT
tab-separated matrix specification, where the
column header has "degrees" in the leftmost column, followed
by evenly-spaced azimuthal angles.
Each row begins with the polar angle, and is followed by the
relative sensitivity values for each direction.
A low-resolution example of a sensor file is given below:
.sp
.nf
        degrees 0       90      180     270
        0       .02     .04     .02     .04
        45      .01     .02     .01     .02
        90      .001    .002    .001    .002
.fi
.sp
As well as different views, the number of samples may be changed between
sensors, where the
.I \-rd
option controls the number of ray samples sent at random, and the
.I \-dn
option controls the number of rays sent to light sources per sensor.
.PP
The
.I \-h
option toggles header output, which defaults to "on."
The
.I \-n
option may be used to specify multiple calculation processes on
systems with more than one CPU.
For additional options, consult the
.I rtrace\.1
man page.
The final
.I octree
argument must be given, as the octree cannot be read from the
standard input.
.SH EXAMPLES
To compute values for the same sensor with two different positions:
.IP "" .2i
rsensor -ab 2 -vf posA.vf mysens.dat -vf posB.vf mysens.dat scene.oct
.SH ENVIRONMENT
RAYPATH         the directories to check for auxiliary files.
.SH AUTHOR
Greg Ward for Architectural Energy Corporation
.SH "SEE ALSO"
oconv(1), rpict(1), rtcontrib(1), rtrace(1)
Revision:	1.2
Committed:	Tue Apr 22 02:08:02 2008 UTC (16 years ago) by greg
Branch:	MAIN
CVS Tags:	rad3R9
Changes since 1.1:	+9 -2 lines
Log Message:	Added a few details
#	Content
1	.\" RCSid "$Id: rsensor.1,v 1.1 2008/04/15 00:14:22 greg Exp $"
2	.TH RSENSOR 1 4/11/2008 RADIANCE
3	.SH NAME
4	rsensor - compute sensor signal from a RADIANCE scene
5	.SH SYNOPSIS
6	.B rsensor
7	[
8	.B -n nprocs
9	][
10	.B -h
11	][
12	.B render options
13	]
14	[
15	.B $EVAR
16	]
17	[
18	.B @file
19	]
20	{
21	[
22	.B -rd nrays
23	][
24	.B -dn nsrc
25	][
26	.B sensor_view
27	]
28	.B sensor_file ..
29	}
30	.B octree
31	.br
32	.B "rsensor [ options ] \-defaults"
33	.SH DESCRIPTION
34	.I Rsensor
35	traces rays outward from one or more specified illumination
36	sensors into the RADIANCE scene given by
37	.I octree,
38	sending the computed sensor value to the standard output.
39	(The octree may be given as the output of a command enclosed in quotes
40	and preceded by a `!'.)\0
41	In the second form, the default values
42	for the options (modified by those options present)
43	are printed with a brief explanation.
44	.PP
45	Options may be given on the command line and/or read from the
46	environment and/or read from a file.
47	A command argument beginning with a dollar sign ('$') is immediately
48	replaced by the contents of the given environment variable.
49	A command argument beginning with an at sign ('@') is immediately
50	replaced by the contents of the given file.
51	.PP
52	The sensor files themselves will be searched for in the path
53	locations specified by the
54	.I RAYPATH
55	environment variable, similar to other types of Radiance
56	auxiliary files.
57	If the sensor file path begins with '/', '.' or '~', no search
58	will take place.
59	Before each sensor file, a separate view may be specified.
60	In this case, the view origin and direction will correspond to
61	the position and orientation of the sensor, and the view up
62	vector will determine the zero azimuthal direction of the sensor.
63	The fore clipping distance may be used as well, but other view
64	options will be ignored.
65	(See
66	.I rpict\.1
67	for details on how to specify a view.)\0
68	The actual data contained in the sensor file corresponds to the
69	.I SPOT
70	tab-separated matrix specification, where the
71	column header has "degrees" in the leftmost column, followed
72	by evenly-spaced azimuthal angles.
73	Each row begins with the polar angle, and is followed by the
74	relative sensitivity values for each direction.
75	A low-resolution example of a sensor file is given below:
76	.sp
77	.nf
78	degrees 0 90 180 270
79	0 .02 .04 .02 .04
80	45 .01 .02 .01 .02
81	90 .001 .002 .001 .002
82	.fi
83	.sp
84	As well as different views, the number of samples may be changed between
85	sensors, where the
86	.I \-rd
87	option controls the number of ray samples sent at random, and the
88	.I \-dn
89	option controls the number of rays sent to light sources per sensor.
90	.PP
91	The
92	.I \-h
93	option toggles header output, which defaults to "on."
94	The
95	.I \-n
96	option may be used to specify multiple calculation processes on
97	systems with more than one CPU.
98	For additional options, consult the
99	.I rtrace\.1
100	man page.
101	The final
102	.I octree
103	argument must be given, as the octree cannot be read from the
104	standard input.
105	.SH EXAMPLES
106	To compute values for the same sensor with two different positions:
107	.IP "" .2i
108	rsensor -ab 2 -vf posA.vf mysens.dat -vf posB.vf mysens.dat scene.oct
109	.SH ENVIRONMENT
110	RAYPATH the directories to check for auxiliary files.
111	.SH AUTHOR
112	Greg Ward for Architectural Energy Corporation
113	.SH "SEE ALSO"
114	oconv(1), rpict(1), rtcontrib(1), rtrace(1)