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

Comparing ray/doc/man/man1/rcontrib.1 (file contents):
Revision 1.9 by greg, Sat Jul 19 00:07:03 2014 UTC vs.
Revision 1.26 by greg, Wed Apr 23 15:09:03 2025 UTC

# Line 9 | Line 9 | rcontrib - compute contribution coefficients in a RADI
9   ][
10   .B \-V
11   ][
12 + .B "\-t secs"
13 + ][
14   .B "\-c count"
15   ][
16   .B \-fo
# Line 21 | Line 23 | rcontrib - compute contribution coefficients in a RADI
23   ][
24   .B "\-o ospec"
25   ][
26 + .B "\-p p1=V1,p2=V2"
27 + ][
28   .B "\-b binv"
29   ][
30   .B "\-bn nbins"
# Line 41 | Line 45 | rtrace options
45   .B octree
46   .br
47   .B "rcontrib [ options ] \-defaults"
48 + .br
49 + .B "rcontrib \-features [feat1 ..]"
50   .SH DESCRIPTION
51   .I Rcontrib
52   computes ray coefficients
# Line 117 | Line 123 | Note that output flushing via zero-direction rays is d
123   .I \-c
124   set to zero.
125   .PP
126 + Output flushing at fixed intervals may be enabled with the
127 + .I \-x
128 + option, which specifies the number of records
129 + (-c accumulations) before each flush.
130 + If the
131 + .I \-y
132 + option is also set, then periodic flushing is disabled and the
133 + output size for an RGB image is the taken from the x and y dimensions.
134 + In lieu of periodic flushing, a flush may be forced as mentioned above
135 + by sending a sample with a zero direction vector, although you
136 + must still send a full record of rays before output occurs.
137 + .PP
138 + If progress reports are desired, the
139 + .I \-t
140 + option specifies a time interval in seconds for reports sent to
141 + standard error.
142 + This requires that the number of input samples is known, meaning a
143 + .I \-y
144 + parameter has been specified.
145 + .PP
146   The output of
147   .I rcontrib
148   has many potential uses.
# Line 156 | Line 182 | The
182   option may be used to further define
183   a "bin number" within each object if finer resolution is needed, and
184   this will be applied to a "%d" format in the output file
185 < specification if present.
185 > specification if present.
186 > (The final integer will be offset incrementally
187 > if the output is a RADIANCE picture and more than one modifier has
188 > the same format specification.)\0
189   The actual bin number is computed at run time based on ray direction
190   and surface intersection, as described below.
191   The number of bins must be specified in advance with the
# Line 172 | Line 201 | option.
201   Since bin numbers start from zero, the bin count is always equal to
202   the last bin plus one.
203   The most recent
204 + .I \-p,
205   .I \-b,
206   .I \-bn
207   and
208   .I \-o
209   options to the left of each
210   .I \-m
211 < setting are the ones used for that modifier.
211 > name are the ones used for that modifier.
212 > Any
213 > .I \-cs
214 > option changing the number of spectral color
215 > samples must appear before the first modifier.
216   The ordering of other options is unimportant, except for
217   .I \-x
218   and
# Line 201 | Line 235 | These parameters may be combined with definitions give
235   arguments and files read using the
236   .I \-f
237   option.
238 + Additional parameter values that apply only to this modifier may be specified
239 + with a
240 + .I \-p
241 + option, which contains a list of variable names and assigned values, separated
242 + by commas, colons, or semicolons.
243   The computed bin value will be
244   rounded to the nearest whole number.
245   (Negative bin values will be silently ignored.)\0
# Line 215 | Line 254 | The rules and predefined functions available for these
254   described in the
255   .I rcalc(1)
256   man page.
257 < Like
219 < .I rcalc,
257 > Like the other rendering tools,
258   .I rcontrib
259 < will search the RADIANCE library directories for each file given in a
259 > will search the
260 > .I RAYPATH
261 > library directories for each file given in a
262   .I \-f
263   option.
264 + However, a special evaluation context is set for the
265 + .I \-f
266 + and
267 + .I \-e
268 + definitions, so attach a back-quote ('`') to variable and function names
269 + you wish these to apply at the global evaluation level and used by all
270 + materials and modifiers during rendering.
271   .PP
272   If no
273   .I \-o
# Line 270 | Line 317 | A command argument beginning with a dollar sign ('$')
317   replaced by the contents of the given environment variable.
318   A command argument beginning with an at sign ('@') is immediately
319   replaced by the contents of the given file.
320 + .PP
321 + .I Rcontrib
322 + supports light source contributions from photon maps generated by
323 + .I mkpmap(1)
324 + with its
325 + .I -apC
326 + option. Enabling photon mapping is described in the
327 + .I rtrace
328 + man page along with its relevant settings. In photon mapping mode,
329 + .I rcontrib
330 + only supports contributions from light sources, not arbitrary modifiers.
331 + The
332 + .I -b
333 + option is supported along with its associated ray variables, as
334 + discussed above. Ray coefficients are also supported via the
335 + .I \-V-
336 + option. Using fewer photons than there are light sources for the photon
337 + density estimates results in omitted contributions, thus the bandwidth
338 + is clamped accordingly and a warning is issued.
339   .SH EXAMPLES
340   To compute the proportional contributions from sources modified
341 < by "light1" vs. "light2" on a set of illuminance values:
341 > by "light1" vs. "light2" on a set of irradiance values:
342   .IP "" .2i
343   rcontrib \-I+ @render.opt \-o c_%s.dat \-m light1 \-m light2 scene.oct < test.dat
344   .PP
# Line 288 | Line 354 | of light1 and light2:
354   .IP "" .2i
355   pcomb \-c 100 90 75 c_light1.hdr \-c 50 55 57 c_light2.hdr > combined.hdr
356   .PP
357 < To compute an array of illuminance contributions according to a Tregenza sky:
357 > To compute an array of irradiance contributions according to a Tregenza sky:
358   .IP "" .2i
359   rcontrib \-I+ \-f tregenza.cal \-b tbin \-bn Ntbins \-o sky.dat \-m skyglow
360   \-b 0 \-o ground.dat \-m groundglow @render.opt scene.oct < test.dat
361 + .PP
362 + To perform an annual simulation of 365 daily sun positions in photon mapping
363 + mode:
364 + .IP "" .2i
365 + rcontrib \-I+ \-h \-V \-fo \-o c_%s.dat \-M lights \-ap contrib.pm 365
366 + scene.oct < test.dat,
367   .SH ENVIRONMENT
368   RAYPATH         path to search for \-f and \-M files
369 + .SH BUGS
370 + We do not currently compute contributions or coefficients properly
371 + in scenes with participating media.
372 + A single warning will be issued if a scattering or absorbing medium
373 + is detected.
374   .SH AUTHOR
375   Greg Ward
376   .SH "SEE ALSO"
377 < cnt(1), genklemsamp(1), getinfo(1), pcomb(1), pfilt(1), ra_rgbe(1),
378 < rcalc(1), rpict(1), rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)
377 > cnt(1), dctimestep(1), genklemsamp(1), getinfo(1), mkpmap(1), pcomb(1), pfilt(1),
378 > pvsum(1), ra_rgbe(1), rcalc(1), rcomb(1), rfluxmtx(1), rmtxop(1), rpict(1),
379 > rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)
380 >

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines