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

Comparing ray/doc/man/man1/mkillum.1 (file contents):
Revision 1.2 by greg, Tue Dec 9 15:59:06 2003 UTC vs.
Revision 1.9 by greg, Mon Nov 10 19:08:17 2008 UTC

# Line 5 | Line 5 | mkillum - compute illum sources for a RADIANCE scene
5   .SH SYNOPSIS
6   .B mkillum
7   [
8 + .B "\-n nprocs"
9 + ][
10   .B "rtrace options"
11   ]
12   .B octree
# Line 18 | Line 20 | light source distributions for each surface, replacing
20   secondary sources whose contributions can be computed more efficiently by
21   .I rpict(1)
22   and
23 < .I rview(1).
23 > .I rvu(1).
24   This type of optimization is most useful for windows and skylights which
25   represent concentrated sources of indirect illumination.
26   .I Mkillum
# Line 27 | Line 29 | directional distributions.
29   These are best handled respectively by the ambient calculation
30   and the secondary source types in RADIANCE.
31   .PP
32 < The arguments to
32 > If the
33 > .I \-n
34 > option is specified with a value greater than 1, multiple
35 > ray tracing processes will be used to accelerate computation on a shared
36 > memory machine.
37 > Note that there is no benefit to using more processes
38 > than there are local CPUs available to do the work.
39 > .PP
40 > Remaining arguments to
41   .I mkillum
42 < are passed directly to
42 > are interpreted as rendering options for
43   .I rtrace(1),
44 < which is used to compute the light distributions for the input surfaces.
44 > to compute the light distributions for the input surfaces.
45   These surfaces can be any combination of polygons, spheres and rings.
46   Other surfaces may be included, but
47   .I mkillum
# Line 46 | Line 56 | the file names.
56   (Note that this character must be escaped from most shells.)
57   This is necessary so
58   .I mkillum
59 < can tell where the arguments to
50 < .I rtrace(1)
59 > can tell where the rendering arguments
60   end and its own input files begin.
61   .SH VARIABLES
62   .I Mkillum
# Line 128 | Line 137 | Only produce secondary sources for surfaces modified b
137   .TP
138   .BR n
139   Do not produce any secondary sources.
140 < All input will be passed to the output unaffected.
140 > All input will be passed to the output unaffected, except any
141 > void surfaces will be removed.
142   .TP
143   .BI b =real
144   Do not produce a secondary source for a surface if its average
# Line 162 | Line 172 | If
172   is zero, then a diffuse source is assumed and no distribution is
173   created.
174   .TP
175 + .BI d =string
176 + Set the surface Bidirectional Scattering Distribution Function (BSDF)
177 + to the given file.
178 + The RADIANCE library path will be searched if the file does not begin
179 + with a '.' or '~' character.
180 + This file must contain an LBNL Window 6 XML specification of a valid
181 + BSDF for the given surface, and all rays will be interpreted through
182 + this function.
183 + The orientation of the BSDF may be controlled with the
184 + .I u
185 + setting, described below.
186 + The thickness of the surface may be controlled with the
187 + .I t
188 + setting.
189 + If this variable has no setting or an integer is specified,
190 + .I mkillum
191 + returns to the default behavior of computing the output distribution
192 + directly.
193 + .TP
194   .BI s =integer
195   Set the number of ray samples per direction to
196   .I integer.
# Line 182 | Line 211 | will use the material type "illum" with the input surf
211   as its alternate material.
212   The default is
213   .I l-.
214 + .TP
215 + .BI u =[+|-]{X|Y|Z}
216 + The given axis will be considered "up" for the purposes of interpreting
217 + BSDF data specified with the
218 + .I d
219 + variable.
220 + The BSDF will be reoriented relative to the surface as necessary to keep
221 + the up vector in the vertical plane that contains this axis and the
222 + surface normal, corresponding to an azimuth of 90 degrees.
223 + The default up vector is +Z.
224 + .TP
225 + .BI t =real
226 + Set the surface thickness to
227 + .I real
228 + in world coordinates.
229 + This value is used for determining where to start rays that need to begin
230 + on the opposite side of the surface, specifically to compute the incoming
231 + distribution for a BSDF computation.
232 + The default value is 0.
233 + .SH EXAMPLES
234 + The following command generates illum's corresponding to geometry
235 + in the files "it1.rad" and "it2.rad":
236 + .IP "" .3i
237 + mkillum \-ab 2 \-ad 1024 \-av .1 .1 .1 basic.oct "<" it1.rad it2.rad > illums.rad
238 + .PP
239 + The output file "illums.rad" would then be combined with the original
240 + scene geometry to create a more easily rendered composite.
241 + .SH ENVIRONMENT
242 + RAYPATH         the directories to check for auxiliary files.
243   .SH AUTHOR
244   Greg Ward
245   .SH ACKNOWLEDGEMENT
246   Work on this program was initiated and sponsored by the LESO
247   group at EPFL in Switzerland.
248   .SH "SEE ALSO"
249 < oconv(1), rad(1), rpict(1), rtrace(1), rview(1)
249 > oconv(1), rad(1), rpict(1), rtrace(1), rvu(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines