ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/rpict.1
Revision: 1.30
Committed: Wed Nov 15 19:21:54 2023 UTC (7 months ago) by greg
Branch: MAIN
CVS Tags: HEAD
Changes since 1.29: +11 -11 lines
Log Message:
docs: moved -p* options together

File Contents

# User Rev Content
1 greg 1.30 .\" RCSid "$Id: rpict.1,v 1.29 2023/11/15 18:02:52 greg Exp $"
2 greg 1.1 .TH RPICT 1 2/26/99 RADIANCE
3     .SH NAME
4     rpict - generate a RADIANCE picture
5     .SH SYNOPSIS
6     .B rpict
7     [
8     .B options
9     ]
10     [
11     .B $EVAR
12     ]
13     [
14     .B @file
15     ]
16     [
17     .B octree
18     ]
19     .br
20     .B "rpict [ options ] \-defaults"
21 greg 1.28 .br
22     .B "rpict \-features [feat1 ..]"
23 greg 1.1 .SH DESCRIPTION
24     .I Rpict
25     generates a picture from the RADIANCE scene given in
26     .I octree
27     and sends it to the standard output.
28     If no
29     .I octree
30     is given, the standard input is read.
31     (The octree may also be specified as the output of a command
32     enclosed in quotes and preceded by a `!'.)\0
33     Options specify the viewing parameters as well as
34     giving some control over the calculation.
35     Options may be given on the command line and/or read from the
36     environment and/or read from a file.
37     A command argument beginning with a dollar sign ('$') is immediately
38     replaced by the contents of the given environment variable.
39     A command argument beginning with an at sign ('@') is immediately
40     replaced by the contents of the given file.
41     .PP
42     In the second form shown above, the default values
43     for the options (modified by those options present)
44     are printed with a brief explanation.
45     .PP
46 greg 1.28 In the third form, a list of supported features is sent
47     to the standard output, one per line.
48     If additional arguments follow, they are checked for presence in
49     this list.
50     If a feature includes subfeatures, these may be checked as well by
51     specifying:
52     .nf
53    
54     rpict -features FeatName=subfeat1,subfeat2
55    
56     .fi
57     If any named feature or subfeature is missing, an error is
58     reported and the program returns an error status.
59     If all of the named features are present, a zero status is returned.
60     .PP
61 greg 1.1 Most options are followed by one or more arguments, which must be
62     separated from the option and each other by white space.
63     The exceptions to this rule are the
64     .I \-vt
65     option and the boolean options.
66     Normally, the appearance of a boolean option causes a feature to
67     be "toggled", that is switched from off to on or on to off
68     depending on its previous state.
69     Boolean options may also be set
70     explicitly by following them immediately with a '+' or '-', meaning
71     on or off, respectively.
72     Synonyms for '+' are any of the characters "yYtT1", and synonyms
73     for '-' are any of the characters "nNfF0".
74     All other characters will generate an error.
75     .TP 10n
76     .BI -vt t
77     Set view type to
78     .I t.
79     If
80     .I t
81     is 'v', a perspective view is selected.
82     If
83     .I t
84     is 'l', a parallel view is used.
85     A cylindrical panorma may be selected by setting
86     .I t
87     to the letter 'c'.
88     This view is like a standard perspective vertically, but projected
89     on a cylinder horizontally (like a soupcan's-eye view).
90 greg 1.12 Three fisheye views are provided as well; 'h' yields a hemispherical fisheye
91     view, 'a' results in angular fisheye distortion, and 's'
92     results in a planisphere (stereographic) projection.
93 greg 1.1 A hemispherical fisheye is a projection of the hemisphere onto a circle.
94     The maximum view angle for this type is 180 degrees.
95     An angular fisheye view is defined such that distance from the center of
96     the image is proportional to the angle from the central view direction.
97     An angular fisheye can display a full 360 degrees.
98 greg 1.12 A planisphere fisheye view maintains angular relationships between lines,
99     and is commonly used for sun path analysis.
100     This is more commonly known as a
101     "stereographic projection," but we avoid the term here so as not to
102     confuse it with a stereoscopic pair.
103     A planisphere fisheye can display up to (but not including) 360 degrees,
104     although distortion becomes extreme as this limit is approached.
105 greg 1.1 Note that there is no space between the view type
106     option and its single letter argument.
107     .TP
108     .BI -vp " x y z"
109     Set the view point to
110     .I "x y z".
111     This is the focal point of a perspective view or the
112     center of a parallel projection.
113     .TP
114     .BI -vd " xd yd zd"
115     Set the view direction vector to
116     .I "xd yd zd".
117 greg 1.5 The length of this vector indicates the focal distance as needed by the
118     .I \-pd
119     option, described below.
120 greg 1.1 .TP
121     .BI -vu " xd yd zd"
122     Set the view up vector (vertical direction) to
123     .I "xd yd zd".
124     .TP
125     .BI -vh \ val
126     Set the view horizontal size to
127     .I val.
128     For a perspective projection (including fisheye views),
129     .I val
130     is the horizontal field of view (in degrees).
131     For a parallel projection,
132     .I val
133     is the view width in world coordinates.
134     .TP
135     .BI -vv \ val
136     Set the view vertical size to
137     .I val.
138     .TP
139     .BI -vo \ val
140     Set the view fore clipping plane at a distance of
141     .I val
142     from the view point.
143     The plane will be perpendicular to the view direction for
144     perspective and parallel view types.
145     For fisheye view types, the clipping plane is actually a clipping
146     sphere, centered on the view point with radius
147     .I val.
148     Objects in front of this imaginary surface will not be visible.
149     This may be useful for seeing through walls (to get a longer
150     perspective from an exterior view point) or for incremental
151     rendering.
152     A value of zero implies no foreground clipping.
153     A negative value produces some interesting effects, since it creates an
154     inverted image for objects behind the viewpoint.
155     This possibility is provided mostly for the purpose of rendering
156     stereographic holograms.
157     .TP
158     .BI -va \ val
159     Set the view aft clipping plane at a distance of
160     .I val
161     from the view point.
162     Like the view fore plane, it will be perpendicular to the view
163     direction for perspective and parallel view types.
164     For fisheye view types, the clipping plane is actually a clipping
165     sphere, centered on the view point with radius
166     .I val.
167     Objects behind this imaginary surface will not be visible.
168     A value of zero means no aft clipping, and is the only way to see
169     infinitely distant objects such as the sky.
170     .TP
171     .BI -vs \ val
172     Set the view shift to
173     .I val.
174     This is the amount the actual image will be shifted to the right of
175     the specified view.
176     This is option is useful for generating skewed perspectives or
177     rendering an image a piece at a time.
178     A value of 1 means that the rendered image starts just to the right of
179     the normal view.
180 greg 1.11 A value of \-1 would be to the left.
181 greg 1.1 Larger or fractional values are permitted as well.
182     .TP
183     .BI -vl \ val
184     Set the view lift to
185     .I val.
186     This is the amount the actual image will be lifted up from the
187     specified view, similar to the
188     .I \-vs
189     option.
190     .TP
191     .BI -vf \ file
192     Get view parameters from
193     .I file,
194 greg 1.3 which may be a picture or a file created by rvu (with the "view" command).
195 greg 1.1 .TP
196     .BI -x \ res
197     Set the maximum x resolution to
198     .I res.
199     .TP
200     .BI -y \ res
201     Set the maximum y resolution to
202     .I res.
203     .TP
204     .BI -pa \ rat
205     Set the pixel aspect ratio (height over width) to
206     .I rat.
207     Either the x or the y resolution will be reduced so that the pixels have
208     this ratio for the specified view.
209     If
210     .I rat
211     is zero, then the x and y resolutions will adhere to the given maxima.
212     .TP
213     .BI -ps \ size
214     Set the pixel sample spacing to the integer
215     .I size.
216     This specifies the sample spacing (in pixels) for adaptive subdivision
217     on the image plane.
218     .TP
219     .BI -pt \ frac
220     Set the pixel sample tolerance to
221     .I frac.
222     If two samples differ by more than this amount, a third
223     sample is taken between them.
224     .TP
225     .BI -pj \ frac
226     Set the pixel sample jitter to
227     .I frac.
228     Distributed ray-tracing performs anti-aliasing by randomly sampling
229     over pixels.
230     A value of one will randomly distribute samples over full
231 greg 1.26 pixels, and is not really recommended due to the tendency of
232     samples to (nearly) coincide.
233 greg 1.1 A value of zero samples pixel centers only.
234 greg 1.26 A value around 0.5-0.8 is typical.
235 greg 1.1 .TP
236     .BI -pm \ frac
237     Set the pixel motion blur to
238     .I frac.
239     In an animated sequence, the exact view will be blurred between the previous
240     view and the next view as though a shutter were open this fraction of a
241     frame time.
242     (See the
243     .I \-S
244     option regarding animated sequences.)\0
245     The first view will be blurred according to the difference between the
246     initial view set on the command line and the first view taken from the
247     standard input.
248     It is not advisable to use this option in combination with the
249     .I pmblur(1)
250     program, since one takes the place of the other.
251     However, it may improve results with
252     .I pmblur
253     to use a very small fraction with the
254     .I \-pm
255     option, to avoid the ghosting effect of too few time samples.
256     .TP
257 greg 1.4 .BI -pd \ dia
258     Set the pixel depth-of-field aperture to a diameter of
259     .I dia
260     (in world coordinates).
261     This will be used in conjunction with the view focal distance, indicated
262     by the length of the view direction vector given in the
263     .I \-vd
264     option.
265     It is not advisable to use this option in combination with the
266     .I pdfblur(1)
267     program, since one takes the place of the other.
268     However, it may improve results with
269     .I pdfblur
270     to use a very small fraction with the
271     .I \-pd
272     option, to avoid the ghosting effect of too few samples.
273     .TP
274 greg 1.30 .BI -pc " xr yr xg yg xb yb xw yw"
275     Use the specified chromaticity pairs for output primaries and white
276     point rather than the standard RGB color space.
277     .TP
278     .BR \-pRGB
279     Output standard RGB values (the default).
280     .TP
281     .BR \-pXYZ
282     Output standard CIE XYZ tristimulus values rather than RGB.
283     .TP
284 greg 1.1 .BI -dj \ frac
285     Set the direct jittering to
286     .I frac.
287     A value of zero samples each source at specific sample points
288     (see the
289     .I \-ds
290     option below), giving a smoother but somewhat less accurate
291     rendering.
292     A positive value causes rays to be distributed over each
293     source sample according to its size, resulting in more accurate
294     penumbras.
295     This option should never be greater than 1, and may even
296     cause problems (such as speckle) when the value is smaller.
297     A warning about aiming failure will issued if
298     .I frac
299     is too large.
300     It is usually wise to turn off image sampling when using
301 greg 1.11 direct jitter by setting \-ps to 1.
302 greg 1.1 .TP
303     .BI -ds \ frac
304     Set the direct sampling ratio to
305     .I frac.
306     A light source will be subdivided until
307     the width of each sample area divided by the distance
308     to the illuminated point is below this ratio.
309     This assures accuracy in regions close to large area sources
310     at a slight computational expense.
311     A value of zero turns source subdivision off, sending at most one
312     shadow ray to each light source.
313     .TP
314     .BI -dt \ frac
315     Set the direct threshold to
316     .I frac.
317     Shadow testing will stop when the potential contribution of at least
318     the next and at most all remaining light source samples is less than
319     this fraction of the accumulated value.
320     (See the
321     .I \-dc
322     option below.)\0
323     The remaining light source contributions are approximated
324     statistically.
325     A value of zero means that all light source samples will be tested for shadow.
326     .TP
327     .BI \-dc \ frac
328     Set the direct certainty to
329     .I frac.
330     A value of one guarantees that the absolute accuracy of the direct calculation
331     will be equal to or better than that given in the
332     .I \-dt
333     specification.
334     A value of zero only insures that all shadow lines resulting in a contrast
335     change greater than the
336     .I \-dt
337     specification will be calculated.
338     .TP
339     .BI -dr \ N
340 greg 1.27 Set the number of relays for virtual sources to
341 greg 1.1 .I N.
342 greg 1.27 A value of 0 means that virtual sources will be ignored.
343 greg 1.1 A value of 1 means that sources will be made into first generation
344 greg 1.27 virtual sources; a value of 2 means that first generation
345     virtual sources will also be made into second generation virtual
346 greg 1.1 sources, and so on.
347     .TP
348     .BI -dp \ D
349 greg 1.27 Set the virtual source presampling density to D.
350 greg 1.1 This is the number of samples per steradian
351     that will be used to determine ahead of time whether or not
352     it is worth following shadow rays through all the reflections and/or
353 greg 1.27 transmissions associated with a virtual source path.
354     A value of 0 means that the full virtual source path will always
355 greg 1.1 be tested for shadows if it is tested at all.
356     .TP
357     .BR \-dv
358     Boolean switch for light source visibility.
359     With this switch off, sources will be black when viewed directly
360     although they will still participate in the direct calculation.
361     This option may be desirable in conjunction with the
362     .I \-i
363     option so that light sources do not appear in the output.
364     .TP
365 greg 1.15 .BI -ss \ samp
366     Set the specular sampling to
367     .I samp.
368     For values less than 1, this is the degree to which the highlights
369     are sampled for rough specular materials.
370     A value greater than one causes multiple ray samples to be sent
371     to reduce noise at a commmesurate cost.
372 greg 1.1 A value of zero means that no jittering will take place, and all
373     reflections will appear sharp even when they should be diffuse.
374     This may be desirable when used in combination with image sampling
375     (see
376     .I \-ps
377     option above) to obtain faster renderings.
378     .TP
379     .BI -st \ frac
380     Set the specular sampling threshold to
381     .I frac.
382     This is the minimum fraction of reflection or transmission, under which
383     no specular sampling is performed.
384     A value of zero means that highlights will always be sampled by
385     tracing reflected or transmitted rays.
386     A value of one means that specular sampling is never used.
387     Highlights from light sources will always be correct, but
388     reflections from other surfaces will be approximated using an
389     ambient value.
390     A sampling threshold between zero and one offers a compromise between image
391     accuracy and rendering time.
392     .TP
393     .BR -bv
394     Boolean switch for back face visibility.
395 greg 1.16 With this switch off, back faces of all objects will be invisible
396     to view rays.
397 greg 1.1 This is dangerous unless the model was constructed such that
398 greg 1.16 all surface normals face outward.
399 greg 1.1 Although turning off back face visibility does not save much
400     computation time under most circumstances, it may be useful as a
401     tool for scene debugging, or for seeing through one-sided walls from
402     the outside.
403     .TP
404     .BI -av " red grn blu"
405     Set the ambient value to a radiance of
406     .I "red grn blu".
407     This is the final value used in place of an
408     indirect light calculation.
409     If the number of ambient bounces is one or greater and the ambient
410     value weight is non-zero (see
411     .I -aw
412     and
413     .I -ab
414     below), this value may be modified by the computed indirect values
415     to improve overall accuracy.
416     .TP
417     .BI -aw \ N
418     Set the relative weight of the ambient value given with the
419     .I -av
420     option to
421     .I N.
422     As new indirect irradiances are computed, they will modify the
423     default ambient value in a moving average, with the specified weight
424     assigned to the initial value given on the command and all other
425     weights set to 1.
426     If a value of 0 is given with this option, then the initial ambient
427     value is never modified.
428     This is the safest value for scenes with large differences in
429     indirect contributions, such as when both indoor and outdoor
430     (daylight) areas are visible.
431     .TP
432     .BI -ab \ N
433     Set the number of ambient bounces to
434     .I N.
435 greg 1.18 This is the maximum number of diffuse bounces computed by the indirect
436     calculation. A value of zero implies no indirect calculation.
437     .IP
438 rschregle 1.20 This value defaults to 1 in photon mapping mode (see
439 greg 1.18 .I -ap
440 rschregle 1.20 below), implying that global photon irradiance is always computed via
441 greg 1.18 .I one
442 rschregle 1.20 ambient bounce; this behaviour applies to any positive number of ambient
443     bounces, regardless of the actual value specified. A negative value enables
444     a preview mode that directly visualises the irradiance from the global
445     photon map without any ambient bounces.
446 greg 1.1 .TP
447     .BI -ar \ res
448     Set the ambient resolution to
449     .I res.
450     This number will determine the maximum density of ambient values
451     used in interpolation.
452     Error will start to increase on surfaces spaced closer than
453     the scene size divided by the ambient resolution.
454     The maximum ambient value density is the scene size times the
455     ambient accuracy (see the
456     .I \-aa
457     option below) divided by the ambient resolution.
458     The scene size can be determined using
459     .I getinfo(1)
460     with the
461     .I \-d
462     option on the input octree.
463     A value of zero is interpreted as unlimited resolution.
464     .TP
465     .BI -aa \ acc
466     Set the ambient accuracy to
467     .I acc.
468     This value will approximately equal the error
469 greg 1.27 from indirect irradiance interpolation.
470 greg 1.1 A value of zero implies no interpolation.
471     .TP
472     .BI -ad \ N
473     Set the number of ambient divisions to
474     .I N.
475     The error in the Monte Carlo calculation of indirect
476 greg 1.27 irradiance will be inversely proportional to the square
477 greg 1.1 root of this number.
478     A value of zero implies no indirect calculation.
479     .TP
480     .BI -as \ N
481     Set the number of ambient super-samples to
482     .I N.
483     Super-samples are applied only to the ambient divisions which
484     show a significant change.
485     .TP
486     .BI -af \ fname
487     Set the ambient file to
488     .I fname.
489 greg 1.27 This is where indirect irradiance will be stored and retrieved.
490     Normally, indirect irradiance values are kept in memory and
491 greg 1.1 lost when the program finishes or dies.
492 greg 1.27 By using a file, different invocations can share irradiance
493 greg 1.1 values, saving time in the computation.
494 greg 1.26 Also, by creating an ambient file during a low-resolution rendering,
495     better results can be obtained in a second high-resolution pass.
496     (It is a good idea to keep all of the calculation parameters the same,
497     changing only the dimensions of the output picture.)\0
498 greg 1.1 The ambient file is in a machine-independent binary format
499     which may be examined with
500     .I lookamb(1).
501     .IP
502     The ambient file may also be used as a means of communication and
503     data sharing between simultaneously executing processes.
504     The same file may be used by multiple processes, possibly running on
505     different machines and accessing the file via the network (ie.
506     .I nfs(4)).
507     The network lock manager
508     .I lockd(8)
509     is used to insure that this information is used consistently.
510     .IP
511     If any calculation parameters are changed or the scene
512     is modified, the old ambient file should be removed so that
513     the calculation can start over from scratch.
514     For convenience, the original ambient parameters are listed in the
515     header of the ambient file.
516     .I Getinfo(1)
517     may be used to print out this information.
518     .TP
519 greg 1.7 .BI -ae \ mod
520 greg 1.1 Append
521 greg 1.7 .I mod
522 greg 1.1 to the ambient exclude list,
523     so that it will not be considered during the indirect calculation.
524     This is a hack for speeding the indirect computation by
525     ignoring certain objects.
526     Any object having
527 greg 1.7 .I mod
528 greg 1.1 as its modifier will get the default ambient
529     level rather than a calculated value.
530 greg 1.7 Any number of excluded modifiers may be given, but each
531 greg 1.1 must appear in a separate option.
532     .TP
533 greg 1.7 .BI -ai \ mod
534 greg 1.1 Add
535 greg 1.7 .I mod
536 greg 1.1 to the ambient include list,
537     so that it will be considered during the indirect calculation.
538     The program can use either an include list or an exclude
539     list, but not both.
540     .TP
541     .BI -aE \ file
542     Same as
543     .I \-ae,
544 greg 1.7 except read modifiers to be excluded from
545 greg 1.1 .I file.
546     The RAYPATH environment variable determines which directories are
547     searched for this file.
548 greg 1.7 The modifier names are separated by white space in the file.
549 greg 1.1 .TP
550     .BI -aI \ file
551     Same as
552     .I \-ai,
553 greg 1.7 except read modifiers to be included from
554 greg 1.1 .I file.
555     .TP
556 greg 1.18 .BI -ap " file [bwidth1 [bwidth2]]"
557     Enable photon mapping mode. Loads a photon map generated with
558     .I mkpmap(1)
559     from
560     .I file,
561     and evaluates the indirect irradiance depending on the photon type
562     (automagically detected) using density estimates with a bandwidth of
563     .I bwidth1
564     photons, or the default bandwidth if none is specified (a warning will be
565     issued in this case).
566     .IP
567     Global photon irradiance is evaluated as part of the ambient calculation (see
568     .I \-ab
569     above), caustic photon irradiance is evaluated at primary rays, and
570     indirect inscattering in
571     .I mist
572 rschregle 1.22 is accounted for by volume photons. Contribution photons are treated as
573     global photons by
574     .I rpict.
575 greg 1.18 .IP
576     Additionally specifying
577     .I bwidth2
578     enables bias compensation for the density estimates with a
579     minimum and maximum bandwidth of
580     .I bwidth1
581     and
582     .I bwidth2,
583     respectively.
584     .IP
585     Global photon irradiance may be optionally precomputed by
586     .I mkpmap(1),
587     in which case the bandwidth, if specified, is ignored, as the nearest photon
588     is invariably looked up.
589     .IP
590     Using direct photons replaces the direct calculation with density estimates
591 rschregle 1.22 for debugging and validation of photon emission.
592 greg 1.18 .TP
593     .BI -am " frac"
594 rschregle 1.20 Maximum search radius for photon map lookups. Without this option, an
595     initial maximum search radius is estimated for each photon map from the
596     average photon distance to the distribution's centre of gravity. It is then
597     adapted to the photon density in subsequent lookups. This option imposes a
598     global fixed maximum search radius for
599     .I all
600     photon maps, thus defeating the automatic adaptation. It is useful when
601     multiple warnings about short photon lookups are issued. Note that this
602     option does not conflict with the bandwidth specified with the
603     .I \-ap
604     option; the number of photons found will not exceed the latter, but may be
605     lower if the maximum search radius contains fewer photons, thus resulting in
606     short lookups. Setting this radius too large, on the other hand, may
607     degrade performance.
608 greg 1.18 .TP
609 rschregle 1.21 .BI -ac " pagesize"
610     Set the photon cache page size when using out-of-core photon mapping. The
611     photon cache reduces disk I/O incurred by on-demand loading (paging) of
612     photons, and thus increases performance. This
613     is expressed as a (float) multiple of the density estimate bandwidth
614     specified with
615     .I \-ap
616     under the assumption that photon lookups are local to a cache page. Cache
617     performance is sensitive to this parameter: larger pagesizes will reduce the
618     paging frequency at the expense of higher latency when paging does occur.
619     Sensible values are in the range 4 (default) to 16.
620     .TP
621     .BI -aC " cachesize"
622     Set the total number of photons cached when using out-of-core photon
623     mapping, taking into account the pagesize specified by
624     .I \-ac.
625     Note that this is approximate as the number of cache pages is rounded to
626     the nearest prime. This allows adapting the cache to the available physical
627 rschregle 1.25 memory. Cache performance is less sensitive to this parameter, and reasonable
628     performance can obtained with as few as 10k photons. The default is 1M. This
629     option recognises multiplier suffixes (k = 1e3, M = 1e6), both in upper and
630     lower case.
631 rschregle 1.21 .TP
632 greg 1.1 .BI -me " rext gext bext"
633     Set the global medium extinction coefficient to the indicated color,
634     in units of 1/distance (distance in world coordinates).
635     Light will be scattered or absorbed over distance according to
636     this value.
637     The ratio of scattering to total scattering plus absorption is set
638     by the albedo parameter, described below.
639     .TP
640     .BI -ma " ralb galb balb"
641     Set the global medium albedo to the given value between 0\00\00
642     and 1\01\01.
643     A zero value means that all light not transmitted by the medium
644     is absorbed.
645     A unitary value means that all light not transmitted by the medium
646     is scattered in some new direction.
647     The isotropy of scattering is determined by the Heyney-Greenstein
648     parameter, described below.
649     .TP
650     .BI \-mg \ gecc
651     Set the medium Heyney-Greenstein eccentricity parameter to
652     .I gecc.
653     This parameter determines how strongly scattering favors the forward
654     direction.
655     A value of 0 indicates perfectly isotropic scattering.
656     As this parameter approaches 1, scattering tends to prefer the
657     forward direction.
658     .TP
659     .BI \-ms \ sampdist
660     Set the medium sampling distance to
661     .I sampdist,
662     in world coordinate units.
663     During source scattering, this will be the average distance between
664     adjacent samples.
665     A value of 0 means that only one sample will be taken per light
666     source within a given scattering volume.
667     .TP
668     .BR \-i
669     Boolean switch to compute irradiance rather than radiance values.
670     This only affects the final result, substituting a Lambertian
671     surface and multiplying the radiance by pi.
672     Glass and other transparent surfaces are ignored during this stage.
673     Light sources still appear with their original radiance values,
674     though the
675     .I \-dv
676     option (above) may be used to override this.
677     .TP
678 greg 1.10 .BR \-u
679     Boolean switch to control uncorrelated random sampling.
680 greg 1.9 When "off", a low-discrepancy sequence is used, which reduces
681 greg 1.17 variance but can result in a dithered appearance in specular highlights.
682 greg 1.9 When "on", pure Monte Carlo sampling is used in all calculations.
683     .TP
684 greg 1.1 .BI -lr \ N
685     Limit reflections to a maximum of
686 greg 1.14 .I N,
687     if N is a positive integer.
688 greg 1.8 If
689     .I N
690     is zero, then Russian roulette is used for ray
691     termination, and the
692     .I -lw
693     setting (below) must be positive.
694 greg 1.24 If N is a negative integer, then this limits the maximum
695     number of reflections even with Russian roulette.
696 greg 1.8 In scenes with dielectrics and total internal reflection,
697     a setting of 0 (no limit) may cause a stack overflow.
698 greg 1.1 .TP
699     .BI -lw \ frac
700     Limit the weight of each ray to a minimum of
701     .I frac.
702 greg 1.8 During ray-tracing, a record is kept of the estimated contribution
703     (weight) a ray would have in the image.
704     If this weight is less than the specified minimum and the
705     .I -lr
706     setting (above) is positive, the ray is not traced.
707     Otherwise, Russian roulette is used to
708     continue rays with a probability equal to the ray weight
709     divided by the given
710     .I frac.
711 greg 1.1 .TP
712 greg 1.29 .BI -cs \ Ns
713     Use
714     .I Ns
715     bands for spectral sampling rather than the default RGB calculation space.
716     The maximum setting is controlled by the compiler macro MAXCSAMP, and
717     defaults to 24.
718     Larger values for Ns will be reduced to MAXCSAMP.
719     .TP
720     .BI -cw " nmA nmB"
721     Set extrema to the given wavelengths for spectral sampling.
722     The default is 380 and 780 nanometers.
723     The order specified does not matter.
724     .TP
725 greg 1.1 .BI -S \ seqstart
726     Instead of generating a single picture based only on the view
727     parameters given on the command line, this option causes
728     .I rpict
729     to read view options from the standard input and for each line
730     containing a valid view specification, generate a corresponding
731     picture.
732     This option is most useful for generating animated sequences, though
733     it may also be used to control rpict from a remote process for
734     network-distributed rendering.
735     .I Seqstart
736     is a positive integer that will be associated with the first output
737     frame, and incremented for successive output frames.
738     By default, each frame is concatenated to the output stream, but it
739     is possible to change this action using the
740     .I \-o
741     option (described below).
742     Multiple frames may be later extracted from the output using
743     .I ra_rgbe(1).
744     .IP
745     Note that the octree may not be read from the standard input when
746     using this option.
747     .TP
748     .BI -o \ fspec
749     Send the picture(s) to the file(s) given by
750     .I fspec
751     instead of the standard output.
752     If this option is used in combination with
753     .I \-S
754     and
755     .I fspec
756     contains an integer field for
757     .I printf(3)
758     (eg. "%03d") then the actual output file name will include
759     the current frame number.
760     .I Rpict
761     will not allow a picture file to be clobbered (overwritten)
762     with this option.
763     If an image in a sequence already exists
764     .I (\-S
765     option),
766     .I rpict
767     will skip until it reaches an image that doesn't, or the end of
768     the sequence.
769     This is useful for running rpict on multiple machines or processors
770     to render the same sequence, as each process will skip to the next
771     frame that needs rendering.
772     .TP
773     .BI -r \ fn
774     Recover pixel information from the file
775     .I fn.
776     If the program gets killed during picture generation, the information
777     may be recovered using this option.
778     The view parameters and picture dimensions are also recovered from
779     .I fn
780     if possible.
781     The other options should be identical to those which created
782     .I fn,
783     or an inconsistent picture may result.
784     If
785     .I fn
786     is identical to the file specification given with the
787     .I \-o
788     option,
789     .I rpict
790     will rename the file prior to copying its contents.
791     This insures that the old file is not overwritten accidentally.
792     (See also the
793     .I \-ro
794     option, below.)\0
795     .IP
796     If
797     .I fn
798     is an integer and the recover option is used in combination with the
799     .I \-S
800     option, then
801     .I rpict
802     skips a number of view specifications on its input equal to the
803     difference between
804     .I fn
805     and
806     .I seqstart.
807     .I Rpict
808     then performs a recovery operation on the file constructed from the
809     frame number
810     .I fn
811     and the output file specification given with the
812     .I \-o
813     option.
814     This provides a convenient mechanism for recovering in the middle of
815     an aborted picture sequence.
816     .IP
817     The recovered file
818     will be removed if the operation is successful.
819     If the recover operation fails (due to lack of disk space)
820     and the output file and recover file specifications
821     are the same, then the original information may be left in a
822     renamed temporary file.
823     (See FILES section, below.)\0
824     .TP
825     .BI -ro \ fspec
826     This option causes pixel information to be recovered from and
827     subsequently returned to the picture file
828     .I fspec.
829     The effect is the same as specifying identical recover and output
830     file names with the
831     .I \-r
832     and
833     .I \-o
834     options.
835     .TP
836     .BI -z \ fspec
837     Write pixel distances out to the file
838     .I fspec.
839     The values are written as short floats, one per pixel in scanline order,
840     as required by
841     .I pinterp(1).
842     Similar to the
843     .I \-o
844     option, the actual file name will be constructed using
845     .I printf
846     and the frame number from the
847     .I \-S
848     option.
849     If used with the
850     .I \-r
851     option,
852     .I \-z
853     also recovers information from an aborted rendering.
854     .TP
855     .BI \-P \ pfile
856     Execute in a persistent mode, using
857     .I pfile
858     as the control file.
859     This option must be used together with
860     .I \-S,
861     and is incompatible with the recover option
862     .I (\-r).
863     Persistent execution means that after reaching end-of-file on
864     its input,
865     .I rpict
866     will fork a child process that will wait for another
867     .I rpict
868     command with the same
869     .I \-P
870     option to attach to it.
871     (Note that since the rest of the command line options will be those
872     of the original invocation, it is not necessary to give any arguments
873     besides
874     .I \-P
875     for subsequent calls.)
876     Killing the process is achieved with the
877     .I kill(1)
878     command.
879     (The process ID in the first line of
880     .I pfile
881     may be used to identify the waiting
882     .I rpict
883     process.)
884     This option may be less useful than the
885     .I \-PP
886     variation, explained below.
887     .TP
888     .BI \-PP \ pfile
889     Execute in continuous-forking persistent mode, using
890     .I pfile
891     as the control file.
892     The difference between this option and the
893     .I \-P
894     option described above is the creation of multiple duplicate
895     processes to handle any number of attaches.
896     This provides a simple and reliable mechanism of memory sharing
897     on most multiprocessing platforms, since the
898     .I fork(2)
899     system call will share memory on a copy-on-write basis.
900     This option may be used with
901     .I rpiece(1)
902     to efficiently render a single image using multiple processors
903     on the same host.
904     .TP
905     .BI -t \ sec
906     Set the time between progress reports to
907     .I sec.
908     A progress report writes the number of rays traced, the percentage
909     completed, and the CPU usage to the standard error.
910     Reports are given either automatically after the specified interval,
911 greg 1.11 or when the process receives a continue (\-CONT) signal (see
912 greg 1.1 .I kill(1)).
913     A value of zero turns automatic reporting off.
914     .TP
915     .BI -e \ efile
916     Send error messages and progress reports to
917     .I efile
918     instead of the standard error.
919     .TP
920     .BR \-w
921     Boolean switch for warning messages.
922     The default is to print warnings, so the first appearance of
923     this option turns them off.
924     .SH EXAMPLE
925 greg 1.13 rpict \-vp 10 5 3 \-vd 1 \-.5 0 scene.oct > scene.hdr
926 greg 1.1 .PP
927 greg 1.13 rpict \-S 1 \-o frame%02d.hdr scene.oct < keyframes.vf
928 greg 1.18 .PP
929 greg 1.27 To render ambient irradiance in photon mapping mode from a global photon
930 greg 1.18 map global.pm via one ambient bounce, and from a caustic photon map
931     caustic.pm:
932     .IP "" .2i
933     rpict -ab 1 -ap global.pm 50 -ap caustic.pm 50 -vf scene.vf scene.oct >
934     scene.hdr
935 greg 1.1 .SH ENVIRONMENT
936     RAYPATH the directories to check for auxiliary files.
937     .SH FILES
938 greg 1.6 /tmp/rtXXXXXX common header information for picture sequence
939 greg 1.1 .br
940     rfXXXXXX temporary name for recover file
941     .SH DIAGNOSTICS
942     If the program terminates from an input related error, the exit status
943     will be 1.
944     A system related error results in an exit status of 2.
945     If the program receives a signal that is caught, it will exit with a status
946     of 3.
947     In each case, an error message will be printed to the standard error, or
948     to the file designated by the
949     .I \-e
950     option.
951     .SH AUTHOR
952     Greg Ward
953     .SH "SEE ALSO"
954 greg 1.18 getinfo(1), lookamb(1), mkpmap(1), oconv(1), pdfblur(1), pfilt(1),
955 greg 1.23 pinterp(1), pmblur(1), printf(3), ra_rgbe(1), rad(1), rpiece(1), rtpict(1), rtrace(1), rvu(1)