--- ray/doc/man/man1/rcontrib.1 2012/06/14 22:44:50 1.2 +++ ray/doc/man/man1/rcontrib.1 2014/07/19 00:07:03 1.9 @@ -1,4 +1,4 @@ -.\" RCSid "$Id: rcontrib.1,v 1.2 2012/06/14 22:44:50 greg Exp $" +.\" RCSid "$Id: rcontrib.1,v 1.9 2014/07/19 00:07:03 greg Exp $" .TH RCONTRIB 1 5/25/05 RADIANCE .SH NAME rcontrib - compute contribution coefficients in a RADIANCE scene @@ -42,7 +42,7 @@ rtrace options .br .B "rcontrib [ options ] \-defaults" .SH DESCRIPTION -.I Rtcontrib +.I Rcontrib computes ray coefficients for objects whose modifiers are named in one or more .I \-m @@ -61,7 +61,6 @@ character.)\0 If the .I \-n option is specified with a value greater than 1, multiple -.I rtrace processes will be used to accelerate computation on a shared memory machine. Note that there is no benefit to using more processes @@ -102,9 +101,9 @@ The option tells .I rcontrib how many rays to accumulate for each record. -The default value is 1, meaning a full record will be produced for +The default value is one, meaning a full record will be produced for each input ray. -For values greater than 1, contributions will be averaged together +For values greater than one, contributions will be averaged together over the given number of input rays. If set to zero, only a single record will be produced at the very end, corresponding to the sum of all rays given on the input @@ -114,8 +113,9 @@ This is equivalent to passing all the output records t to sum RGB values together, but is much more efficient. Using this option, it is possible to reverse sampling, sending rays from a parallel source such as the sun to a diffuse surface, for example. -Note that output flushing via zero-direction rays is disabled -for accumulated evaluations. +Note that output flushing via zero-direction rays is disabled with +.I \-c +set to zero. .PP The output of .I rcontrib @@ -128,12 +128,9 @@ More generally, can be used to compute arbitrary input-output relationships in optical systems, such as luminaires, light pipes, and shading devices. .PP -.I Rtcontrib -calls -.I rtrace(1) -with the \-oTW (or \-oTV) option to calculate the daughter ray -contributions for each input ray, and the output tallies -are sent to one or more destinations according to the given +.I Rcontrib +sends the accumulated rays tallies +to one or more destinations according to the given .I \-o specification. If a destination begins with an exclamation mark ('!'), then @@ -162,7 +159,7 @@ this will be applied to a "%d" format in the output fi specification if present. The actual bin number is computed at run time based on ray direction and surface intersection, as described below. -If the number of bins is known in advance, it should be specified with the +The number of bins must be specified in advance with the .I \-bn option, and this is critical for output files containing multiple values per record. @@ -172,9 +169,8 @@ it has been defined via a previous or .I \-e option. -Since bin numbers start from 0, the bin count is always equal to -the last bin plus 1. -Set the this value to 0 if the bin count is unknown (the default). +Since bin numbers start from zero, the bin count is always equal to +the last bin plus one. The most recent .I \-b, .I \-bn @@ -189,15 +185,14 @@ and .I \-y if the .I \-c -is 0, when they control the resolution string +is zero, when they control the resolution string produced in the corresponding output. .PP If a .I \-b expression is defined for a particular modifier, the bin number will be evaluated at run time for each -ray contribution from -.I rtrace. +ray contribution. Specifically, each ray's world intersection point will be assigned to the variables Px, Py, and Pz, and the normalized ray direction will be assigned to Dx, Dy, and Dz. @@ -208,6 +203,10 @@ arguments and files read using the option. The computed bin value will be rounded to the nearest whole number. +(Negative bin values will be silently ignored.)\0 +For a single bin, you may specify +.I "\-b 0", +which is the default. This mechanism allows the user to define precise regions or directions they wish to accumulate, such as the Tregenza sky discretization, which would be otherwise impossible to specify @@ -216,7 +215,7 @@ The rules and predefined functions available for these described in the .I rcalc(1) man page. -Unlike +Like .I rcalc, .I rcontrib will search the RADIANCE library directories for each file given in a @@ -291,8 +290,8 @@ pcomb \-c 100 90 75 c_light1.hdr \-c 50 55 57 c_light2 .PP To compute an array of illuminance contributions according to a Tregenza sky: .IP "" .2i -rcontrib \-I+ \-b tbin \-o sky.dat \-m skyglow \-b 0 \-o ground.dat \-m groundglow -@render.opt \-f tregenza.cal scene.oct < test.dat +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 .SH ENVIRONMENT RAYPATH path to search for \-f and \-M files .SH AUTHOR