ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/rpict.1
Revision: 1.32
Committed: Wed Apr 23 15:09:03 2025 UTC (12 days, 8 hours ago) by greg
Branch: MAIN
CVS Tags: HEAD
Changes since 1.31: +6 -3 lines
Log Message:
docs: Wording fixes to man pages regarding -e and -f options

File Contents

# Content
1 .\" RCSid "$Id: rpict.1,v 1.31 2025/04/22 17:12:25 greg Exp $"
2 .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 .br
22 .B "rpict \-features [feat1 ..]"
23 .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 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 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 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 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 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 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 The length of this vector indicates the focal distance as needed by the
118 .I \-pd
119 option, described below.
120 .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 A value of \-1 would be to the left.
181 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 which may be a picture or a file created by rvu (with the "view" command).
195 .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 pixels, and is not really recommended due to the tendency of
232 samples to (nearly) coincide.
233 A value of zero samples pixel centers only.
234 A value around 0.5-0.8 is typical.
235 .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 .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 .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 .BI -f \ source
285 Load definitions from the file
286 .I source
287 and assign at the global level.
288 The usual set of library directories is searched based on the
289 .I RAYPATH
290 environment variable.
291 .TP
292 .BI -e \ expr
293 Set additional definitions from
294 .I expr.
295 .TP
296 .BI -dj \ frac
297 Set the direct jittering to
298 .I frac.
299 A value of zero samples each source at specific sample points
300 (see the
301 .I \-ds
302 option below), giving a smoother but somewhat less accurate
303 rendering.
304 A positive value causes rays to be distributed over each
305 source sample according to its size, resulting in more accurate
306 penumbras.
307 This option should never be greater than 1, and may even
308 cause problems (such as speckle) when the value is smaller.
309 A warning about aiming failure will issued if
310 .I frac
311 is too large.
312 It is usually wise to turn off image sampling when using
313 direct jitter by setting \-ps to 1.
314 .TP
315 .BI -ds \ frac
316 Set the direct sampling ratio to
317 .I frac.
318 A light source will be subdivided until
319 the width of each sample area divided by the distance
320 to the illuminated point is below this ratio.
321 This assures accuracy in regions close to large area sources
322 at a slight computational expense.
323 A value of zero turns source subdivision off, sending at most one
324 shadow ray to each light source.
325 .TP
326 .BI -dt \ frac
327 Set the direct threshold to
328 .I frac.
329 Shadow testing will stop when the potential contribution of at least
330 the next and at most all remaining light source samples is less than
331 this fraction of the accumulated value.
332 (See the
333 .I \-dc
334 option below.)\0
335 The remaining light source contributions are approximated
336 statistically.
337 A value of zero means that all light source samples will be tested for shadow.
338 .TP
339 .BI \-dc \ frac
340 Set the direct certainty to
341 .I frac.
342 A value of one guarantees that the absolute accuracy of the direct calculation
343 will be equal to or better than that given in the
344 .I \-dt
345 specification.
346 A value of zero only insures that all shadow lines resulting in a contrast
347 change greater than the
348 .I \-dt
349 specification will be calculated.
350 .TP
351 .BI -dr \ N
352 Set the number of relays for virtual sources to
353 .I N.
354 A value of 0 means that virtual sources will be ignored.
355 A value of 1 means that sources will be made into first generation
356 virtual sources; a value of 2 means that first generation
357 virtual sources will also be made into second generation virtual
358 sources, and so on.
359 .TP
360 .BI -dp \ D
361 Set the virtual source presampling density to D.
362 This is the number of samples per steradian
363 that will be used to determine ahead of time whether or not
364 it is worth following shadow rays through all the reflections and/or
365 transmissions associated with a virtual source path.
366 A value of 0 means that the full virtual source path will always
367 be tested for shadows if it is tested at all.
368 .TP
369 .BR \-dv
370 Boolean switch for light source visibility.
371 With this switch off, sources will be black when viewed directly
372 although they will still participate in the direct calculation.
373 This option may be desirable in conjunction with the
374 .I \-i
375 option so that light sources do not appear in the output.
376 .TP
377 .BI -ss \ samp
378 Set the specular sampling to
379 .I samp.
380 For values less than 1, this is the degree to which the highlights
381 are sampled for rough specular materials.
382 A value greater than one causes multiple ray samples to be sent
383 to reduce noise at a commmesurate cost.
384 A value of zero means that no jittering will take place, and all
385 reflections will appear sharp even when they should be diffuse.
386 This may be desirable when used in combination with image sampling
387 (see
388 .I \-ps
389 option above) to obtain faster renderings.
390 .TP
391 .BI -st \ frac
392 Set the specular sampling threshold to
393 .I frac.
394 This is the minimum fraction of reflection or transmission, under which
395 no specular sampling is performed.
396 A value of zero means that highlights will always be sampled by
397 tracing reflected or transmitted rays.
398 A value of one means that specular sampling is never used.
399 Highlights from light sources will always be correct, but
400 reflections from other surfaces will be approximated using an
401 ambient value.
402 A sampling threshold between zero and one offers a compromise between image
403 accuracy and rendering time.
404 .TP
405 .BR -bv
406 Boolean switch for back face visibility.
407 With this switch off, back faces of all objects will be invisible
408 to view rays.
409 This is dangerous unless the model was constructed such that
410 all surface normals face outward.
411 Although turning off back face visibility does not save much
412 computation time under most circumstances, it may be useful as a
413 tool for scene debugging, or for seeing through one-sided walls from
414 the outside.
415 .TP
416 .BI -av " red grn blu"
417 Set the ambient value to a radiance of
418 .I "red grn blu".
419 This is the final value used in place of an
420 indirect light calculation.
421 If the number of ambient bounces is one or greater and the ambient
422 value weight is non-zero (see
423 .I -aw
424 and
425 .I -ab
426 below), this value may be modified by the computed indirect values
427 to improve overall accuracy.
428 .TP
429 .BI -aw \ N
430 Set the relative weight of the ambient value given with the
431 .I -av
432 option to
433 .I N.
434 As new indirect irradiances are computed, they will modify the
435 default ambient value in a moving average, with the specified weight
436 assigned to the initial value given on the command and all other
437 weights set to 1.
438 If a value of 0 is given with this option, then the initial ambient
439 value is never modified.
440 This is the safest value for scenes with large differences in
441 indirect contributions, such as when both indoor and outdoor
442 (daylight) areas are visible.
443 .TP
444 .BI -ab \ N
445 Set the number of ambient bounces to
446 .I N.
447 This is the maximum number of diffuse bounces computed by the indirect
448 calculation. A value of zero implies no indirect calculation.
449 .IP
450 This value defaults to 1 in photon mapping mode (see
451 .I -ap
452 below), implying that global photon irradiance is always computed via
453 .I one
454 ambient bounce; this behaviour applies to any positive number of ambient
455 bounces, regardless of the actual value specified. A negative value enables
456 a preview mode that directly visualises the irradiance from the global
457 photon map without any ambient bounces.
458 .TP
459 .BI -ar \ res
460 Set the ambient resolution to
461 .I res.
462 This number will determine the maximum density of ambient values
463 used in interpolation.
464 Error will start to increase on surfaces spaced closer than
465 the scene size divided by the ambient resolution.
466 The maximum ambient value density is the scene size times the
467 ambient accuracy (see the
468 .I \-aa
469 option below) divided by the ambient resolution.
470 The scene size can be determined using
471 .I getinfo(1)
472 with the
473 .I \-d
474 option on the input octree.
475 A value of zero is interpreted as unlimited resolution.
476 .TP
477 .BI -aa \ acc
478 Set the ambient accuracy to
479 .I acc.
480 This value will approximately equal the error
481 from indirect irradiance interpolation.
482 A value of zero implies no interpolation.
483 .TP
484 .BI -ad \ N
485 Set the number of ambient divisions to
486 .I N.
487 The error in the Monte Carlo calculation of indirect
488 irradiance will be inversely proportional to the square
489 root of this number.
490 A value of zero implies no indirect calculation.
491 .TP
492 .BI -as \ N
493 Set the number of ambient super-samples to
494 .I N.
495 Super-samples are applied only to the ambient divisions which
496 show a significant change.
497 .TP
498 .BI -af \ fname
499 Set the ambient file to
500 .I fname.
501 This is where indirect irradiance will be stored and retrieved.
502 Normally, indirect irradiance values are kept in memory and
503 lost when the program finishes or dies.
504 By using a file, different invocations can share irradiance
505 values, saving time in the computation.
506 Also, by creating an ambient file during a low-resolution rendering,
507 better results can be obtained in a second high-resolution pass.
508 (It is a good idea to keep all of the calculation parameters the same,
509 changing only the dimensions of the output picture.)\0
510 The ambient file is in a machine-independent binary format
511 which may be examined with
512 .I lookamb(1).
513 .IP
514 The ambient file may also be used as a means of communication and
515 data sharing between simultaneously executing processes.
516 The same file may be used by multiple processes, possibly running on
517 different machines and accessing the file via the network (ie.
518 .I nfs(4)).
519 The network lock manager
520 .I lockd(8)
521 is used to insure that this information is used consistently.
522 .IP
523 If any calculation parameters are changed or the scene
524 is modified, the old ambient file should be removed so that
525 the calculation can start over from scratch.
526 For convenience, the original ambient parameters are listed in the
527 header of the ambient file.
528 .I Getinfo(1)
529 may be used to print out this information.
530 .TP
531 .BI -ae \ mod
532 Append
533 .I mod
534 to the ambient exclude list,
535 so that it will not be considered during the indirect calculation.
536 This is a hack for speeding the indirect computation by
537 ignoring certain objects.
538 Any object having
539 .I mod
540 as its modifier will get the default ambient
541 level rather than a calculated value.
542 Any number of excluded modifiers may be given, but each
543 must appear in a separate option.
544 .TP
545 .BI -ai \ mod
546 Add
547 .I mod
548 to the ambient include list,
549 so that it will be considered during the indirect calculation.
550 The program can use either an include list or an exclude
551 list, but not both.
552 .TP
553 .BI -aE \ file
554 Same as
555 .I \-ae,
556 except read modifiers to be excluded from
557 .I file.
558 The RAYPATH environment variable determines which directories are
559 searched for this file.
560 The modifier names are separated by white space in the file.
561 .TP
562 .BI -aI \ file
563 Same as
564 .I \-ai,
565 except read modifiers to be included from
566 .I file.
567 .TP
568 .BI -ap " file [bwidth1 [bwidth2]]"
569 Enable photon mapping mode. Loads a photon map generated with
570 .I mkpmap(1)
571 from
572 .I file,
573 and evaluates the indirect irradiance depending on the photon type
574 (automagically detected) using density estimates with a bandwidth of
575 .I bwidth1
576 photons, or the default bandwidth if none is specified (a warning will be
577 issued in this case).
578 .IP
579 Global photon irradiance is evaluated as part of the ambient calculation (see
580 .I \-ab
581 above), caustic photon irradiance is evaluated at primary rays, and
582 indirect inscattering in
583 .I mist
584 is accounted for by volume photons. Contribution photons are treated as
585 global photons by
586 .I rpict.
587 .IP
588 Additionally specifying
589 .I bwidth2
590 enables bias compensation for the density estimates with a
591 minimum and maximum bandwidth of
592 .I bwidth1
593 and
594 .I bwidth2,
595 respectively.
596 .IP
597 Global photon irradiance may be optionally precomputed by
598 .I mkpmap(1),
599 in which case the bandwidth, if specified, is ignored, as the nearest photon
600 is invariably looked up.
601 .IP
602 Using direct photons replaces the direct calculation with density estimates
603 for debugging and validation of photon emission.
604 .TP
605 .BI -am " frac"
606 Maximum search radius for photon map lookups. Without this option, an
607 initial maximum search radius is estimated for each photon map from the
608 average photon distance to the distribution's centre of gravity. It is then
609 adapted to the photon density in subsequent lookups. This option imposes a
610 global fixed maximum search radius for
611 .I all
612 photon maps, thus defeating the automatic adaptation. It is useful when
613 multiple warnings about short photon lookups are issued. Note that this
614 option does not conflict with the bandwidth specified with the
615 .I \-ap
616 option; the number of photons found will not exceed the latter, but may be
617 lower if the maximum search radius contains fewer photons, thus resulting in
618 short lookups. Setting this radius too large, on the other hand, may
619 degrade performance.
620 .TP
621 .BI -ac " pagesize"
622 Set the photon cache page size when using out-of-core photon mapping. The
623 photon cache reduces disk I/O incurred by on-demand loading (paging) of
624 photons, and thus increases performance. This
625 is expressed as a (float) multiple of the density estimate bandwidth
626 specified with
627 .I \-ap
628 under the assumption that photon lookups are local to a cache page. Cache
629 performance is sensitive to this parameter: larger pagesizes will reduce the
630 paging frequency at the expense of higher latency when paging does occur.
631 Sensible values are in the range 4 (default) to 16.
632 .TP
633 .BI -aC " cachesize"
634 Set the total number of photons cached when using out-of-core photon
635 mapping, taking into account the pagesize specified by
636 .I \-ac.
637 Note that this is approximate as the number of cache pages is rounded to
638 the nearest prime. This allows adapting the cache to the available physical
639 memory. Cache performance is less sensitive to this parameter, and reasonable
640 performance can obtained with as few as 10k photons. The default is 1M. This
641 option recognises multiplier suffixes (k = 1e3, M = 1e6), both in upper and
642 lower case.
643 .TP
644 .BI -me " rext gext bext"
645 Set the global medium extinction coefficient to the indicated color,
646 in units of 1/distance (distance in world coordinates).
647 Light will be scattered or absorbed over distance according to
648 this value.
649 The ratio of scattering to total scattering plus absorption is set
650 by the albedo parameter, described below.
651 .TP
652 .BI -ma " ralb galb balb"
653 Set the global medium albedo to the given value between 0\00\00
654 and 1\01\01.
655 A zero value means that all light not transmitted by the medium
656 is absorbed.
657 A unitary value means that all light not transmitted by the medium
658 is scattered in some new direction.
659 The isotropy of scattering is determined by the Heyney-Greenstein
660 parameter, described below.
661 .TP
662 .BI \-mg \ gecc
663 Set the medium Heyney-Greenstein eccentricity parameter to
664 .I gecc.
665 This parameter determines how strongly scattering favors the forward
666 direction.
667 A value of 0 indicates perfectly isotropic scattering.
668 As this parameter approaches 1, scattering tends to prefer the
669 forward direction.
670 .TP
671 .BI \-ms \ sampdist
672 Set the medium sampling distance to
673 .I sampdist,
674 in world coordinate units.
675 During source scattering, this will be the average distance between
676 adjacent samples.
677 A value of 0 means that only one sample will be taken per light
678 source within a given scattering volume.
679 .TP
680 .BR \-i
681 Boolean switch to compute irradiance rather than radiance values.
682 This only affects the final result, substituting a Lambertian
683 surface and multiplying the radiance by pi.
684 Glass and other transparent surfaces are ignored during this stage.
685 Light sources still appear with their original radiance values,
686 though the
687 .I \-dv
688 option (above) may be used to override this.
689 .TP
690 .BR \-u
691 Boolean switch to control uncorrelated random sampling.
692 When "off", a low-discrepancy sequence is used, which reduces
693 variance but can result in a dithered appearance in specular highlights.
694 When "on", pure Monte Carlo sampling is used in all calculations.
695 .TP
696 .BI -lr \ N
697 Limit reflections to a maximum of
698 .I N,
699 if N is a positive integer.
700 If
701 .I N
702 is zero, then Russian roulette is used for ray
703 termination, and the
704 .I -lw
705 setting (below) must be positive.
706 If N is a negative integer, then this limits the maximum
707 number of reflections even with Russian roulette.
708 In scenes with dielectrics and total internal reflection,
709 a setting of 0 (no limit) may cause a stack overflow.
710 .TP
711 .BI -lw \ frac
712 Limit the weight of each ray to a minimum of
713 .I frac.
714 During ray-tracing, a record is kept of the estimated contribution
715 (weight) a ray would have in the image.
716 If this weight is less than the specified minimum and the
717 .I -lr
718 setting (above) is positive, the ray is not traced.
719 Otherwise, Russian roulette is used to
720 continue rays with a probability equal to the ray weight
721 divided by the given
722 .I frac.
723 .TP
724 .BI -cs \ Ns
725 Use
726 .I Ns
727 bands for spectral sampling rather than the default RGB calculation space.
728 The maximum setting is controlled by the compiler macro MAXCSAMP, and
729 defaults to 24.
730 Larger values for Ns will be reduced to MAXCSAMP.
731 .TP
732 .BI -cw " nmA nmB"
733 Set extrema to the given wavelengths for spectral sampling.
734 The default is 380 and 780 nanometers.
735 The order specified does not matter.
736 .TP
737 .BI -S \ seqstart
738 Instead of generating a single picture based only on the view
739 parameters given on the command line, this option causes
740 .I rpict
741 to read view options from the standard input and for each line
742 containing a valid view specification, generate a corresponding
743 picture.
744 This option is most useful for generating animated sequences, though
745 it may also be used to control rpict from a remote process for
746 network-distributed rendering.
747 .I Seqstart
748 is a positive integer that will be associated with the first output
749 frame, and incremented for successive output frames.
750 By default, each frame is concatenated to the output stream, but it
751 is possible to change this action using the
752 .I \-o
753 option (described below).
754 Multiple frames may be later extracted from the output using
755 .I ra_rgbe(1).
756 .IP
757 Note that the octree may not be read from the standard input when
758 using this option.
759 .TP
760 .BI -o \ fspec
761 Send the picture(s) to the file(s) given by
762 .I fspec
763 instead of the standard output.
764 If this option is used in combination with
765 .I \-S
766 and
767 .I fspec
768 contains an integer field for
769 .I printf(3)
770 (eg. "%03d") then the actual output file name will include
771 the current frame number.
772 .I Rpict
773 will not allow a picture file to be clobbered (overwritten)
774 with this option.
775 If an image in a sequence already exists
776 .I (\-S
777 option),
778 .I rpict
779 will skip until it reaches an image that doesn't, or the end of
780 the sequence.
781 This is useful for running rpict on multiple machines or processors
782 to render the same sequence, as each process will skip to the next
783 frame that needs rendering.
784 .TP
785 .BI -r \ fn
786 Recover pixel information from the file
787 .I fn.
788 If the program gets killed during picture generation, the information
789 may be recovered using this option.
790 The view parameters and picture dimensions are also recovered from
791 .I fn
792 if possible.
793 The other options should be identical to those which created
794 .I fn,
795 or an inconsistent picture may result.
796 If
797 .I fn
798 is identical to the file specification given with the
799 .I \-o
800 option,
801 .I rpict
802 will rename the file prior to copying its contents.
803 This insures that the old file is not overwritten accidentally.
804 (See also the
805 .I \-ro
806 option, below.)\0
807 .IP
808 If
809 .I fn
810 is an integer and the recover option is used in combination with the
811 .I \-S
812 option, then
813 .I rpict
814 skips a number of view specifications on its input equal to the
815 difference between
816 .I fn
817 and
818 .I seqstart.
819 .I Rpict
820 then performs a recovery operation on the file constructed from the
821 frame number
822 .I fn
823 and the output file specification given with the
824 .I \-o
825 option.
826 This provides a convenient mechanism for recovering in the middle of
827 an aborted picture sequence.
828 .IP
829 The recovered file
830 will be removed if the operation is successful.
831 If the recover operation fails (due to lack of disk space)
832 and the output file and recover file specifications
833 are the same, then the original information may be left in a
834 renamed temporary file.
835 (See FILES section, below.)\0
836 .TP
837 .BI -ro \ fspec
838 This option causes pixel information to be recovered from and
839 subsequently returned to the picture file
840 .I fspec.
841 The effect is the same as specifying identical recover and output
842 file names with the
843 .I \-r
844 and
845 .I \-o
846 options.
847 .TP
848 .BI -z \ fspec
849 Write pixel distances out to the file
850 .I fspec.
851 The values are written as short floats, one per pixel in scanline order,
852 as required by
853 .I pinterp(1).
854 Similar to the
855 .I \-o
856 option, the actual file name will be constructed using
857 .I printf
858 and the frame number from the
859 .I \-S
860 option.
861 If used with the
862 .I \-r
863 option,
864 .I \-z
865 also recovers information from an aborted rendering.
866 .TP
867 .BI \-P \ pfile
868 Execute in a persistent mode, using
869 .I pfile
870 as the control file.
871 This option must be used together with
872 .I \-S,
873 and is incompatible with the recover option
874 .I (\-r).
875 Persistent execution means that after reaching end-of-file on
876 its input,
877 .I rpict
878 will fork a child process that will wait for another
879 .I rpict
880 command with the same
881 .I \-P
882 option to attach to it.
883 (Note that since the rest of the command line options will be those
884 of the original invocation, it is not necessary to give any arguments
885 besides
886 .I \-P
887 for subsequent calls.)
888 Killing the process is achieved with the
889 .I kill(1)
890 command.
891 (The process ID in the first line of
892 .I pfile
893 may be used to identify the waiting
894 .I rpict
895 process.)
896 This option may be less useful than the
897 .I \-PP
898 variation, explained below.
899 .TP
900 .BI \-PP \ pfile
901 Execute in continuous-forking persistent mode, using
902 .I pfile
903 as the control file.
904 The difference between this option and the
905 .I \-P
906 option described above is the creation of multiple duplicate
907 processes to handle any number of attaches.
908 This provides a simple and reliable mechanism of memory sharing
909 on most multiprocessing platforms, since the
910 .I fork(2)
911 system call will share memory on a copy-on-write basis.
912 This option may be used with
913 .I rpiece(1)
914 to efficiently render a single image using multiple processors
915 on the same host.
916 .TP
917 .BI -t \ sec
918 Set the time between progress reports to
919 .I sec.
920 A progress report writes the number of rays traced, the percentage
921 completed, and the CPU usage to the standard error.
922 Reports are given either automatically after the specified interval,
923 or when the process receives a continue (\-CONT) signal (see
924 .I kill(1)).
925 A value of zero turns automatic reporting off.
926 .TP
927 .BI -e \ efile
928 Send error messages and progress reports to
929 .I efile
930 instead of the standard error.
931 (Note this option overlaps with "-e expr" above, so file paths
932 with '=' or ':' in them are not allowed on this option.)
933 .TP
934 .BR \-w
935 Boolean switch for warning messages.
936 The default is to print warnings, so the first appearance of
937 this option turns them off.
938 .SH EXAMPLE
939 rpict \-vp 10 5 3 \-vd 1 \-.5 0 scene.oct > scene.hdr
940 .PP
941 rpict \-S 1 \-o frame%02d.hdr scene.oct < keyframes.vf
942 .PP
943 To render ambient irradiance in photon mapping mode from a global photon
944 map global.pm via one ambient bounce, and from a caustic photon map
945 caustic.pm:
946 .IP "" .2i
947 rpict -ab 1 -ap global.pm 50 -ap caustic.pm 50 -vf scene.vf scene.oct >
948 scene.hdr
949 .SH ENVIRONMENT
950 RAYPATH the directories to check for auxiliary files.
951 .SH FILES
952 /tmp/rtXXXXXX common header information for picture sequence
953 .br
954 rfXXXXXX temporary name for recover file
955 .SH DIAGNOSTICS
956 If the program terminates from an input related error, the exit status
957 will be 1.
958 A system related error results in an exit status of 2.
959 If the program receives a signal that is caught, it will exit with a status
960 of 3.
961 In each case, an error message will be printed to the standard error, or
962 to the file designated by the
963 .I \-e
964 option.
965 .SH AUTHOR
966 Greg Ward
967 .SH "SEE ALSO"
968 getinfo(1), lookamb(1), mkpmap(1), oconv(1), pdfblur(1), pfilt(1),
969 pinterp(1), pmblur(1), printf(3), ra_rgbe(1), rad(1), rpiece(1), rtpict(1), rtrace(1), rvu(1)