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.30 by greg, Tue Mar 20 02:40:38 2018 UTC vs.
Revision 1.40 by greg, Tue Dec 12 16:31:45 2023 UTC

# Line 16 | Line 16 | rtrace - trace rays in RADIANCE scene
16   .B octree
17   .br
18   .B "rtrace [ options ] \-defaults"
19 + .br
20 + .B "rtrace \-features [feat1 ..]"
21   .SH DESCRIPTION
22   .I Rtrace
23   traces rays from the standard input through the RADIANCE scene given by
# Line 35 | Line 37 | value is one or zero.
37   This may be useful for programs that run
38   .I rtrace
39   as a separate process.
40 < In the second form, the default values
40 > .PP
41 > In the second form shown above, the default values
42   for the options (modified by those options present)
43   are printed with a brief explanation.
44   .PP
45 + In the third form, a list of supported features is sent
46 + to the standard output, one per line.
47 + If additional arguments follow, they are checked for presence in
48 + this list.
49 + If a feature includes subfeatures, these may be checked as well by
50 + specifying:
51 + .nf
52 +
53 +        rtrace -features FeatName=subfeat1,subfeat2
54 +
55 + .fi
56 + If any named feature or subfeature is missing, an error is
57 + reported and the program returns an error status.
58 + If all of the named features are present, a zero status is returned.
59 + .PP
60   Options may be given on the command line and/or read from the
61   environment and/or read from a file.
62   A command argument beginning with a dollar sign ('$') is immediately
# Line 68 | Line 86 | understands the following input and output formats:  '
86   ascii, 'f' for single-precision floating point,
87   and 'd' for double-precision floating point.
88   In addition to these three choices, the character 'c' may be used
89 < to denote 4-byte floating point (Radiance) color format
90 < for the output of values only
91 < .I (\-ov
92 < option, below).
89 > to denote 4-byte RGBE (Radiance) color format
90 > for the output of individual color values only, and the
91 > .I \-x
92 > and
93 > .I \-y
94 > options should also be specified to create a valid output picture.
95   If the output character is missing, the input format is used.
96   .IP
97   Note that there is no space between this option and its argument.
# Line 111 | Line 131 | m      modifier name
131   .IP
132   M       material name
133   .IP
134 + r       mirrored value contribution
135 + .IP
136 + x       unmirrored value contribution
137 + .IP
138 + R       mirrored ray length
139 + .IP
140 + X       unmirrored ray length
141 + .IP
142   ~       tilde (end of trace marker)
143   .IP
144   If the letter 't' appears in
# Line 178 | Line 206 | though the
206   .I \-dv
207   option (below) may be used to override this.
208   This option is especially useful in
209 < conjunction with ximage(1) for computing illuminance at scene points.
209 > conjunction with ximage(1) for computing irradiance at scene points.
210   .TP
211   .BR \-u
212   Boolean switch to control uncorrelated random sampling.
# Line 307 | Line 335 | change greater than the
335   specification will be calculated.
336   .TP
337   .BI -dr \ N
338 < Set the number of relays for secondary sources to
338 > Set the number of relays for virtual sources to
339   .I N.
340 < A value of 0 means that secondary sources will be ignored.
340 > A value of 0 means that virtual sources will be ignored.
341   A value of 1 means that sources will be made into first generation
342 < secondary sources; a value of 2 means that first generation
343 < secondary sources will also be made into second generation secondary
342 > virtual sources; a value of 2 means that first generation
343 > virtual sources will also be made into second generation virtual
344   sources, and so on.
345   .TP
346   .BI -dp \ D
347 < Set the secondary source presampling density to D.
347 > Set the virtual source presampling density to D.
348   This is the number of samples per steradian
349   that will be used to determine ahead of time whether or not
350   it is worth following shadow rays through all the reflections and/or
351 < transmissions associated with a secondary source path.
352 < A value of 0 means that the full secondary source path will always
351 > transmissions associated with a virtual source path.
352 > A value of 0 means that the full virtual source path will always
353   be tested for shadows if it is tested at all.
354   .TP
355   .BR \-dv
# Line 434 | Line 462 | option on the input octree.
462   Set the ambient accuracy to
463   .I acc.
464   This value will approximately equal the error
465 < from indirect illuminance interpolation.
465 > from indirect irradiance interpolation.
466   A value of zero implies no interpolation.
467   .TP
468   .BI -ad \ N
469   Set the number of ambient divisions to
470   .I N.
471   The error in the Monte Carlo calculation of indirect
472 < illuminance will be inversely proportional to the square
472 > irradiance will be inversely proportional to the square
473   root of this number.
474   A value of zero implies no indirect calculation.
475   .TP
# Line 454 | Line 482 | show a significant change.
482   .BI -af \ fname
483   Set the ambient file to
484   .I fname.
485 < This is where indirect illuminance will be stored and retrieved.
486 < Normally, indirect illuminance values are kept in memory and
485 > This is where indirect irradiance will be stored and retrieved.
486 > Normally, indirect irradiance values are kept in memory and
487   lost when the program finishes or dies.
488 < By using a file, different invocations can share illuminance
488 > By using a file, different invocations can share irradiance
489   values, saving time in the computation.
490   The ambient file is in a machine-independent binary format
491   which can be examined with
# Line 643 | Line 671 | is zero or negative, then Russian roulette is used for
671   termination, and the
672   .I -lw
673   setting (below) must be positive.
674 < If N is a negative integer, then this sets the upper limit
675 < of reflections past which Russian roulette will be used.
674 > If N is a negative integer, then this limits the maximum
675 > number of reflections even with Russian roulette.
676   In scenes with dielectrics and total internal reflection,
677   a setting of 0 (no limit) may cause a stack overflow.
678   .TP
# Line 661 | Line 689 | continue rays with a probability equal to the ray weig
689   divided by the given
690   .I frac.
691   .TP
692 < .BR -ld
692 > .BR \-ld
693   Boolean switch to limit ray distance.
694   If this option is set, then rays will only be traced as far as the
695   magnitude of each direction vector.
696   Otherwise, vector magnitude is ignored and rays are traced to infinity.
697   .TP
698 + .BI -cs \ Ns
699 + Use
700 + .I Ns
701 + bands for spectral sampling rather than the default RGB calculation space.
702 + The maximum setting is controlled by the compiler macro MAXCSAMP, and
703 + defaults to 24.
704 + Larger values for Ns will be reduced to MAXCSAMP.
705 + .TP
706 + .BI -cw " nmA nmB"
707 + Set extrema to the given wavelengths for spectral sampling.
708 + The default is 380 and 780 nanometers.
709 + The order specified does not matter.
710 + .TP
711 + .BR \-co
712 + Boolean switch turns on spectral data output if selected.
713 + The default is to reduce spectral results to RGB, but see the related
714 + .I \-p*
715 + options, below.
716 + .TP
717 + .BI -pc " xr yr xg yg xb yb xw yw"
718 + Use the specified chromaticity pairs for output primaries and white
719 + point rather than the standard RGB color space.
720 + .TP
721 + .BR \-pRGB
722 + Output standard RGB values (the default).
723 + .TP
724 + .BR \-pXYZ
725 + Output standard CIE XYZ tristimulus values rather than RGB.
726 + .TP
727 + .BR \-pY
728 + Produce a single output channel corresponding to photopic luminance.
729 + .TP
730 + .BR \-pS
731 + Produce a single output channel corresponding to scotopic luminance.
732 + .TP
733 + .BR \-pM
734 + Produce a single output channel corresponding to melanopic luminance.
735 + .TP
736   .BI -e \ efile
737   Send error messages and progress reports to
738   .I efile
# Line 729 | Line 795 | To compute radiance values for the rays listed in samp
795   .IP "" .2i
796   rtrace \-ov scene.oct < samples.inp > radiance.out
797   .PP
798 < To compute illuminance values at locations selected with the 't'
798 > To compute irradiance values at locations selected with the 't'
799   command of
800   .I ximage(1):
801   .IP "" .2i
# Line 744 | Line 810 | To compute an image with an unusual view mapping:
810   cnt 480 640 | rcalc \-e 'xr:640;yr:480' \-f unusual_view.cal | rtrace
811   \-x 640 \-y 480 \-fac scene.oct > unusual.hdr
812   .PP
813 < To compute ambient illuminance in photon mapping mode from a global photon
813 > To compute ambient irradiance in photon mapping mode from a global photon
814   map global.pm via one ambient bounce, and from a caustic photon map
815   caustic.pm at sensor positions in samples.inp:
816   .IP "" .2i
# Line 767 | Line 833 | option.
833   .SH AUTHOR
834   Greg Ward
835   .SH "SEE ALSO"
836 < getinfo(1), lookamb(1), mkpmap(1), oconv(1), pfilt(1), pinterp(1),
837 < pvalue(1), rcontrib(1), rpict(1), rtpict(1), rvu(1), vwrays(1), ximage(1)
836 > dctimestep(1), getinfo(1), lookamb(1),
837 > mkpmap(1), oconv(1), pfilt(1), pinterp(1),
838 > pvalue(1), rcalc(1), rcomb(1), rcontrib(1), rcrop(1),
839 > rmtxop(1), rsplit(1),
840 > rpict(1), rtpict(1), rvu(1), vwrays(1), ximage(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines