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.3 by greg, Thu Jun 14 22:45:23 2012 UTC vs.
Revision 1.14 by rschregle, Fri Jan 26 18:11:50 2018 UTC

# Line 21 | Line 21 | rcontrib - compute contribution coefficients in a RADI
21   ][
22   .B "\-o ospec"
23   ][
24 + .B "\-p p1=V1,p2=V2"
25 + ][
26   .B "\-b binv"
27   ][
28   .B "\-bn nbins"
# Line 61 | Line 63 | character.)\0
63   If the
64   .I \-n
65   option is specified with a value greater than 1, multiple
64 .I rtrace
66   processes will be used to accelerate computation on a shared
67   memory machine.
68   Note that there is no benefit to using more processes
# Line 102 | Line 103 | The
103   option tells
104   .I rcontrib
105   how many rays to accumulate for each record.
106 < The default value is 1, meaning a full record will be produced for
106 > The default value is one, meaning a full record will be produced for
107   each input ray.
108 < For values greater than 1, contributions will be averaged together
108 > For values greater than one, contributions will be averaged together
109   over the given number of input rays.
110   If set to zero, only a single record will be produced at the very
111   end, corresponding to the sum of all rays given on the input
# Line 114 | Line 115 | This is equivalent to passing all the output records t
115   to sum RGB values together, but is much more efficient.
116   Using this option, it is possible to reverse sampling, sending rays from
117   a parallel source such as the sun to a diffuse surface, for example.
118 < Note that output flushing via zero-direction rays is disabled
119 < for accumulated evaluations.
118 > Note that output flushing via zero-direction rays is disabled with
119 > .I \-c
120 > set to zero.
121   .PP
122   The output of
123   .I rcontrib
# Line 129 | Line 131 | can be used to compute arbitrary input-output relation
131   systems, such as luminaires, light pipes, and shading devices.
132   .PP
133   .I Rcontrib
134 < calls
135 < .I rtrace(1)
134 < with the \-oTW (or \-oTV) option to calculate the daughter ray
135 < contributions for each input ray, and the output tallies
136 < are sent to one or more destinations according to the given
134 > sends the accumulated rays tallies
135 > to one or more destinations according to the given
136   .I \-o
137   specification.
138   If a destination begins with an exclamation mark ('!'), then
# Line 159 | Line 158 | The
158   option may be used to further define
159   a "bin number" within each object if finer resolution is needed, and
160   this will be applied to a "%d" format in the output file
161 < specification if present.
161 > specification if present.
162 > (The final integer will be offset incrementally
163 > if the output is a RADIANCE picture and more than one modifier has
164 > the same format specification.)\0
165   The actual bin number is computed at run time based on ray direction
166   and surface intersection, as described below.
167 < If the number of bins is known in advance, it should be specified with the
167 > The number of bins must be specified in advance with the
168   .I \-bn
169   option, and this is critical for output files containing multiple values
170   per record.
# Line 172 | Line 174 | it has been defined via a previous
174   or
175   .I \-e
176   option.
177 < Since bin numbers start from 0, the bin count is always equal to
178 < the last bin plus 1.
177 < Set the this value to 0 if the bin count is unknown (the default).
177 > Since bin numbers start from zero, the bin count is always equal to
178 > the last bin plus one.
179   The most recent
180 + .I \-p,
181   .I \-b,
182   .I \-bn
183   and
# Line 189 | Line 191 | and
191   .I \-y
192   if the
193   .I \-c
194 < is 0, when they control the resolution string
194 > is zero, when they control the resolution string
195   produced in the corresponding output.
196   .PP
197   If a
198   .I \-b
199   expression is defined for a particular modifier,
200   the bin number will be evaluated at run time for each
201 < ray contribution from
200 < .I rtrace.
201 > ray contribution.
202   Specifically, each ray's world intersection point will be assigned to
203   the variables Px, Py, and Pz, and the normalized ray direction
204   will be assigned to Dx, Dy, and Dz.
# Line 206 | Line 207 | These parameters may be combined with definitions give
207   arguments and files read using the
208   .I \-f
209   option.
210 + Additional parameter values that apply only to this modifier may be specified
211 + with a
212 + .I \-p
213 + option, which contains a list of variable names and assigned values, separated
214 + by commas or semicolons.
215   The computed bin value will be
216   rounded to the nearest whole number.
217 + (Negative bin values will be silently ignored.)\0
218 + For a single bin, you may specify
219 + .I "\-b 0",
220 + which is the default.
221   This mechanism allows the user to define precise regions or directions
222   they wish to accumulate, such as the Tregenza sky discretization,
223   which would be otherwise impossible to specify
# Line 216 | Line 226 | The rules and predefined functions available for these
226   described in the
227   .I rcalc(1)
228   man page.
229 < Unlike
229 > Like
230   .I rcalc,
231   .I rcontrib
232   will search the RADIANCE library directories for each file given in a
# Line 271 | Line 281 | A command argument beginning with a dollar sign ('$')
281   replaced by the contents of the given environment variable.
282   A command argument beginning with an at sign ('@') is immediately
283   replaced by the contents of the given file.
284 + .PP
285 + .I Rcontrib
286 + supports light source contributions from photon maps generated by
287 + .I mkpmap(1)
288 + with its
289 + .I -apC
290 + option. In photon mapping mode,
291 + .I rcontrib
292 + only supports contributions from light sources, not arbitrary modifiers.
293 + The
294 + .I -b
295 + option is supported along with its associated ray variables, as
296 + discussed above. Ray coefficients are also supported via the
297 + .I \-V-
298 + option. Using fewer photons than there are light sources for the photon
299 + density estimates results in omitted contributions, thus the bandwidth
300 + is clamped accordingly and a warning issued.
301   .SH EXAMPLES
302   To compute the proportional contributions from sources modified
303   by "light1" vs. "light2" on a set of illuminance values:
# Line 291 | Line 318 | pcomb \-c 100 90 75 c_light1.hdr \-c 50 55 57 c_light2
318   .PP
319   To compute an array of illuminance contributions according to a Tregenza sky:
320   .IP "" .2i
321 < rcontrib \-I+ \-b tbin \-o sky.dat \-m skyglow \-b 0 \-o ground.dat \-m groundglow
322 < @render.opt \-f tregenza.cal scene.oct < test.dat
321 > rcontrib \-I+ \-f tregenza.cal \-b tbin \-bn Ntbins \-o sky.dat \-m skyglow
322 > \-b 0 \-o ground.dat \-m groundglow @render.opt scene.oct < test.dat
323 > .PP
324 > To perform an annual simulation of 365 daily sun positions in photon mapping
325 > mode:
326 > .IP "" .2i
327 > rcontrib \-I+ \-h \-V \-fo \-o c_%s.dat \-M lights \-ap contrib.pm 365
328 > scene.oct < test.dat,
329   .SH ENVIRONMENT
330   RAYPATH         path to search for \-f and \-M files
331   .SH AUTHOR
332   Greg Ward
333   .SH "SEE ALSO"
334 < cnt(1), genklemsamp(1), getinfo(1), pcomb(1), pfilt(1), ra_rgbe(1),
335 < rcalc(1), rpict(1), rsensor(1), rtrace(1), total(1), vwrays(1), ximage(1)
334 > cnt(1), genklemsamp(1), getinfo(1), mkpmap(1), pcomb(1), pfilt(1),
335 > ra_rgbe(1), rcalc(1), rfluxmtx(1), rmtxop(1), rpict(1), rsensor(1),
336 > rtrace(1), total(1), vwrays(1), ximage(1)
337 >

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines