--- ray/doc/man/man1/rcontrib.1 2019/02/22 19:42:27 1.16 +++ ray/doc/man/man1/rcontrib.1 2025/04/23 15:09:03 1.26 @@ -1,4 +1,4 @@ -.\" RCSid "$Id: rcontrib.1,v 1.16 2019/02/22 19:42:27 greg Exp $" +.\" RCSid "$Id: rcontrib.1,v 1.26 2025/04/23 15:09:03 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 @@ -43,6 +45,8 @@ rtrace options .B octree .br .B "rcontrib [ options ] \-defaults" +.br +.B "rcontrib \-features [feat1 ..]" .SH DESCRIPTION .I Rcontrib computes ray coefficients @@ -119,6 +123,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. @@ -184,7 +208,11 @@ and .I \-o options to the left of each .I \-m -setting are the ones used for that modifier. +name are the ones used for that modifier. +Any +.I \-cs +option changing the number of spectral color +samples must appear before the first modifier. The ordering of other options is unimportant, except for .I \-x and @@ -211,7 +239,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 @@ -226,12 +254,20 @@ The rules and predefined functions available for these described in the .I rcalc(1) man page. -Like -.I rcalc, +Like the other rendering tools, .I rcontrib -will search the RADIANCE library directories for each file given in a +will search the +.I RAYPATH +library directories for each file given in a .I \-f option. +However, a special evaluation context is set for the +.I \-f +and +.I \-e +definitions, so attach a back-quote ('`') to variable and function names +you wish these to apply at the global evaluation level and used by all +materials and modifiers during rendering. .PP If no .I \-o @@ -302,7 +338,7 @@ density estimates results in omitted contributions, th 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 @@ -318,7 +354,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 @@ -338,7 +374,7 @@ is detected. .SH AUTHOR Greg Ward .SH "SEE ALSO" -cnt(1), genklemsamp(1), getinfo(1), mkpmap(1), pcomb(1), pfilt(1), -ra_rgbe(1), rcalc(1), rfluxmtx(1), rmtxop(1), rpict(1), rsensor(1), -rtrace(1), total(1), vwrays(1), ximage(1) +cnt(1), dctimestep(1), genklemsamp(1), getinfo(1), mkpmap(1), pcomb(1), pfilt(1), +pvsum(1), ra_rgbe(1), rcalc(1), rcomb(1), rfluxmtx(1), rmtxop(1), rpict(1), +rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)