--- ray/doc/man/man1/rcontrib.1 2016/09/12 20:31:34 1.13 +++ ray/doc/man/man1/rcontrib.1 2022/10/19 18:23:14 1.20 @@ -1,4 +1,4 @@ -.\" RCSid "$Id: rcontrib.1,v 1.13 2016/09/12 20:31:34 greg Exp $" +.\" RCSid "$Id: rcontrib.1,v 1.20 2022/10/19 18:23:14 greg Exp $" .TH RCONTRIB 1 5/25/05 RADIANCE .SH NAME rcontrib - compute contribution coefficients in a RADIANCE scene @@ -9,6 +9,8 @@ rcontrib - compute contribution coefficients in a RADI ][ .B \-V ][ +.B "\-t secs" +][ .B "\-c count" ][ .B \-fo @@ -119,6 +121,26 @@ Note that output flushing via zero-direction rays is d .I \-c set to zero. .PP +Output flushing at fixed intervals may be enabled with the +.I \-x +option, which specifies the number of records +(-c accumulations) before each flush. +If the +.I \-y +option is also set, then periodic flushing is disabled and the +output size for an RGB image is the taken from the x and y dimensions. +In lieu of periodic flushing, a flush may be forced as mentioned above +by sending a sample with a zero direction vector, although you +must still send a full record of rays before output occurs. +.PP +If progress reports are desired, the +.I \-t +option specifies a time interval in seconds for reports sent to +standard error. +This requires that the number of input samples is known, meaning a +.I \-y +parameter has been specified. +.PP The output of .I rcontrib has many potential uses. @@ -211,7 +233,7 @@ Additional parameter values that apply only to this mo with a .I \-p option, which contains a list of variable names and assigned values, separated -by commas or semicolons. +by commas, colons, or semicolons. The computed bin value will be rounded to the nearest whole number. (Negative bin values will be silently ignored.)\0 @@ -283,12 +305,13 @@ A command argument beginning with an at sign ('@') is replaced by the contents of the given file. .PP .I Rcontrib -has EXPERIMENTAL support for light source contributions from photon maps -generated by +supports light source contributions from photon maps generated by .I mkpmap(1) with its .I -apC -option. In photon mapping mode, +option. Enabling photon mapping is described in the +.I rtrace +man page along with its relevant settings. In photon mapping mode, .I rcontrib only supports contributions from light sources, not arbitrary modifiers. The @@ -298,10 +321,10 @@ discussed above. Ray coefficients are also supported v .I \-V- option. Using fewer photons than there are light sources for the photon density estimates results in omitted contributions, thus the bandwidth -is clamped accordingly and a warning issued. +is clamped accordingly and a warning is issued. .SH EXAMPLES To compute the proportional contributions from sources modified -by "light1" vs. "light2" on a set of illuminance values: +by "light1" vs. "light2" on a set of irradiance values: .IP "" .2i rcontrib \-I+ @render.opt \-o c_%s.dat \-m light1 \-m light2 scene.oct < test.dat .PP @@ -317,7 +340,7 @@ of light1 and light2: .IP "" .2i pcomb \-c 100 90 75 c_light1.hdr \-c 50 55 57 c_light2.hdr > combined.hdr .PP -To compute an array of illuminance contributions according to a Tregenza sky: +To compute an array of irradiance contributions according to a Tregenza sky: .IP "" .2i rcontrib \-I+ \-f tregenza.cal \-b tbin \-bn Ntbins \-o sky.dat \-m skyglow \-b 0 \-o ground.dat \-m groundglow @render.opt scene.oct < test.dat @@ -329,6 +352,11 @@ rcontrib \-I+ \-h \-V \-fo \-o c_%s.dat \-M lights \-a scene.oct < test.dat, .SH ENVIRONMENT RAYPATH path to search for \-f and \-M files +.SH BUGS +We do not currently compute contributions or coefficients properly +in scenes with participating media. +A single warning will be issued if a scattering or absorbing medium +is detected. .SH AUTHOR Greg Ward .SH "SEE ALSO"