[ViewVC] Diff of: Development/ray/doc/man/man1/rtrace.1

Comparing ray/doc/man/man1/rtrace.1 (file contents):
Revision 1.29 by rschregle, Fri Jan 26 18:30:27 2018 UTC vs.
Revision 1.41 by greg, Tue Apr 22 17:12:25 2025 UTC

+.B octree
+.br
+.B "rtrace [ options ] \-defaults"
-+
+.br
-+
+.B "rtrace \-features [feat1 ..]"
+.SH DESCRIPTION
+.I Rtrace
+traces rays from the standard input through the RADIANCE scene given by
+This may be useful for programs that run
+.I rtrace
+as a separate process.
-<
+In the second form, the default values
->
+.PP
->
+In the second form shown above, the default values
+for the options (modified by those options present)
+are printed with a brief explanation.
+.PP
-+
+In the third form, a list of supported features is sent
-+
+to the standard output, one per line.
-+
+If additional arguments follow, they are checked for presence in
-+
+this list.
-+
+If a feature includes subfeatures, these may be checked as well by
-+
+specifying:
-+
+.nf
-+
-+
+        rtrace -features FeatName=subfeat1,subfeat2
-+
-+
+.fi
-+
+If any named feature or subfeature is missing, an error is
-+
+reported and the program returns an error status.
-+
+If all of the named features are present, a zero status is returned.
-+
+.PP
+Options may be given on the command line and/or read from the
+environment and/or read from a file.
+A command argument beginning with a dollar sign ('$') is immediately
+ascii, 'f' for single-precision floating point,
+and 'd' for double-precision floating point.
+In addition to these three choices, the character 'c' may be used
-<
+to denote 4-byte floating point (Radiance) color format
-<
+for the output of values only
-<
+.I (\-ov
-<
+option, below).
->
+to denote 4-byte RGBE (Radiance) color format
->
+for the output of individual color values only, and the
->
+.I \-x
->
+and
->
+.I \-y
->
+options should also be specified to create a valid output picture.
+If the output character is missing, the input format is used.
+.IP
+Note that there is no space between this option and its argument.
+.IP
+M       material name
+.IP
-+
+r       mirrored value contribution
-+
+.IP
-+
+x       unmirrored value contribution
-+
+.IP
-+
+R       mirrored ray length
-+
+.IP
-+
+X       unmirrored ray length
-+
+.IP
+~       tilde (end of trace marker)
+.IP
+If the letter 't' appears in
+.I \-dv
+option (below) may be used to override this.
+This option is especially useful in
-<
+conjunction with ximage(1) for computing illuminance at scene points.
->
+conjunction with ximage(1) for computing irradiance at scene points.
+.TP
+.BR \-u
+Boolean switch to control uncorrelated random sampling.
+and for creating valid Radiance picture files using the color output
+format.
+(See the
-<
+.I \-f
->
+.I \-f\*
+option, above.)
+.TP
+.BI -n \ nproc
+.I \-x
+setting, which forces a wait at each flush.
+.TP
-+
+.BI -f \ source
-+
+Load definitions from
-+
+.I source
-+
+and assign at global level.
-+
+.TP
-+
+.BI -e \ expr
-+
+Set additional definitions from
-+
+.I expr.
-+
+.TP
+.BI -dj \ frac
+Set the direct jittering to
+.I frac.
+specification will be calculated.
+.TP
+.BI -dr \ N
-<
+Set the number of relays for secondary sources to
->
+Set the number of relays for virtual sources to
+.I N.
-<
+A value of 0 means that secondary sources will be ignored.
->
+A value of 0 means that virtual sources will be ignored.
+A value of 1 means that sources will be made into first generation
-<
+secondary sources; a value of 2 means that first generation
-<
+secondary sources will also be made into second generation secondary
->
+virtual sources; a value of 2 means that first generation
->
+virtual sources will also be made into second generation virtual
+sources, and so on.
+.TP
+.BI -dp \ D
-<
+Set the secondary source presampling density to D.
->
+Set the virtual source presampling density to D.
+This is the number of samples per steradian
+that will be used to determine ahead of time whether or not
+it is worth following shadow rays through all the reflections and/or
-<
+transmissions associated with a secondary source path.
-<
+A value of 0 means that the full secondary source path will always
->
+transmissions associated with a virtual source path.
->
+A value of 0 means that the full virtual source path will always
+be tested for shadows if it is tested at all.
+.TP
+.BR \-dv
+Set the ambient accuracy to
+.I acc.
+This value will approximately equal the error
-<
+from indirect illuminance interpolation.
->
+from indirect irradiance interpolation.
+A value of zero implies no interpolation.
+.TP
+.BI -ad \ N
+Set the number of ambient divisions to
+.I N.
+The error in the Monte Carlo calculation of indirect
-<
+illuminance will be inversely proportional to the square
->
+irradiance will be inversely proportional to the square
+root of this number.
+A value of zero implies no indirect calculation.
+.TP
+.BI -af \ fname
+Set the ambient file to
+.I fname.
-<
+This is where indirect illuminance will be stored and retrieved.
-<
+Normally, indirect illuminance values are kept in memory and
->
+This is where indirect irradiance will be stored and retrieved.
->
+Normally, indirect irradiance values are kept in memory and
+lost when the program finishes or dies.
-<
+By using a file, different invocations can share illuminance
->
+By using a file, different invocations can share irradiance
+values, saving time in the computation.
+The ambient file is in a machine-independent binary format
+which can be examined with
+termination, and the
+.I -lw
+setting (below) must be positive.
-<
+If N is a negative integer, then this sets the upper limit
-<
+of reflections past which Russian roulette will be used.
->
+If N is a negative integer, then this limits the maximum
->
+number of reflections even with Russian roulette.
+In scenes with dielectrics and total internal reflection,
+a setting of 0 (no limit) may cause a stack overflow.
+.TP
+divided by the given
+.I frac.
+.TP
-<
+.BR -ld
->
+.BR \-ld
+Boolean switch to limit ray distance.
+If this option is set, then rays will only be traced as far as the
+magnitude of each direction vector.
+Otherwise, vector magnitude is ignored and rays are traced to infinity.
+.TP
-+
+.BI -cs \ Ns
-+
+Use
-+
+.I Ns
-+
+bands for spectral sampling rather than the default RGB calculation space.
-+
+The maximum setting is controlled by the compiler macro MAXCSAMP, and
-+
+defaults to 24.
-+
+Larger values for Ns will be reduced to MAXCSAMP.
-+
+.TP
-+
+.BI -cw " nmA nmB"
-+
+Set extrema to the given wavelengths for spectral sampling.
-+
+The default is 380 and 780 nanometers.
-+
+The order specified does not matter.
-+
+.TP
-+
+.BR \-co
-+
+Boolean switch turns on spectral data output if selected.
-+
+The default is to reduce spectral results to RGB, but see the related
-+
+.I \-p*
-+
+options, below.
-+
+.TP
-+
+.BI -pc " xr yr xg yg xb yb xw yw"
-+
+Use the specified chromaticity pairs for output primaries and white
-+
+point rather than the standard RGB color space.
-+
+.TP
-+
+.BR \-pRGB
-+
+Output standard RGB values (the default).
-+
+.TP
-+
+.BR \-pXYZ
-+
+Output standard CIE XYZ tristimulus values rather than RGB.
-+
+.TP
-+
+.BR \-pY
-+
+Produce a single output channel corresponding to photopic luminance.
-+
+.TP
-+
+.BR \-pS
-+
+Produce a single output channel corresponding to scotopic luminance.
-+
+.TP
-+
+.BR \-pM
-+
+Produce a single output channel corresponding to melanopic luminance.
-+
+.TP
+.BI -e \ efile
+Send error messages and progress reports to
+.I efile
+.IP "" .2i
+rtrace \-ov scene.oct < samples.inp > radiance.out
+.PP
-<
+To compute illuminance values at locations selected with the 't'
->
+To compute irradiance values at locations selected with the 't'
+command of
+.I ximage(1):
+.IP "" .2i
+cnt 480 640 | rcalc \-e 'xr:640;yr:480' \-f unusual_view.cal | rtrace
+\-x 640 \-y 480 \-fac scene.oct > unusual.hdr
+.PP
-<
+To compute ambient illuminance in photon mapping mode from a global photon
->
+To compute ambient irradiance in photon mapping mode from a global photon
+map global.pm via one ambient bounce, and from a caustic photon map
+caustic.pm at sensor positions in samples.inp:
+.IP "" .2i
+.SH AUTHOR
+Greg Ward
+.SH "SEE ALSO"
-<
+getinfo(1), lookamb(1), mkpmap(1), oconv(1), pfilt(1), pinterp(1),
-<
+pvalue(1), rpict(1), rcontrib(1), rvu(1), vwrays(1), ximage(1)
->
+dctimestep(1), getinfo(1), lookamb(1),
->
+mkpmap(1), oconv(1), pfilt(1), pinterp(1),
->
+pvalue(1), rcalc(1), rcomb(1), rcontrib(1), rcrop(1),
->
+rmtxop(1), rsplit(1),
->
+rpict(1), rtpict(1), rvu(1), vwrays(1), ximage(1)

Diff Legend

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

Comparing ray/doc/man/man1/rtrace.1 (file contents): Revision 1.29 by rschregle, Fri Jan 26 18:30:27 2018 UTC vs. Revision 1.41 by greg, Tue Apr 22 17:12:25 2025 UTC

Diff Legend

Comparing ray/doc/man/man1/rtrace.1 (file contents):
Revision 1.29 by rschregle, Fri Jan 26 18:30:27 2018 UTC vs.
Revision 1.41 by greg, Tue Apr 22 17:12:25 2025 UTC