ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/rpict.1
Revision: 1.27
Committed: Wed Oct 19 18:23:14 2022 UTC (23 months ago) by greg
Branch: MAIN
Changes since 1.26: +14 -14 lines
Log Message:
docs: made use of "virtual" and "secondary" sources more consistent

File Contents

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