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

Comparing ray/doc/man/man1/rtrace.1 (file contents):
Revision 1.17 by greg, Wed Mar 11 02:27:26 2009 UTC vs.
Revision 1.34 by greg, Wed Jan 8 21:18:51 2020 UTC

# 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 111 | Line 113 | 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
# Line 199 | 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 230 | 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 312 | 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 338 | 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.
349 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 379 | 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 487 | Line 527 | Same as
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 525 | 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 sets the upper limit
657 < of reflections past which Russian roulette will not be used.
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
# Line 609 | 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
# Line 628 | Line 753 | To compute an image with an unusual view mapping:
753   .IP "" .2i
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 illuminance 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
# Line 645 | 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), rtcontrib(1), rvu(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
> Changed lines