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

Comparing ray/doc/man/man1/rtcontrib.1 (file contents):
Revision 1.2 by greg, Thu May 26 18:53:04 2005 UTC vs.
Revision 1.8 by greg, Thu Jun 9 17:27:27 2005 UTC

# Line 1 | Line 1
1   .\" RCSid "$Id$"
2 < .TH RPIECE 1 5/25/05 RADIANCE
2 > .TH RTCONTRIB 1 5/25/05 RADIANCE
3   .SH NAME
4 < rtcontrib - compute contributions in a RADIANCE scene
4 > rtcontrib - compute contribution coefficients in a RADIANCE scene
5   .SH SYNOPSIS
6   .B rtcontrib
7   [
8   .B "\-n nprocs"
9   ][
10 + .B \-r
11 + ][
12   .B "\-e expr"
13   ][
14   .B "\-f source"
15   ][
16 < .B "\-o fspec"
16 > .B "\-o ospec"
17   ][
18   .B "\-b binv"
19   ]
# Line 26 | Line 28 | rtcontrib - compute contributions in a RADIANCE scene
28   rtrace options
29   ]
30   .B octree
31 + .br
32 + .B "rtcontrib [ options ] \-defaults"
33   .SH DESCRIPTION
34   .I Rtcontrib
35   computes ray contributions (i.e., color coefficients)
# Line 35 | Line 39 | settings.
39   These modifiers are usually materials associated with
40   light sources or sky domes, and must directly modify some geometric
41   primitives to be considered in the output.
42 < The computed contributions can then be used in linear combination to
42 > The output of
43 > .I rtcontrib
44 > has many potential uses.
45 > Source contributions can be used as components in linear combination to
46   reproduce any desired variation, e.g., simulating lighting controls or
47   changing sky conditions via daylight coefficients.
48   More generally,
49   .I rtcontrib
50 < may be used to compute input-output relationships in optical
51 < systems, such as light pipes and shading devices.
50 > can be used to compute arbitrary input-output relationships in optical
51 > systems, such as luminaires, light pipes, and shading devices.
52   .PP
53   .I Rtcontrib
54   calls
55   .I rtrace(1)
56 < to calculate the contributions for each input ray,
57 < and the output tallies are sent to one or more files according to the
56 > with the -oTW option to calculate the daughter ray
57 > contributions for each input ray, and the output tallies
58 > are sent to one or more destinations according to the given
59   .I \-o
60   specification.
61 + If a destination begins with an exclamation mark ('!'), then
62 + a pipe is opened to a command and data is sent to its standard input.
63 + Otherwise, the destination is treated as a file.
64 + An existing file of the same name is clobbered, unless the
65 + .I \-r
66 + option is specified, in which case data recovery is attempted.
67   If an output specification contains a "%s" format, this will be
68   replaced by the modifier name.
69   The
# Line 58 | Line 72 | option may be used to further define
72   a "bin number" within each object if finer resolution is needed, and
73   this will be applied to a "%d" format in the output file
74   specification if present.
75 < (The actual bin number is computed at run time based on ray direction
76 < and surface intersection, as described below.)\0
75 > The actual bin number is computed at run time based on ray direction
76 > and surface intersection, as described below.
77   The most recent
78   .I \-b
79   and
# Line 80 | Line 94 | the variables Px, Py, and Pz, and the normalized ray d
94   will be assigned to Dx, Dy, and Dz.
95   These parameters may be combined with definitions given in
96   .I \-e
97 < options and files read in
97 > arguments and files read using the
98   .I \-f
99 < options, to compute the bin, which will be
99 > option.
100 > The computed bin value will be
101   rounded to the nearest whole number.
102   This mechanism allows the user to define precise regions or directions
103   they wish to accumulate, such as the Tregenza sky discretization,
104   which would be otherwise impossible to specify
105   as a set of RADIANCE primitives.
106 + The rules and predefined functions available for these expressions are
107 + described in the
108 + .I rcalc(1)
109 + man page.
110 + Unlike
111 + .I rcalc,
112 + .I rtcontrib
113 + will search the RADIANCE library directories for each file given in a
114 + .I \-f
115 + option.
116 + (No search takes place if a file name begins with a '.', '/' or '~'
117 + character.)\0
118   .PP
119   If no
120   .I \-o
121   specification is given, results are written on the standard output in order
122   of modifier (as given on the command line) then bin number.
123 < Concatenated data is also sent to a lone output file (i.e., an initial
123 > Concatenated data is also sent to a single destination (i.e., an initial
124   .I \-o
125   specification without formatting strings).
126   If a "%s" format appears but no "%d" in the
# Line 170 | Line 197 | To compute an array of illuminance contributions accor
197   .IP "" .2i
198   rtcontrib -b tbin -o sky.dat -m skyglow -b 0 -o ground.dat -m groundglow
199   @render.opt -f tregenza.cal scene.oct < test.dat
200 + .SH ENVIRONMENT
201 + RAYPATH         path to search for -f files
202   .SH AUTHOR
203   Greg Ward
204   .SH "SEE ALSO"

Diff Legend

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