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.4 by greg, Thu Jun 14 22:49:34 2012 UTC vs.
Revision 1.22 by greg, Wed Dec 6 01:27:00 2023 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 101 | Line 107 | The
107   option tells
108   .I rcontrib
109   how many rays to accumulate for each record.
110 < The default value is 1, meaning a full record will be produced for
110 > The default value is one, meaning a full record will be produced for
111   each input ray.
112 < For values greater than 1, contributions will be averaged together
112 > For values greater than one, contributions will be averaged together
113   over the given number of input rays.
114   If set to zero, only a single record will be produced at the very
115   end, corresponding to the sum of all rays given on the input
# Line 113 | Line 119 | This is equivalent to passing all the output records t
119   to sum RGB values together, but is much more efficient.
120   Using this option, it is possible to reverse sampling, sending rays from
121   a parallel source such as the sun to a diffuse surface, for example.
122 < Note that output flushing via zero-direction rays is disabled
123 < for accumulated evaluations.
122 > Note that output flushing via zero-direction rays is disabled with
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 155 | 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 < If the number of bins is known in advance, it should be specified with the
191 > The number of bins must be specified in advance with the
192   .I \-bn
193   option, and this is critical for output files containing multiple values
194   per record.
# Line 168 | Line 198 | it has been defined via a previous
198   or
199   .I \-e
200   option.
201 < Since bin numbers start from 0, the bin count is always equal to
202 < the last bin plus 1.
173 < Set the this value to 0 if the bin count is unknown (the default).
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
# Line 185 | Line 215 | and
215   .I \-y
216   if the
217   .I \-c
218 < is 0, when they control the resolution string
218 > is zero, when they control the resolution string
219   produced in the corresponding output.
220   .PP
221   If a
# Line 201 | Line 231 | These parameters may be combined with definitions give
231   arguments and files read using the
232   .I \-f
233   option.
234 + Additional parameter values that apply only to this modifier may be specified
235 + with a
236 + .I \-p
237 + option, which contains a list of variable names and assigned values, separated
238 + by commas, colons, or semicolons.
239   The computed bin value will be
240   rounded to the nearest whole number.
241 + (Negative bin values will be silently ignored.)\0
242 + For a single bin, you may specify
243 + .I "\-b 0",
244 + which is the default.
245   This mechanism allows the user to define precise regions or directions
246   they wish to accumulate, such as the Tregenza sky discretization,
247   which would be otherwise impossible to specify
# Line 211 | Line 250 | The rules and predefined functions available for these
250   described in the
251   .I rcalc(1)
252   man page.
253 < Unlike
253 > Like
254   .I rcalc,
255   .I rcontrib
256   will search the RADIANCE library directories for each file given in a
# Line 266 | Line 305 | A command argument beginning with a dollar sign ('$')
305   replaced by the contents of the given environment variable.
306   A command argument beginning with an at sign ('@') is immediately
307   replaced by the contents of the given file.
308 + .PP
309 + .I Rcontrib
310 + supports light source contributions from photon maps generated by
311 + .I mkpmap(1)
312 + with its
313 + .I -apC
314 + option. Enabling photon mapping is described in the
315 + .I rtrace
316 + man page along with its relevant settings. In photon mapping mode,
317 + .I rcontrib
318 + only supports contributions from light sources, not arbitrary modifiers.
319 + The
320 + .I -b
321 + option is supported along with its associated ray variables, as
322 + discussed above. Ray coefficients are also supported via the
323 + .I \-V-
324 + option. Using fewer photons than there are light sources for the photon
325 + density estimates results in omitted contributions, thus the bandwidth
326 + is clamped accordingly and a warning is issued.
327   .SH EXAMPLES
328   To compute the proportional contributions from sources modified
329 < by "light1" vs. "light2" on a set of illuminance values:
329 > by "light1" vs. "light2" on a set of irradiance values:
330   .IP "" .2i
331   rcontrib \-I+ @render.opt \-o c_%s.dat \-m light1 \-m light2 scene.oct < test.dat
332   .PP
# Line 284 | Line 342 | of light1 and light2:
342   .IP "" .2i
343   pcomb \-c 100 90 75 c_light1.hdr \-c 50 55 57 c_light2.hdr > combined.hdr
344   .PP
345 < To compute an array of illuminance contributions according to a Tregenza sky:
345 > To compute an array of irradiance contributions according to a Tregenza sky:
346   .IP "" .2i
347 < rcontrib \-I+ \-b tbin \-o sky.dat \-m skyglow \-b 0 \-o ground.dat \-m groundglow
348 < @render.opt \-f tregenza.cal scene.oct < test.dat
347 > rcontrib \-I+ \-f tregenza.cal \-b tbin \-bn Ntbins \-o sky.dat \-m skyglow
348 > \-b 0 \-o ground.dat \-m groundglow @render.opt scene.oct < test.dat
349 > .PP
350 > To perform an annual simulation of 365 daily sun positions in photon mapping
351 > mode:
352 > .IP "" .2i
353 > rcontrib \-I+ \-h \-V \-fo \-o c_%s.dat \-M lights \-ap contrib.pm 365
354 > scene.oct < test.dat,
355   .SH ENVIRONMENT
356   RAYPATH         path to search for \-f and \-M files
357 + .SH BUGS
358 + We do not currently compute contributions or coefficients properly
359 + in scenes with participating media.
360 + A single warning will be issued if a scattering or absorbing medium
361 + is detected.
362   .SH AUTHOR
363   Greg Ward
364   .SH "SEE ALSO"
365 < cnt(1), genklemsamp(1), getinfo(1), pcomb(1), pfilt(1), ra_rgbe(1),
366 < rcalc(1), rpict(1), rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)
365 > cnt(1), genklemsamp(1), getinfo(1), mkpmap(1), pcomb(1), pfilt(1),
366 > ra_rgbe(1), rcalc(1), rfluxmtx(1), rmtxcomb(1), rmtxop(1), rpict(1),
367 > rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)
368 >

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines