ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/Development/ray/doc/man/man1/rtrace.1
(Generate patch)

Comparing ray/doc/man/man1/rtrace.1 (file contents):
Revision 1.2 by greg, Fri Apr 18 17:29:21 2003 UTC vs.
Revision 1.35 by greg, Wed Oct 19 18:23:14 2022 UTC

# Line 1 | Line 1
1 < .\" RCSid "$Id"
1 > .\" RCSid "$Id$"
2   .TH RTRACE 1 10/17/97 RADIANCE
3   .SH NAME
4   rtrace - trace rays in RADIANCE scene
# Line 30 | Line 30 | Input for each ray is:
30   If the direction vector is (0,0,0), a bogus record
31   is printed and the output is flushed if the
32   .I -x
33 < value is unset or zero.
33 > value is one or zero.
34   (See the notes on this option below.)\0
35   This may be useful for programs that run
36   .I rtrace
# Line 68 | Line 68 | understands the following input and output formats:  '
68   ascii, 'f' for single-precision floating point,
69   and 'd' for double-precision floating point.
70   In addition to these three choices, the character 'c' may be used
71 < to denote 4-byte floating point (Radiance) color format
72 < for the output of values only
73 < .I (\-ov
74 < option, below).
71 > to denote 4-byte RGBE (Radiance) color format
72 > for the output of individual color values only, and the
73 > .I \-x
74 > and
75 > .I \-y
76 > options should also be specified to create a valid output picture.
77   If the output character is missing, the input format is used.
78   .IP
79   Note that there is no space between this option and its argument.
# Line 87 | Line 89 | d      direction (normalized)
89   .IP
90   v       value (radiance)
91   .IP
92 + V       contribution (radiance)
93 + .IP
94   w       weight
95   .IP
96 + W       color coefficient
97 + .IP
98   l       effective length of ray
99   .IP
100   L       first intersection distance
# Line 105 | Line 111 | s      surface name
111   .IP
112   m       modifier name
113   .IP
114 + M       material name
115 + .IP
116 + r       mirrored value contribution
117 + .IP
118 + x       unmirrored value contribution
119 + .IP
120 + R       mirrored ray length
121 + .IP
122 + X       unmirrored ray length
123 + .IP
124 + ~       tilde (end of trace marker)
125 + .IP
126   If the letter 't' appears in
127   .I spec,
128   then the fields following will be printed for every ray traced,
129   not just the final result.
130 + If the capital letter 'T' is given instead of 't', then all rays will
131 + be reported, including shadow testing rays to light sources.
132   Spawned rays are indented one tab for each level.
133 + The tilde marker ('~') is a handy way of differentiating the final ray
134 + value from daughter values in a traced ray tree, and usually appears
135 + right before the 't' or 'T' output flags.
136 + E.g.,
137 + .I \-ov~TmW
138 + will emit a tilde followed by a tab at the end of each trace,
139 + which can be easily distinguished even in binary output.
140   .IP
141   Note that there is no space between this option and its argument.
142   .TP
143 < .BI -te \ mat
143 > .BI -te \ mod
144   Append
145 < .I mat
145 > .I mod
146   to the trace exclude list,
147   so that it will not be reported by the trace option
148   .I (\-o*t*).
149   Any ray striking an object having
150 < .I mat
150 > .I mod
151   as its modifier will not be reported to the standard output with
152   the rest of the rays being traced.
153 < This option has no effect unless the 't' option has been given as
154 < part of the output specifier.
155 < Any number of excluded materials may be given, but each
153 > This option has no effect unless either the 't' or 'T'
154 > option has been given as part of the output specifier.
155 > Any number of excluded modifiers may be given, but each
156   must appear in a separate option.
157   .TP
158 < .BI -ti \ mat
158 > .BI -ti \ mod
159   Add
160 < .I mat
160 > .I mod
161   to the trace include list,
162 < so that it will be considered during the indirect calculation.
162 > so that it will be reported by the trace option.
163   The program can use either an include list or an exclude
164   list, but not both.
165   .TP
166   .BI -tE \ file
167   Same as
168   .I \-te,
169 < except read materials to be excluded from
169 > except read modifiers to be excluded from
170   .I file.
171   The RAYPATH environment variable determines which directories are
172   searched for this file.
173 < The material names are separated by white space in the file.
173 > The modifier names are separated by white space in the file.
174   .TP
175   .BI -tI \ file
176   Same as
177   .I \-ti,
178 < except read materials to be included from
178 > except read modifiers to be included from
179   .I file.
180   .TP
181   .BR \-i
# Line 161 | Line 188 | though the
188   .I \-dv
189   option (below) may be used to override this.
190   This option is especially useful in
191 < conjunction with ximage(1) for computing illuminance at scene points.
191 > conjunction with ximage(1) for computing irradiance at scene points.
192   .TP
193 + .BR \-u
194 + Boolean switch to control uncorrelated random sampling.
195 + When "off", a low-discrepancy sequence is used, which reduces
196 + variance but can result in a brushed appearance in specular highlights.
197 + When "on", pure Monte Carlo sampling is used in all calculations.
198 + .TP
199   .BR \-I
200   Boolean switch to compute irradiance rather than radiance,
201   with the input origin and direction interpreted instead
# Line 176 | Line 209 | Set the x resolution to
209   .I res.
210   The output will be flushed after every
211   .I res
212 < input rays.
212 > input rays if
213 > .I \-y
214 > is set to zero.
215 > A value of one means that every ray will be flushed, whatever
216 > the setting of
217 > .I \-y.
218   A value of zero means that no output flushing will take place.
219   .TP
220   .BI -y \ res
# Line 207 | Line 245 | format.
245   .I \-f
246   option, above.)
247   .TP
248 + .BI -n \ nproc
249 + Execute in parallel on
250 + .I nproc
251 + local processes.
252 + This option is incompatible with the
253 + .I \-P
254 + and
255 + .I \-PP,
256 + options.
257 + Multiple processes also do not work properly with ray tree output
258 + using any of the
259 + .I \-o*t*
260 + options.
261 + There is no benefit from specifying more processes than there are
262 + cores available on the system or the
263 + .I \-x
264 + setting, which forces a wait at each flush.
265 + .TP
266   .BI -dj \ frac
267   Set the direct jittering to
268   .I frac.
# Line 261 | Line 317 | change greater than the
317   specification will be calculated.
318   .TP
319   .BI -dr \ N
320 < Set the number of relays for secondary sources to
320 > Set the number of relays for virtual sources to
321   .I N.
322 < A value of 0 means that secondary sources will be ignored.
322 > A value of 0 means that virtual sources will be ignored.
323   A value of 1 means that sources will be made into first generation
324 < secondary sources; a value of 2 means that first generation
325 < secondary sources will also be made into second generation secondary
324 > virtual sources; a value of 2 means that first generation
325 > virtual sources will also be made into second generation virtual
326   sources, and so on.
327   .TP
328   .BI -dp \ D
329 < Set the secondary source presampling density to D.
329 > Set the virtual source presampling density to D.
330   This is the number of samples per steradian
331   that will be used to determine ahead of time whether or not
332   it is worth following shadow rays through all the reflections and/or
333 < transmissions associated with a secondary source path.
334 < A value of 0 means that the full secondary source path will always
333 > transmissions associated with a virtual source path.
334 > A value of 0 means that the full virtual source path will always
335   be tested for shadows if it is tested at all.
336   .TP
337   .BR \-dv
# Line 289 | Line 345 | may also be desirable in conjunction with the
345   .I \-i
346   option.
347   .TP
348 < .BI -sj \ frac
349 < Set the specular sampling jitter to
350 < .I frac.
351 < This is the degree to which the highlights are sampled
352 < for rough specular materials.
353 < A value of one means that all highlights will be fully sampled
354 < using distributed ray tracing.
348 > .BI -ss \ samp
349 > Set the specular sampling to
350 > .I samp.
351 > For values less than 1, this is the degree to which the highlights
352 > are sampled for rough specular materials.
353 > A value greater than one causes multiple ray samples to be sent
354 > to reduce noise at a commmesurate cost.
355   A value of zero means that no jittering will take place, and all
356   reflections will appear sharp even when they should be diffuse.
357   .TP
# Line 315 | Line 371 | accuracy and rendering time.
371   .TP
372   .BR -bv
373   Boolean switch for back face visibility.
374 < With this switch off, back faces of opaque objects will be invisible
375 < to all rays.
374 > With this switch off, back faces of all objects will be invisible
375 > to view rays.
376   This is dangerous unless the model was constructed such that
377 < all surface normals on opaque objects face outward.
377 > all surface normals face outward.
378   Although turning off back face visibility does not save much
379   computation time under most circumstances, it may be useful as a
380   tool for scene debugging, or for seeing through one-sided walls from
381   the outside.
326 This option has no effect on transparent or translucent materials.
382   .TP
383   .BI -av " red grn blu"
384   Set the ambient value to a radiance of
# Line 356 | Line 411 | indirect contributions, such as when both indoor and o
411   .BI -ab \ N
412   Set the number of ambient bounces to
413   .I N.
414 < This is the maximum number of diffuse bounces
415 < computed by the indirect calculation.
416 < A value of zero implies no indirect calculation.
414 > This is the maximum number of diffuse bounces computed by the indirect
415 > calculation. A value of zero implies no indirect calculation.
416 > .IP
417 > This value defaults to 1 in photon mapping mode (see
418 > .I -ap
419 > below), implying that global photon irradiance is always computed via
420 > .I one
421 > ambient bounce; this behaviour applies to any positive number of ambient
422 > bounces, regardless of the actual value specified.  A negative value enables
423 > a preview mode that directly visualises the irradiance from the global
424 > photon map without any ambient bounces.
425   .TP
426   .BI -ar \ res
427   Set the ambient resolution to
# Line 381 | Line 444 | option on the input octree.
444   Set the ambient accuracy to
445   .I acc.
446   This value will approximately equal the error
447 < from indirect illuminance interpolation.
447 > from indirect irradiance interpolation.
448   A value of zero implies no interpolation.
449   .TP
450   .BI -ad \ N
451   Set the number of ambient divisions to
452   .I N.
453   The error in the Monte Carlo calculation of indirect
454 < illuminance will be inversely proportional to the square
454 > irradiance will be inversely proportional to the square
455   root of this number.
456   A value of zero implies no indirect calculation.
457   .TP
# Line 401 | Line 464 | show a significant change.
464   .BI -af \ fname
465   Set the ambient file to
466   .I fname.
467 < This is where indirect illuminance will be stored and retrieved.
468 < Normally, indirect illuminance values are kept in memory and
467 > This is where indirect irradiance will be stored and retrieved.
468 > Normally, indirect irradiance values are kept in memory and
469   lost when the program finishes or dies.
470 < By using a file, different invocations can share illuminance
470 > By using a file, different invocations can share irradiance
471   values, saving time in the computation.
472   The ambient file is in a machine-independent binary format
473   which can be examined with
# Line 427 | Line 490 | header of the ambient file.
490   .I Getinfo(1)
491   may be used to print out this information.
492   .TP
493 < .BI -ae \ mat
493 > .BI -ae \ mod
494   Append
495 < .I mat
495 > .I mod
496   to the ambient exclude list,
497   so that it will not be considered during the indirect calculation.
498   This is a hack for speeding the indirect computation by
499   ignoring certain objects.
500   Any object having
501 < .I mat
501 > .I mod
502   as its modifier will get the default ambient
503   level rather than a calculated value.
504 < Any number of excluded materials may be given, but each
504 > Any number of excluded modifiers may be given, but each
505   must appear in a separate option.
506   .TP
507 < .BI -ai \ mat
507 > .BI -ai \ mod
508   Add
509 < .I mat
509 > .I mod
510   to the ambient include list,
511   so that it will be considered during the indirect calculation.
512   The program can use either an include list or an exclude
# Line 452 | Line 515 | list, but not both.
515   .BI -aE \ file
516   Same as
517   .I \-ae,
518 < except read materials to be excluded from
518 > except read modifiers to be excluded from
519   .I file.
520   The RAYPATH environment variable determines which directories are
521   searched for this file.
522 < The material names are separated by white space in the file.
522 > The modifier names are separated by white space in the file.
523   .TP
524   .BI -aI \ file
525   Same as
526   .I \-ai,
527 < except read materials to be included from
527 > except read modifiers to be included from
528   .I file.
529   .TP
530 + .BI -ap " file [bwidth1 [bwidth2]]"
531 + Enable photon mapping mode. Loads a photon map generated with
532 + .I mkpmap(1)
533 + from
534 + .I file,
535 + and evaluates the indirect irradiance depending on the photon type
536 + (automagically detected) using density estimates with a bandwidth of
537 + .I bwidth1
538 + photons, or the default bandwidth if none is specified (a warning will be
539 + issued in this case).
540 + .IP
541 + Global photon irradiance is evaluated as part of the ambient calculation (see
542 + .I \-ab
543 + above), caustic photon irradiance is evaluated at primary rays, and
544 + indirect inscattering in
545 + .I mist
546 + is accounted for by volume photons. Contribution photons are treated as
547 + global photons by
548 + .I rtrace.
549 + .IP
550 + Additionally specifying
551 + .I bwidth2
552 + enables bias compensation for the density estimates with a
553 + minimum and maximum bandwidth of
554 + .I bwidth1
555 + and
556 + .I bwidth2,
557 + respectively.
558 + .IP
559 + Global photon irradiance may be optionally precomputed by
560 + .I mkpmap(1),
561 + in which case the bandwidth, if specified, is ignored, as the nearest photon
562 + is invariably looked up.
563 + .IP
564 + Using direct photons replaces the direct calculation with density estimates
565 + for debugging and validation of photon emission.      
566 + .TP
567 + .BI -am " frac"
568 + Maximum search radius for photon map lookups.  Without this option, an
569 + initial maximum search radius is estimated for each photon map from the
570 + average photon distance to the distribution's centre of gravity.  It is then
571 + adapted to the photon density in subsequent lookups.  This option imposes a
572 + global fixed maximum search radius for
573 + .I all
574 + photon maps, thus defeating the automatic adaptation.  It is useful when
575 + multiple warnings about short photon lookups are issued.  Note that this
576 + option does not conflict with the bandwidth specified with the
577 + .I \-ap
578 + option; the number of photons found will not exceed the latter, but may be
579 + lower if the maximum search radius contains fewer photons, thus resulting in
580 + short lookups.  Setting this radius too large, on the other hand, may
581 + degrade performance.
582 + .TP
583 + .BI -ac " pagesize"
584 + Set the photon cache page size when using out-of-core photon mapping. The
585 + photon cache reduces disk I/O incurred by on-demand loading (paging) of
586 + photons, and thus increases performance. This
587 + is expressed as a (float) multiple of the density estimate bandwidth
588 + specified with
589 + .I \-ap
590 + under the assumption that photon lookups are local to a cache page. Cache
591 + performance is sensitive to this parameter: larger pagesizes will reduce the
592 + paging frequency at the expense of higher latency when paging does occur.
593 + Sensible values are in the range 4 (default) to 16.
594 + .TP
595 + .BI -aC " cachesize"
596 + Set the total number of photons cached when using out-of-core photon
597 + mapping, taking into account the pagesize specified by
598 + .I \-ac.
599 + Note that this is approximate as the number of cache pages is rounded to
600 + the nearest prime. This allows adapting the cache to the available physical
601 + memory. In conjunction with the
602 + .I \-n
603 + option, this is the cache size
604 + .I per parallel process.
605 + Cache performance is less sensitive to this parameter,
606 + and reasonable performance can obtained with as few as 10k photons. The
607 + default is 1M. This option recognises multiplier suffixes (k = 1e3, M =
608 + 1e6), both in upper and lower case.
609 + .TP
610   .BI -me " rext gext bext"
611   Set the global medium extinction coefficient to the indicated color,
612   in units of 1/distance (distance in world coordinates).
# Line 502 | Line 645 | source within a given scattering volume.
645   .TP
646   .BI -lr \ N
647   Limit reflections to a maximum of
648 < .I N.
648 > .I N,
649 > if N is a positive integer.
650 > If
651 > .I N
652 > is zero or negative, then Russian roulette is used for ray
653 > termination, and the
654 > .I -lw
655 > setting (below) must be positive.
656 > If N is a negative integer, then this limits the maximum
657 > number of reflections even with Russian roulette.
658 > In scenes with dielectrics and total internal reflection,
659 > a setting of 0 (no limit) may cause a stack overflow.
660   .TP
661   .BI -lw \ frac
662   Limit the weight of each ray to a minimum of
663   .I frac.
664 < During ray-tracing, a record is kept of the final contribution
665 < a ray would have to the image.
666 < If it is less then the specified minimum, the ray is not traced.
664 > During ray-tracing, a record is kept of the estimated contribution
665 > (weight) a ray would have in the image.
666 > If this weight is less than the specified minimum and the
667 > .I -lr
668 > setting (above) is positive, the ray is not traced.
669 > Otherwise, Russian roulette is used to
670 > continue rays with a probability equal to the ray weight
671 > divided by the given
672 > .I frac.
673   .TP
674   .BR -ld
675   Boolean switch to limit ray distance.
# Line 570 | Line 730 | This provides a simple and reliable mechanism of memor
730   on most multiprocessing platforms, since the
731   .I fork(2)
732   system call will share memory on a copy-on-write basis.
733 + .SH NOTES
734 + Photons are generally surface bound (an exception are volume photons), thus
735 + the ambient irradiance in photon mapping mode will be biased at positions
736 + which do not lie on a surface.
737   .SH EXAMPLES
738   To compute radiance values for the rays listed in samples.inp:
739   .IP "" .2i
740 < rtrace -ov scene.oct < samples.inp > radiance.out
740 > rtrace \-ov scene.oct < samples.inp > radiance.out
741   .PP
742 < To compute illuminance values at locations selected with the 't'
742 > To compute irradiance values at locations selected with the 't'
743   command of
744   .I ximage(1):
745   .IP "" .2i
746 < ximage scene.pic | rtrace -h -x 1 -i scene.oct | rcalc -e '$1=47.4*$1+120*$2+11.6*$3'
746 > ximage scene.hdr | rtrace \-h \-x 1 \-i scene.oct | rcalc \-e '$1=47.4*$1+120*$2+11.6*$3'
747   .PP
748   To record the object identifier corresponding to each pixel in an image:
749   .IP "" .2i
750 < vwrays -fd scene.pic | rtrace -fda `vwrays -d scene.pic` -os scene.oct
750 > vwrays \-fd scene.hdr | rtrace \-fda `vwrays \-d scene.hdr` \-os scene.oct
751   .PP
752   To compute an image with an unusual view mapping:
753   .IP "" .2i
754 < cnt 640 480 | rcalc -e 'xr:640;yr:480' -f unusual_view.cal | rtrace
755 < -x 640 -y 480 -fac scene.oct > unusual.pic
754 > cnt 480 640 | rcalc \-e 'xr:640;yr:480' \-f unusual_view.cal | rtrace
755 > \-x 640 \-y 480 \-fac scene.oct > unusual.hdr
756 > .PP
757 > To compute ambient irradiance in photon mapping mode from a global photon
758 > map global.pm via one ambient bounce, and from a caustic photon map
759 > caustic.pm at sensor positions in samples.inp:
760 > .IP "" .2i
761 > rtrace -h -ov -ab 1 -ap global.pm 50 -ap caustic.pm 50 scene.oct <
762 > samples.inp > illum.out
763   .SH ENVIRONMENT
764   RAYPATH         the directories to check for auxiliary files.
765   .SH FILES
766 < /usr/tmp/rtXXXXXX               common header information for picture sequence
766 > /tmp/rtXXXXXX           common header information for picture sequence
767   .SH DIAGNOSTICS
768   If the program terminates from an input related error, the exit status
769   will be 1.
# Line 606 | Line 777 | option.
777   .SH AUTHOR
778   Greg Ward
779   .SH "SEE ALSO"
780 < getinfo(1), lookamb(1), oconv(1), pfilt(1), pinterp(1),
781 < pvalue(1), rpict(1), rview(1), vwrays(1), ximage(1)
780 > getinfo(1), lookamb(1), mkpmap(1), oconv(1), pfilt(1), pinterp(1),
781 > pvalue(1), rcontrib(1), rsplit(1),
782 > rpict(1), rtpict(1), rvu(1), vwrays(1), ximage(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)