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.31 by greg, Tue Nov 13 19:58:33 2018 UTC vs.
Revision 1.42 by greg, Wed Apr 23 15:09:03 2025 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 186 | 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 240 | Line 260 | This is mostly useful for recovering image dimensions
260   and for creating valid Radiance picture files using the color output
261   format.
262   (See the
263 < .I \-f
263 > .I \-f\*
264   option, above.)
265   .TP
266   .BI -n \ nproc
# Line 261 | Line 281 | cores available on the system or the
281   .I \-x
282   setting, which forces a wait at each flush.
283   .TP
284 + .BI -f \ source
285 + Load definitions from the file
286 + .I source
287 + and assign at the global level.
288 + The usual set of library directories is searched based on the
289 + .I RAYPATH
290 + environment variable.
291 + .TP
292 + .BI -e \ expr
293 + Set additional definitions from
294 + .I expr.
295 + .TP
296   .BI -dj \ frac
297   Set the direct jittering to
298   .I frac.
# Line 315 | Line 347 | change greater than the
347   specification will be calculated.
348   .TP
349   .BI -dr \ N
350 < Set the number of relays for secondary sources to
350 > Set the number of relays for virtual sources to
351   .I N.
352 < A value of 0 means that secondary sources will be ignored.
352 > A value of 0 means that virtual sources will be ignored.
353   A value of 1 means that sources will be made into first generation
354 < secondary sources; a value of 2 means that first generation
355 < secondary sources will also be made into second generation secondary
354 > virtual sources; a value of 2 means that first generation
355 > virtual sources will also be made into second generation virtual
356   sources, and so on.
357   .TP
358   .BI -dp \ D
359 < Set the secondary source presampling density to D.
359 > Set the virtual source presampling density to D.
360   This is the number of samples per steradian
361   that will be used to determine ahead of time whether or not
362   it is worth following shadow rays through all the reflections and/or
363 < transmissions associated with a secondary source path.
364 < A value of 0 means that the full secondary source path will always
363 > transmissions associated with a virtual source path.
364 > A value of 0 means that the full virtual source path will always
365   be tested for shadows if it is tested at all.
366   .TP
367   .BR \-dv
# Line 442 | Line 474 | option on the input octree.
474   Set the ambient accuracy to
475   .I acc.
476   This value will approximately equal the error
477 < from indirect illuminance interpolation.
477 > from indirect irradiance interpolation.
478   A value of zero implies no interpolation.
479   .TP
480   .BI -ad \ N
481   Set the number of ambient divisions to
482   .I N.
483   The error in the Monte Carlo calculation of indirect
484 < illuminance will be inversely proportional to the square
484 > irradiance will be inversely proportional to the square
485   root of this number.
486   A value of zero implies no indirect calculation.
487   .TP
# Line 462 | Line 494 | show a significant change.
494   .BI -af \ fname
495   Set the ambient file to
496   .I fname.
497 < This is where indirect illuminance will be stored and retrieved.
498 < Normally, indirect illuminance values are kept in memory and
497 > This is where indirect irradiance will be stored and retrieved.
498 > Normally, indirect irradiance values are kept in memory and
499   lost when the program finishes or dies.
500 < By using a file, different invocations can share illuminance
500 > By using a file, different invocations can share irradiance
501   values, saving time in the computation.
502   The ambient file is in a machine-independent binary format
503   which can be examined with
# Line 651 | Line 683 | is zero or negative, then Russian roulette is used for
683   termination, and the
684   .I -lw
685   setting (below) must be positive.
686 < If N is a negative integer, then this sets the upper limit
687 < of reflections past which Russian roulette will be used.
686 > If N is a negative integer, then this limits the maximum
687 > number of reflections even with Russian roulette.
688   In scenes with dielectrics and total internal reflection,
689   a setting of 0 (no limit) may cause a stack overflow.
690   .TP
# Line 669 | Line 701 | continue rays with a probability equal to the ray weig
701   divided by the given
702   .I frac.
703   .TP
704 < .BR -ld
704 > .BR \-ld
705   Boolean switch to limit ray distance.
706   If this option is set, then rays will only be traced as far as the
707   magnitude of each direction vector.
708   Otherwise, vector magnitude is ignored and rays are traced to infinity.
709   .TP
710 + .BI -cs \ Ns
711 + Use
712 + .I Ns
713 + bands for spectral sampling rather than the default RGB calculation space.
714 + The maximum setting is controlled by the compiler macro MAXCSAMP, and
715 + defaults to 24.
716 + Larger values for Ns will be reduced to MAXCSAMP.
717 + .TP
718 + .BI -cw " nmA nmB"
719 + Set extrema to the given wavelengths for spectral sampling.
720 + The default is 380 and 780 nanometers.
721 + The order specified does not matter.
722 + .TP
723 + .BR \-co
724 + Boolean switch turns on spectral data output if selected.
725 + The default is to reduce spectral results to RGB, but see the related
726 + .I \-p*
727 + options, below.
728 + .TP
729 + .BI -pc " xr yr xg yg xb yb xw yw"
730 + Use the specified chromaticity pairs for output primaries and white
731 + point rather than the standard RGB color space.
732 + .TP
733 + .BR \-pRGB
734 + Output standard RGB values (the default).
735 + .TP
736 + .BR \-pXYZ
737 + Output standard CIE XYZ tristimulus values rather than RGB.
738 + .TP
739 + .BR \-pY
740 + Produce a single output channel corresponding to photopic luminance.
741 + .TP
742 + .BR \-pS
743 + Produce a single output channel corresponding to scotopic luminance.
744 + .TP
745 + .BR \-pM
746 + Produce a single output channel corresponding to melanopic luminance.
747 + .TP
748   .BI -e \ efile
749   Send error messages and progress reports to
750   .I efile
# Line 737 | Line 807 | To compute radiance values for the rays listed in samp
807   .IP "" .2i
808   rtrace \-ov scene.oct < samples.inp > radiance.out
809   .PP
810 < To compute illuminance values at locations selected with the 't'
810 > To compute irradiance values at locations selected with the 't'
811   command of
812   .I ximage(1):
813   .IP "" .2i
# Line 752 | Line 822 | To compute an image with an unusual view mapping:
822   cnt 480 640 | rcalc \-e 'xr:640;yr:480' \-f unusual_view.cal | rtrace
823   \-x 640 \-y 480 \-fac scene.oct > unusual.hdr
824   .PP
825 < To compute ambient illuminance in photon mapping mode from a global photon
825 > To compute ambient irradiance in photon mapping mode from a global photon
826   map global.pm via one ambient bounce, and from a caustic photon map
827   caustic.pm at sensor positions in samples.inp:
828   .IP "" .2i
# Line 775 | Line 845 | option.
845   .SH AUTHOR
846   Greg Ward
847   .SH "SEE ALSO"
848 < getinfo(1), lookamb(1), mkpmap(1), oconv(1), pfilt(1), pinterp(1),
849 < pvalue(1), rcontrib(1), rpict(1), rtpict(1), rvu(1), vwrays(1), ximage(1)
848 > dctimestep(1), getinfo(1), lookamb(1),
849 > mkpmap(1), oconv(1), pfilt(1), pinterp(1),
850 > pvalue(1), rcalc(1), rcomb(1), rcontrib(1), rcrop(1),
851 > rmtxop(1), rsplit(1),
852 > rpict(1), rtpict(1), rvu(1), vwrays(1), ximage(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines