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.9 by greg, Fri Jun 10 16:42:10 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   ]
20 < .B "\-m mod .."
20 > {
21 > .B "\-m mod | \-M file"
22 > }
23 > ..
24   [
25   .B $EVAR
26   ]
# Line 26 | Line 31 | rtcontrib - compute contributions in a RADIANCE scene
31   rtrace options
32   ]
33   .B octree
34 + .br
35 + .B "rtcontrib [ options ] \-defaults"
36   .SH DESCRIPTION
37   .I Rtcontrib
38   computes ray contributions (i.e., color coefficients)
# Line 35 | Line 42 | settings.
42   These modifiers are usually materials associated with
43   light sources or sky domes, and must directly modify some geometric
44   primitives to be considered in the output.
45 < The computed contributions can then be used in linear combination to
45 > A modifier list may also be read from a file using the
46 > .I \-M
47 > option.
48 > .PP
49 > The output of
50 > .I rtcontrib
51 > has many potential uses.
52 > Source contributions can be used as components in linear combination to
53   reproduce any desired variation, e.g., simulating lighting controls or
54   changing sky conditions via daylight coefficients.
55   More generally,
56   .I rtcontrib
57 < may be used to compute input-output relationships in optical
58 < systems, such as light pipes and shading devices.
57 > can be used to compute arbitrary input-output relationships in optical
58 > systems, such as luminaires, light pipes, and shading devices.
59   .PP
60   .I Rtcontrib
61   calls
62   .I rtrace(1)
63 < to calculate the contributions for each input ray,
64 < and the output tallies are sent to one or more files according to the
63 > with the -oTW option to calculate the daughter ray
64 > contributions for each input ray, and the output tallies
65 > are sent to one or more destinations according to the given
66   .I \-o
67   specification.
68 + If a destination begins with an exclamation mark ('!'), then
69 + a pipe is opened to a command and data is sent to its standard input.
70 + Otherwise, the destination is treated as a file.
71 + An existing file of the same name is clobbered, unless the
72 + .I \-r
73 + option is specified, in which case data recovery is attempted.
74   If an output specification contains a "%s" format, this will be
75   replaced by the modifier name.
76   The
# Line 58 | Line 79 | option may be used to further define
79   a "bin number" within each object if finer resolution is needed, and
80   this will be applied to a "%d" format in the output file
81   specification if present.
82 < (The actual bin number is computed at run time based on ray direction
83 < and surface intersection, as described below.)\0
82 > The actual bin number is computed at run time based on ray direction
83 > and surface intersection, as described below.
84   The most recent
85   .I \-b
86   and
# Line 80 | Line 101 | the variables Px, Py, and Pz, and the normalized ray d
101   will be assigned to Dx, Dy, and Dz.
102   These parameters may be combined with definitions given in
103   .I \-e
104 < options and files read in
104 > arguments and files read using the
105   .I \-f
106 < options, to compute the bin, which will be
106 > option.
107 > The computed bin value will be
108   rounded to the nearest whole number.
109   This mechanism allows the user to define precise regions or directions
110   they wish to accumulate, such as the Tregenza sky discretization,
111   which would be otherwise impossible to specify
112   as a set of RADIANCE primitives.
113 + The rules and predefined functions available for these expressions are
114 + described in the
115 + .I rcalc(1)
116 + man page.
117 + Unlike
118 + .I rcalc,
119 + .I rtcontrib
120 + will search the RADIANCE library directories for each file given in a
121 + .I \-f
122 + option.
123 + (No search takes place if a file name begins with a '.', '/' or '~'
124 + character.)\0
125   .PP
126   If no
127   .I \-o
128   specification is given, results are written on the standard output in order
129   of modifier (as given on the command line) then bin number.
130 < Concatenated data is also sent to a lone output file (i.e., an initial
130 > Concatenated data is also sent to a single destination (i.e., an initial
131   .I \-o
132   specification without formatting strings).
133   If a "%s" format appears but no "%d" in the
# Line 170 | Line 204 | To compute an array of illuminance contributions accor
204   .IP "" .2i
205   rtcontrib -b tbin -o sky.dat -m skyglow -b 0 -o ground.dat -m groundglow
206   @render.opt -f tregenza.cal scene.oct < test.dat
207 + .SH ENVIRONMENT
208 + RAYPATH         path to search for -f files
209   .SH AUTHOR
210   Greg Ward
211   .SH "SEE ALSO"

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines