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.6 by greg, Thu Nov 15 19:41:03 2012 UTC vs.
Revision 1.19 by greg, Thu Sep 10 17:52:46 2020 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 117 | Line 121 | Note that output flushing via zero-direction rays is d
121   .I \-c
122   set to zero.
123   .PP
124 + Output flushing at fixed intervals may be enabled with the
125 + .I \-x
126 + option, which specifies the number of records
127 + (-c accumulations) before each flush.
128 + If the
129 + .I \-y
130 + option is also set, then periodic flushing is disabled and the
131 + output size for an RGB image is the taken from the x and y dimensions.
132 + In lieu of periodic flushing, a flush may be forced as mentioned above
133 + by sending a sample with a zero direction vector, although you
134 + must still send a full record of rays before output occurs.
135 + .PP
136 + If progress reports are desired, the
137 + .I \-t
138 + option specifies a time interval in seconds for reports sent to
139 + standard error.
140 + This requires that the number of input samples is known, meaning a
141 + .I \-y
142 + parameter has been specified.
143 + .PP
144   The output of
145   .I rcontrib
146   has many potential uses.
# Line 156 | Line 180 | The
180   option may be used to further define
181   a "bin number" within each object if finer resolution is needed, and
182   this will be applied to a "%d" format in the output file
183 < specification if present.
183 > specification if present.
184 > (The final integer will be offset incrementally
185 > if the output is a RADIANCE picture and more than one modifier has
186 > the same format specification.)\0
187   The actual bin number is computed at run time based on ray direction
188   and surface intersection, as described below.
189   The number of bins must be specified in advance with the
# Line 171 | Line 198 | or
198   option.
199   Since bin numbers start from zero, the bin count is always equal to
200   the last bin plus one.
174 Set the this value to zero if the bin count is unknown (the default).
201   The most recent
202 + .I \-p,
203   .I \-b,
204   .I \-bn
205   and
# Line 202 | Line 229 | These parameters may be combined with definitions give
229   arguments and files read using the
230   .I \-f
231   option.
232 + Additional parameter values that apply only to this modifier may be specified
233 + with a
234 + .I \-p
235 + option, which contains a list of variable names and assigned values, separated
236 + by commas, colons, or semicolons.
237   The computed bin value will be
238   rounded to the nearest whole number.
239 + (Negative bin values will be silently ignored.)\0
240 + For a single bin, you may specify
241 + .I "\-b 0",
242 + which is the default.
243   This mechanism allows the user to define precise regions or directions
244   they wish to accumulate, such as the Tregenza sky discretization,
245   which would be otherwise impossible to specify
# Line 212 | Line 248 | The rules and predefined functions available for these
248   described in the
249   .I rcalc(1)
250   man page.
251 < Unlike
251 > Like
252   .I rcalc,
253   .I rcontrib
254   will search the RADIANCE library directories for each file given in a
# Line 267 | Line 303 | A command argument beginning with a dollar sign ('$')
303   replaced by the contents of the given environment variable.
304   A command argument beginning with an at sign ('@') is immediately
305   replaced by the contents of the given file.
306 + .PP
307 + .I Rcontrib
308 + supports light source contributions from photon maps generated by
309 + .I mkpmap(1)
310 + with its
311 + .I -apC
312 + option. Enabling photon mapping is described in the
313 + .I rtrace
314 + man page along with its relevant settings. In photon mapping mode,
315 + .I rcontrib
316 + only supports contributions from light sources, not arbitrary modifiers.
317 + The
318 + .I -b
319 + option is supported along with its associated ray variables, as
320 + discussed above. Ray coefficients are also supported via the
321 + .I \-V-
322 + option. Using fewer photons than there are light sources for the photon
323 + density estimates results in omitted contributions, thus the bandwidth
324 + is clamped accordingly and a warning is issued.
325   .SH EXAMPLES
326   To compute the proportional contributions from sources modified
327   by "light1" vs. "light2" on a set of illuminance values:
# Line 287 | Line 342 | pcomb \-c 100 90 75 c_light1.hdr \-c 50 55 57 c_light2
342   .PP
343   To compute an array of illuminance contributions according to a Tregenza sky:
344   .IP "" .2i
345 < rcontrib \-I+ \-b tbin \-o sky.dat \-m skyglow \-b 0 \-o ground.dat \-m groundglow
346 < @render.opt \-f tregenza.cal scene.oct < test.dat
345 > rcontrib \-I+ \-f tregenza.cal \-b tbin \-bn Ntbins \-o sky.dat \-m skyglow
346 > \-b 0 \-o ground.dat \-m groundglow @render.opt scene.oct < test.dat
347 > .PP
348 > To perform an annual simulation of 365 daily sun positions in photon mapping
349 > mode:
350 > .IP "" .2i
351 > rcontrib \-I+ \-h \-V \-fo \-o c_%s.dat \-M lights \-ap contrib.pm 365
352 > scene.oct < test.dat,
353   .SH ENVIRONMENT
354   RAYPATH         path to search for \-f and \-M files
355 + .SH BUGS
356 + We do not currently compute contributions or coefficients properly
357 + in scenes with participating media.
358 + A single warning will be issued if a scattering or absorbing medium
359 + is detected.
360   .SH AUTHOR
361   Greg Ward
362   .SH "SEE ALSO"
363 < cnt(1), genklemsamp(1), getinfo(1), pcomb(1), pfilt(1), ra_rgbe(1),
364 < rcalc(1), rpict(1), rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)
363 > cnt(1), genklemsamp(1), getinfo(1), mkpmap(1), pcomb(1), pfilt(1),
364 > ra_rgbe(1), rcalc(1), rfluxmtx(1), rmtxop(1), rpict(1), rsensor(1),
365 > rtrace(1), total(1), vwrays(1), ximage(1)
366 >

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines