ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/rsensor.1
Revision: 1.1
Committed: Tue Apr 15 00:14:22 2008 UTC (16 years, 1 month ago) by greg
Branch: MAIN
Log Message:
Created man page for rsensor

File Contents

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