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

Comparing ray/doc/man/man1/rpict.1 (file contents):
Revision 1.1 by greg, Tue Mar 11 19:20:21 2003 UTC vs.
Revision 1.23 by greg, Tue Mar 20 02:40:38 2018 UTC

# Line 1 | Line 1
1 < .\" RCSid "$Id"
1 > .\" RCSid "$Id$"
2   .TH RPICT 1 2/26/99 RADIANCE
3   .SH NAME
4   rpict - generate a RADIANCE picture
# Line 70 | Line 70 | A cylindrical panorma may be selected by setting
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 < Two fisheye views are provided as well; 'h' yields a hemispherical fisheye
74 < view and 'a' results in angular fisheye distortion.
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
# Line 89 | Line 97 | center of a parallel projection.
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
# Line 149 | Line 160 | This is option is useful for generating skewed perspec
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.
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
# Line 163 | Line 174 | option.
174   .BI -vf \ file
175   Get view parameters from
176   .I file,
177 < which may be a picture or a file created by rview (with the "view" command).
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
# Line 226 | Line 237 | 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.
# Line 243 | Line 271 | 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.
274 > direct jitter by setting \-ps to 1.
275   .TP
276   .BI -ds \ frac
277   Set the direct sampling ratio to
# Line 307 | Line 335 | 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 -sj \ frac
339 < Set the specular sampling jitter to
340 < .I frac.
341 < This is the degree to which the highlights are sampled
342 < for rough specular materials.
343 < A value of one means that all highlights will be fully sampled
344 < using distributed ray tracing.
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
# Line 337 | Line 365 | accuracy and rendering time.
365   .TP
366   .BR -bv
367   Boolean switch for back face visibility.
368 < With this switch off, back faces of opaque objects will be invisible
369 < to all rays.
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 on opaque objects face outward.
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.
348 This option has no effect on transparent or translucent materials.
376   .TP
377   .BI -av " red grn blu"
378   Set the ambient value to a radiance of
# Line 378 | Line 405 | indirect contributions, such as when both indoor and o
405   .BI -ab \ N
406   Set the number of ambient bounces to
407   .I N.
408 < This is the maximum number of diffuse bounces
409 < computed by the indirect calculation.
410 < A value of zero implies no indirect calculation.
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
# Line 452 | Line 487 | header of the ambient file.
487   .I Getinfo(1)
488   may be used to print out this information.
489   .TP
490 < .BI -ae \ mat
490 > .BI -ae \ mod
491   Append
492 < .I mat
492 > .I mod
493   to the ambient exclude list,
494   so that it will not be considered during the indirect calculation.
495   This is a hack for speeding the indirect computation by
496   ignoring certain objects.
497   Any object having
498 < .I mat
498 > .I mod
499   as its modifier will get the default ambient
500   level rather than a calculated value.
501 < Any number of excluded materials may be given, but each
501 > Any number of excluded modifiers may be given, but each
502   must appear in a separate option.
503   .TP
504 < .BI -ai \ mat
504 > .BI -ai \ mod
505   Add
506 < .I mat
506 > .I mod
507   to the ambient include list,
508   so that it will be considered during the indirect calculation.
509   The program can use either an include list or an exclude
# Line 477 | Line 512 | list, but not both.
512   .BI -aE \ file
513   Same as
514   .I \-ae,
515 < except read materials to be excluded from
515 > except read modifiers to be excluded from
516   .I file.
517   The RAYPATH environment variable determines which directories are
518   searched for this file.
519 < The material names are separated by white space in the file.
519 > The modifier names are separated by white space in the file.
520   .TP
521   .BI -aI \ file
522   Same as
523   .I \-ai,
524 < except read materials to be included from
524 > except read modifiers to be included from
525   .I file.
526   .TP
527 + .BI -ap " file [bwidth1 [bwidth2]]"
528 + Enable photon mapping mode. Loads a photon map generated with
529 + .I mkpmap(1)
530 + from
531 + .I file,
532 + and evaluates the indirect irradiance depending on the photon type
533 + (automagically detected) using density estimates with a bandwidth of
534 + .I bwidth1
535 + photons, or the default bandwidth if none is specified (a warning will be
536 + issued in this case).
537 + .IP
538 + Global photon irradiance is evaluated as part of the ambient calculation (see
539 + .I \-ab
540 + above), caustic photon irradiance is evaluated at primary rays, and
541 + indirect inscattering in
542 + .I mist
543 + is accounted for by volume photons. Contribution photons are treated as
544 + global photons by
545 + .I rpict.
546 + .IP
547 + Additionally specifying
548 + .I bwidth2
549 + enables bias compensation for the density estimates with a
550 + minimum and maximum bandwidth of
551 + .I bwidth1
552 + and
553 + .I bwidth2,
554 + respectively.
555 + .IP
556 + Global photon irradiance may be optionally precomputed by
557 + .I mkpmap(1),
558 + in which case the bandwidth, if specified, is ignored, as the nearest photon
559 + is invariably looked up.
560 + .IP
561 + Using direct photons replaces the direct calculation with density estimates
562 + for debugging and validation of photon emission.
563 + .TP
564 + .BI -am " frac"
565 + Maximum search radius for photon map lookups.  Without this option, an
566 + initial maximum search radius is estimated for each photon map from the
567 + average photon distance to the distribution's centre of gravity.  It is then
568 + adapted to the photon density in subsequent lookups.  This option imposes a
569 + global fixed maximum search radius for
570 + .I all
571 + photon maps, thus defeating the automatic adaptation.  It is useful when
572 + multiple warnings about short photon lookups are issued.  Note that this
573 + option does not conflict with the bandwidth specified with the
574 + .I \-ap
575 + option; the number of photons found will not exceed the latter, but may be
576 + lower if the maximum search radius contains fewer photons, thus resulting in
577 + short lookups.  Setting this radius too large, on the other hand, may
578 + degrade performance.
579 + .TP
580 + .BI -ac " pagesize"
581 + Set the photon cache page size when using out-of-core photon mapping. The
582 + photon cache reduces disk I/O incurred by on-demand loading (paging) of
583 + photons, and thus increases performance. This
584 + is expressed as a (float) multiple of the density estimate bandwidth
585 + specified with
586 + .I \-ap
587 + under the assumption that photon lookups are local to a cache page. Cache
588 + performance is sensitive to this parameter: larger pagesizes will reduce the
589 + paging frequency at the expense of higher latency when paging does occur.
590 + Sensible values are in the range 4 (default) to 16.
591 + .TP
592 + .BI -aC " cachesize"
593 + Set the total number of photons cached when using out-of-core photon
594 + mapping, taking into account the pagesize specified by
595 + .I \-ac.
596 + Note that this is approximate as the number of cache pages is rounded to
597 + the nearest prime. This allows adapting the cache to the available physical
598 + memory. In conjunction with the
599 + .I \-n
600 + option, this is the cache size
601 + .I per parallel process.
602 + Cache performance is less sensitive to this parameter,
603 + and reasonable performance can obtained with as few as 10k photons. The
604 + default is 1M. This option recognises multiplier suffixes (k = 1e3, M =
605 + 1e6), both in upper and lower case.
606 + .TP
607   .BI -me " rext gext bext"
608   Set the global medium extinction coefficient to the indicated color,
609   in units of 1/distance (distance in world coordinates).
# Line 535 | Line 650 | though the
650   .I \-dv
651   option (above) may be used to override this.
652   .TP
653 + .BR \-u
654 + Boolean switch to control uncorrelated random sampling.
655 + When "off", a low-discrepancy sequence is used, which reduces
656 + variance but can result in a dithered appearance in specular highlights.
657 + When "on", pure Monte Carlo sampling is used in all calculations.
658 + .TP
659   .BI -lr \ N
660   Limit reflections to a maximum of
661 < .I N.
661 > .I N,
662 > if N is a positive integer.
663 > If
664 > .I N
665 > is zero, then Russian roulette is used for ray
666 > termination, and the
667 > .I -lw
668 > setting (below) must be positive.
669 > If N is a negative integer, then this sets the upper limit
670 > of reflections past which Russian roulette will be used.
671 > In scenes with dielectrics and total internal reflection,
672 > a setting of 0 (no limit) may cause a stack overflow.
673   .TP
674   .BI -lw \ frac
675   Limit the weight of each ray to a minimum of
676   .I frac.
677 < During ray-tracing, a record is kept of the final contribution
678 < a ray would have to the image.
679 < If it is less then the specified minimum, the ray is not traced.
677 > During ray-tracing, a record is kept of the estimated contribution
678 > (weight) a ray would have in the image.
679 > If this weight is less than the specified minimum and the
680 > .I -lr
681 > setting (above) is positive, the ray is not traced.
682 > Otherwise, Russian roulette is used to
683 > continue rays with a probability equal to the ray weight
684 > divided by the given
685 > .I frac.
686   .TP
687   .BI -S \ seqstart
688   Instead of generating a single picture based only on the view
# Line 732 | Line 870 | Set the time between progress reports to
870   A progress report writes the number of rays traced, the percentage
871   completed, and the CPU usage to the standard error.
872   Reports are given either automatically after the specified interval,
873 < or when the process receives a continue (-CONT) signal (see
873 > or when the process receives a continue (\-CONT) signal (see
874   .I kill(1)).
875   A value of zero turns automatic reporting off.
876   .TP
# Line 746 | Line 884 | Boolean switch for warning messages.
884   The default is to print warnings, so the first appearance of
885   this option turns them off.
886   .SH EXAMPLE
887 < rpict -vp 10 5 3 -vd 1 -.5 0 scene.oct > scene.pic
887 > rpict \-vp 10 5 3 \-vd 1 \-.5 0 scene.oct > scene.hdr
888   .PP
889 < rpict -S 1 -o frame%02d.pic scene.oct < keyframes.vf
889 > rpict \-S 1 \-o frame%02d.hdr scene.oct < keyframes.vf
890 > .PP
891 > To render ambient illuminance in photon mapping mode from a global photon
892 > map global.pm via one ambient bounce, and from a caustic photon map
893 > caustic.pm:
894 > .IP "" .2i
895 > rpict -ab 1 -ap global.pm 50 -ap caustic.pm 50 -vf scene.vf scene.oct >
896 > scene.hdr
897   .SH ENVIRONMENT
898   RAYPATH         the directories to check for auxiliary files.
899   .SH FILES
900 < /usr/tmp/rtXXXXXX               common header information for picture sequence
900 > /tmp/rtXXXXXX           common header information for picture sequence
901   .br
902   rfXXXXXX                temporary name for recover file
903   .SH DIAGNOSTICS
# Line 768 | Line 913 | option.
913   .SH AUTHOR
914   Greg Ward
915   .SH "SEE ALSO"
916 < getinfo(1), lookamb(1), oconv(1), pfilt(1), pinterp(1), pmblur(1),
917 < printf(3), ra_rgbe(1), rad(1), rtrace(1), rview(1)
916 > getinfo(1), lookamb(1), mkpmap(1), oconv(1), pdfblur(1), pfilt(1),
917 > pinterp(1), pmblur(1), printf(3), ra_rgbe(1), rad(1), rpiece(1), rtpict(1), rtrace(1), rvu(1)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines