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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines