ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/rtcontrib.1
(Generate patch)

Comparing ray/doc/man/man1/rtcontrib.1 (file contents):
Revision 1.14 by greg, Tue Oct 11 16:54:26 2005 UTC vs.
Revision 1.17 by greg, Sat Nov 17 01:13:50 2007 UTC

# Line 7 | Line 7 | rtcontrib - compute contribution coefficients in a RAD
7   [
8   .B "\-n nprocs"
9   ][
10 + .B \-V
11 + ][
12 + .B \-c
13 + ][
14   .B \-fo
15   |
16   .B \-r
# Line 39 | Line 43 | rtrace options
43   .B "rtcontrib [ options ] \-defaults"
44   .SH DESCRIPTION
45   .I Rtcontrib
46 < computes ray contributions (i.e., color coefficients)
46 > computes ray coefficients
47   for objects whose modifiers are named in one or more
48   .I \-m
49   settings.
# Line 54 | Line 58 | this file.
58   (No search takes place if a file name begins with a '.', '/' or '~'
59   character.)\0
60   .PP
61 + By setting the boolean
62 + .I \-V
63 + option, you may instruct
64 + .I rtcontrib
65 + to report the contribution from each material rather than the ray
66 + coefficient.
67 + This is particularly useful for light sources with directional output
68 + distributions, whose value would otherwise be lost in the shuffle.
69 + With the default
70 + .I -V-
71 + setting, the output of rtcontrib is a coefficient that must be multiplied
72 + by the radiance of each material to arrive at a final contribution.
73 + This is more convenient for computing daylight coefficeints, or cases
74 + where the actual radiance is not desired.
75 + Use the
76 + .I -V+
77 + setting when you wish to simply sum together contributions
78 + (with possible adjustment factors) to obtain a final radiance value.
79 + Combined with the
80 + .I \-i
81 + or
82 + .I \-I
83 + option, irradiance contributions are reported by
84 + .I \-V+
85 + rather than radiance, and
86 + .I \-V-
87 + coefficients contain an additonal factor of PI.
88 + .PP
89   The output of
90   .I rtcontrib
91   has many potential uses.
# Line 65 | Line 97 | More generally,
97   can be used to compute arbitrary input-output relationships in optical
98   systems, such as luminaires, light pipes, and shading devices.
99   .PP
100 + Setting the
101 + .I \-c
102 + option instructs
103 + .I rtcontrib
104 + to accumulate values rather than reporting one record per ray.
105 + With this option, only a single record will be produced at the very
106 + end, corresponding to the sum of all rays given on the input.
107 + This is equivalent to passing all the output records through a program like
108 + .I total(1)
109 + to sum RGB values together, but is much more efficient.
110 + Using this option, it is possible to reverse sampling, sending rays from
111 + a parallel source such as the sun to a diffuse surface, for example.
112 + Care must be taken to perform normalization based on the
113 + radiation density and the number of rays sampled.
114 + .PP
115   .I Rtcontrib
116   calls
117   .I rtrace(1)
118 < with the -oTW option to calculate the daughter ray
118 > with the \-oTW (or \-oTV) option to calculate the daughter ray
119   contributions for each input ray, and the output tallies
120   are sent to one or more destinations according to the given
121   .I \-o
# Line 82 | Line 129 | option is given.
129   If instead the
130   .I \-r
131   option is specified, data recovery is attempted on existing files.
132 + (If
133 + .I \-c
134 + is used together with the
135 + .I \-r
136 + option, existing files are read in and new ray evaluations are added
137 + to the previous results, providing a convenient means for
138 + progressive simulation.)\0
139   If an output specification contains a "%s" format, this will be
140   replaced by the modifier name.
141   The
# Line 107 | Line 161 | and
161   options to the left of each
162   .I \-m
163   setting affect only that modifier.
164 < (The ordering of other options is unimportant.)\0
164 > The ordering of other options is unimportant, except for
165 > .I \-x
166 > and
167 > .I \-y
168 > if the
169 > .I \-c
170 > is present, when they control the resolution string
171 > produced in the corresponding output.
172   .PP
173   If a
174   .I \-b
# Line 203 | Line 264 | replaced by the contents of the given file.
264   To compute the proportional contributions from sources modified
265   by "light1" vs. "light2" on a set of illuminance values:
266   .IP "" .2i
267 < rtcontrib -I+ @render.opt -o c_%s.dat -m light1 -m light2 scene.oct < test.dat
267 > rtcontrib \-I+ @render.opt \-o c_%s.dat \-m light1 \-m light2 scene.oct < test.dat
268   .PP
269   To generate a pair of images corresponding to these two lights'
270   contributions:
271   .IP "" .2i
272 < vwrays -ff -x 1024 -y 1024 -vf best.vf |
273 < rtcontrib -ffc `vwrays -d -x 1024 -y 1024 -vf best.vf`
274 < @render.opt -o c_%s.pic -m light1 -m light2 scene.oct
272 > vwrays \-ff \-x 1024 \-y 1024 \-vf best.vf |
273 > rtcontrib \-ffc `vwrays \-d \-x 1024 \-y 1024 \-vf best.vf`
274 > @render.opt \-o c_%s.pic \-m light1 \-m light2 scene.oct
275   .PP
276   These images may then be recombined using the desired outputs
277   of light1 and light2:
278   .IP "" .2i
279 < pcomb -c 100 90 75 c_light1.pic -c 50 55 57 c_light2.pic > combined.pic
279 > pcomb \-c 100 90 75 c_light1.pic \-c 50 55 57 c_light2.pic > combined.pic
280   .PP
281   To compute an array of illuminance contributions according to a Tregenza sky:
282   .IP "" .2i
283 < rtcontrib -I+ -b tbin -o sky.dat -m skyglow -b 0 -o ground.dat -m groundglow
284 < @render.opt -f tregenza.cal scene.oct < test.dat
283 > rtcontrib \-I+ \-b tbin \-o sky.dat \-m skyglow \-b 0 \-o ground.dat \-m groundglow
284 > @render.opt \-f tregenza.cal scene.oct < test.dat
285   .SH ENVIRONMENT
286 < RAYPATH         path to search for -f and -M files
286 > RAYPATH         path to search for \-f and \-M files
287   .SH AUTHOR
288   Greg Ward
289   .SH "SEE ALSO"
290   cnt(1), getinfo(1), pcomb(1), pfilt(1), ra_rgbe(1),
291 < rcalc(1), rpict(1), rtrace(1), vwrays(1), ximage(1)
291 > rcalc(1), rpict(1), rtrace(1), total(1), vwrays(1), ximage(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines