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.31 by greg, Tue Apr 22 17:12:25 2025 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 18 | Line 18 | rpict - generate a RADIANCE picture
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
# Line 41 | Line 43 | 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
# Line 70 | Line 87 | A cylindrical panorma may be selected by setting
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 < Two fisheye views are provided as well; 'h' yields a hemispherical fisheye
91 < view and 'a' results in angular fisheye distortion.
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
# Line 89 | Line 114 | center of a parallel projection.
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
# Line 149 | Line 177 | This is option is useful for generating skewed perspec
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.
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
# Line 163 | Line 191 | option.
191   .BI -vf \ file
192   Get view parameters from
193   .I file,
194 < which may be a picture or a file created by rview (with the "view" command).
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
# Line 200 | Line 228 | Set the pixel sample jitter to
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.
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 between zero and one is usually best
206 < for low-resolution images.
234 > A value around 0.5-0.8 is typical.
235   .TP
236   .BI -pm \ frac
237   Set the pixel motion blur to
# Line 226 | Line 254 | 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
286 + .I source
287 + and assign at global level.
288 + .TP
289 + .BI -e \ expr
290 + Set additional definitions from
291 + .I expr.
292 + .TP
293   .BI -dj \ frac
294   Set the direct jittering to
295   .I frac.
# Line 243 | Line 307 | A warning about aiming failure will issued if
307   .I frac
308   is too large.
309   It is usually wise to turn off image sampling when using
310 < direct jitter by setting -ps to 1.
310 > direct jitter by setting \-ps to 1.
311   .TP
312   .BI -ds \ frac
313   Set the direct sampling ratio to
# Line 282 | Line 346 | change greater than the
346   specification will be calculated.
347   .TP
348   .BI -dr \ N
349 < Set the number of relays for secondary sources to
349 > Set the number of relays for virtual sources to
350   .I N.
351 < A value of 0 means that secondary sources will be ignored.
351 > A value of 0 means that virtual sources will be ignored.
352   A value of 1 means that sources will be made into first generation
353 < secondary sources; a value of 2 means that first generation
354 < secondary sources will also be made into second generation secondary
353 > virtual sources; a value of 2 means that first generation
354 > virtual sources will also be made into second generation virtual
355   sources, and so on.
356   .TP
357   .BI -dp \ D
358 < Set the secondary source presampling density to D.
358 > Set the virtual source presampling density to D.
359   This is the number of samples per steradian
360   that will be used to determine ahead of time whether or not
361   it is worth following shadow rays through all the reflections and/or
362 < transmissions associated with a secondary source path.
363 < A value of 0 means that the full secondary source path will always
362 > transmissions associated with a virtual source path.
363 > A value of 0 means that the full virtual source path will always
364   be tested for shadows if it is tested at all.
365   .TP
366   .BR \-dv
# Line 307 | Line 371 | This option may be desirable in conjunction with the
371   .I \-i
372   option so that light sources do not appear in the output.
373   .TP
374 < .BI -sj \ frac
375 < Set the specular sampling jitter to
376 < .I frac.
377 < This is the degree to which the highlights are sampled
378 < for rough specular materials.
379 < A value of one means that all highlights will be fully sampled
380 < using distributed ray tracing.
374 > .BI -ss \ samp
375 > Set the specular sampling to
376 > .I samp.
377 > For values less than 1, this is the degree to which the highlights
378 > are sampled for rough specular materials.
379 > A value greater than one causes multiple ray samples to be sent
380 > to reduce noise at a commmesurate cost.
381   A value of zero means that no jittering will take place, and all
382   reflections will appear sharp even when they should be diffuse.
383   This may be desirable when used in combination with image sampling
# Line 337 | Line 401 | accuracy and rendering time.
401   .TP
402   .BR -bv
403   Boolean switch for back face visibility.
404 < With this switch off, back faces of opaque objects will be invisible
405 < to all rays.
404 > With this switch off, back faces of all objects will be invisible
405 > to view rays.
406   This is dangerous unless the model was constructed such that
407 < all surface normals on opaque objects face outward.
407 > all surface normals face outward.
408   Although turning off back face visibility does not save much
409   computation time under most circumstances, it may be useful as a
410   tool for scene debugging, or for seeing through one-sided walls from
411   the outside.
348 This option has no effect on transparent or translucent materials.
412   .TP
413   .BI -av " red grn blu"
414   Set the ambient value to a radiance of
# Line 378 | Line 441 | indirect contributions, such as when both indoor and o
441   .BI -ab \ N
442   Set the number of ambient bounces to
443   .I N.
444 < This is the maximum number of diffuse bounces
445 < computed by the indirect calculation.
446 < A value of zero implies no indirect calculation.
444 > This is the maximum number of diffuse bounces computed by the indirect
445 > calculation. A value of zero implies no indirect calculation.
446 > .IP
447 > This value defaults to 1 in photon mapping mode (see
448 > .I -ap
449 > below), implying that global photon irradiance is always computed via
450 > .I one
451 > ambient bounce; this behaviour applies to any positive number of ambient
452 > bounces, regardless of the actual value specified.  A negative value enables
453 > a preview mode that directly visualises the irradiance from the global
454 > photon map without any ambient bounces.
455   .TP
456   .BI -ar \ res
457   Set the ambient resolution to
# Line 404 | Line 475 | A value of zero is interpreted as unlimited resolution
475   Set the ambient accuracy to
476   .I acc.
477   This value will approximately equal the error
478 < from indirect illuminance interpolation.
478 > from indirect irradiance interpolation.
479   A value of zero implies no interpolation.
480   .TP
481   .BI -ad \ N
482   Set the number of ambient divisions to
483   .I N.
484   The error in the Monte Carlo calculation of indirect
485 < illuminance will be inversely proportional to the square
485 > irradiance will be inversely proportional to the square
486   root of this number.
487   A value of zero implies no indirect calculation.
488   .TP
# Line 424 | Line 495 | show a significant change.
495   .BI -af \ fname
496   Set the ambient file to
497   .I fname.
498 < This is where indirect illuminance will be stored and retrieved.
499 < Normally, indirect illuminance values are kept in memory and
498 > This is where indirect irradiance will be stored and retrieved.
499 > Normally, indirect irradiance values are kept in memory and
500   lost when the program finishes or dies.
501 < By using a file, different invocations can share illuminance
501 > By using a file, different invocations can share irradiance
502   values, saving time in the computation.
503 < Also, by creating an ambient file during a low resolution rendering,
504 < better results can be obtained in a second high resolution pass.
503 > Also, by creating an ambient file during a low-resolution rendering,
504 > better results can be obtained in a second high-resolution pass.
505 > (It is a good idea to keep all of the calculation parameters the same,
506 > changing only the dimensions of the output picture.)\0
507   The ambient file is in a machine-independent binary format
508   which may be examined with
509   .I lookamb(1).
# Line 452 | Line 525 | header of the ambient file.
525   .I Getinfo(1)
526   may be used to print out this information.
527   .TP
528 < .BI -ae \ mat
528 > .BI -ae \ mod
529   Append
530 < .I mat
530 > .I mod
531   to the ambient exclude list,
532   so that it will not be considered during the indirect calculation.
533   This is a hack for speeding the indirect computation by
534   ignoring certain objects.
535   Any object having
536 < .I mat
536 > .I mod
537   as its modifier will get the default ambient
538   level rather than a calculated value.
539 < Any number of excluded materials may be given, but each
539 > Any number of excluded modifiers may be given, but each
540   must appear in a separate option.
541   .TP
542 < .BI -ai \ mat
542 > .BI -ai \ mod
543   Add
544 < .I mat
544 > .I mod
545   to the ambient include list,
546   so that it will be considered during the indirect calculation.
547   The program can use either an include list or an exclude
# Line 477 | Line 550 | list, but not both.
550   .BI -aE \ file
551   Same as
552   .I \-ae,
553 < except read materials to be excluded from
553 > except read modifiers to be excluded from
554   .I file.
555   The RAYPATH environment variable determines which directories are
556   searched for this file.
557 < The material names are separated by white space in the file.
557 > The modifier names are separated by white space in the file.
558   .TP
559   .BI -aI \ file
560   Same as
561   .I \-ai,
562 < except read materials to be included from
562 > except read modifiers to be included from
563   .I file.
564   .TP
565 + .BI -ap " file [bwidth1 [bwidth2]]"
566 + Enable photon mapping mode. Loads a photon map generated with
567 + .I mkpmap(1)
568 + from
569 + .I file,
570 + and evaluates the indirect irradiance depending on the photon type
571 + (automagically detected) using density estimates with a bandwidth of
572 + .I bwidth1
573 + photons, or the default bandwidth if none is specified (a warning will be
574 + issued in this case).
575 + .IP
576 + Global photon irradiance is evaluated as part of the ambient calculation (see
577 + .I \-ab
578 + above), caustic photon irradiance is evaluated at primary rays, and
579 + indirect inscattering in
580 + .I mist
581 + is accounted for by volume photons. Contribution photons are treated as
582 + global photons by
583 + .I rpict.
584 + .IP
585 + Additionally specifying
586 + .I bwidth2
587 + enables bias compensation for the density estimates with a
588 + minimum and maximum bandwidth of
589 + .I bwidth1
590 + and
591 + .I bwidth2,
592 + respectively.
593 + .IP
594 + Global photon irradiance may be optionally precomputed by
595 + .I mkpmap(1),
596 + in which case the bandwidth, if specified, is ignored, as the nearest photon
597 + is invariably looked up.
598 + .IP
599 + Using direct photons replaces the direct calculation with density estimates
600 + for debugging and validation of photon emission.
601 + .TP
602 + .BI -am " frac"
603 + Maximum search radius for photon map lookups.  Without this option, an
604 + initial maximum search radius is estimated for each photon map from the
605 + average photon distance to the distribution's centre of gravity.  It is then
606 + adapted to the photon density in subsequent lookups.  This option imposes a
607 + global fixed maximum search radius for
608 + .I all
609 + photon maps, thus defeating the automatic adaptation.  It is useful when
610 + multiple warnings about short photon lookups are issued.  Note that this
611 + option does not conflict with the bandwidth specified with the
612 + .I \-ap
613 + option; the number of photons found will not exceed the latter, but may be
614 + lower if the maximum search radius contains fewer photons, thus resulting in
615 + short lookups.  Setting this radius too large, on the other hand, may
616 + degrade performance.
617 + .TP
618 + .BI -ac " pagesize"
619 + Set the photon cache page size when using out-of-core photon mapping. The
620 + photon cache reduces disk I/O incurred by on-demand loading (paging) of
621 + photons, and thus increases performance. This
622 + is expressed as a (float) multiple of the density estimate bandwidth
623 + specified with
624 + .I \-ap
625 + under the assumption that photon lookups are local to a cache page. Cache
626 + performance is sensitive to this parameter: larger pagesizes will reduce the
627 + paging frequency at the expense of higher latency when paging does occur.
628 + Sensible values are in the range 4 (default) to 16.
629 + .TP
630 + .BI -aC " cachesize"
631 + Set the total number of photons cached when using out-of-core photon
632 + mapping, taking into account the pagesize specified by
633 + .I \-ac.
634 + Note that this is approximate as the number of cache pages is rounded to
635 + the nearest prime. This allows adapting the cache to the available physical
636 + memory. Cache performance is less sensitive to this parameter, and reasonable
637 + performance can obtained with as few as 10k photons. The default is 1M. This
638 + option recognises multiplier suffixes (k = 1e3, M = 1e6), both in upper and
639 + lower case.
640 + .TP
641   .BI -me " rext gext bext"
642   Set the global medium extinction coefficient to the indicated color,
643   in units of 1/distance (distance in world coordinates).
# Line 535 | Line 684 | though the
684   .I \-dv
685   option (above) may be used to override this.
686   .TP
687 + .BR \-u
688 + Boolean switch to control uncorrelated random sampling.
689 + When "off", a low-discrepancy sequence is used, which reduces
690 + variance but can result in a dithered appearance in specular highlights.
691 + When "on", pure Monte Carlo sampling is used in all calculations.
692 + .TP
693   .BI -lr \ N
694   Limit reflections to a maximum of
695 < .I N.
695 > .I N,
696 > if N is a positive integer.
697 > If
698 > .I N
699 > is zero, then Russian roulette is used for ray
700 > termination, and the
701 > .I -lw
702 > setting (below) must be positive.
703 > If N is a negative integer, then this limits the maximum
704 > number of reflections even with Russian roulette.
705 > In scenes with dielectrics and total internal reflection,
706 > a setting of 0 (no limit) may cause a stack overflow.
707   .TP
708   .BI -lw \ frac
709   Limit the weight of each ray to a minimum of
710   .I frac.
711 < During ray-tracing, a record is kept of the final contribution
712 < a ray would have to the image.
713 < If it is less then the specified minimum, the ray is not traced.
711 > During ray-tracing, a record is kept of the estimated contribution
712 > (weight) a ray would have in the image.
713 > If this weight is less than the specified minimum and the
714 > .I -lr
715 > setting (above) is positive, the ray is not traced.
716 > Otherwise, Russian roulette is used to
717 > continue rays with a probability equal to the ray weight
718 > divided by the given
719 > .I frac.
720   .TP
721 + .BI -cs \ Ns
722 + Use
723 + .I Ns
724 + bands for spectral sampling rather than the default RGB calculation space.
725 + The maximum setting is controlled by the compiler macro MAXCSAMP, and
726 + defaults to 24.
727 + Larger values for Ns will be reduced to MAXCSAMP.
728 + .TP
729 + .BI -cw " nmA nmB"
730 + Set extrema to the given wavelengths for spectral sampling.
731 + The default is 380 and 780 nanometers.
732 + The order specified does not matter.
733 + .TP
734   .BI -S \ seqstart
735   Instead of generating a single picture based only on the view
736   parameters given on the command line, this option causes
# Line 732 | Line 917 | Set the time between progress reports to
917   A progress report writes the number of rays traced, the percentage
918   completed, and the CPU usage to the standard error.
919   Reports are given either automatically after the specified interval,
920 < or when the process receives a continue (-CONT) signal (see
920 > or when the process receives a continue (\-CONT) signal (see
921   .I kill(1)).
922   A value of zero turns automatic reporting off.
923   .TP
# Line 740 | Line 925 | A value of zero turns automatic reporting off.
925   Send error messages and progress reports to
926   .I efile
927   instead of the standard error.
928 + (Note this option overlaps with "-e expr" above, so file paths
929 + with '=' or ':' in them are not allowed on this option.)
930   .TP
931   .BR \-w
932   Boolean switch for warning messages.
933   The default is to print warnings, so the first appearance of
934   this option turns them off.
935   .SH EXAMPLE
936 < rpict -vp 10 5 3 -vd 1 -.5 0 scene.oct > scene.pic
936 > rpict \-vp 10 5 3 \-vd 1 \-.5 0 scene.oct > scene.hdr
937   .PP
938 < rpict -S 1 -o frame%02d.pic scene.oct < keyframes.vf
938 > rpict \-S 1 \-o frame%02d.hdr scene.oct < keyframes.vf
939 > .PP
940 > To render ambient irradiance in photon mapping mode from a global photon
941 > map global.pm via one ambient bounce, and from a caustic photon map
942 > caustic.pm:
943 > .IP "" .2i
944 > rpict -ab 1 -ap global.pm 50 -ap caustic.pm 50 -vf scene.vf scene.oct >
945 > scene.hdr
946   .SH ENVIRONMENT
947   RAYPATH         the directories to check for auxiliary files.
948   .SH FILES
949 < /usr/tmp/rtXXXXXX               common header information for picture sequence
949 > /tmp/rtXXXXXX           common header information for picture sequence
950   .br
951   rfXXXXXX                temporary name for recover file
952   .SH DIAGNOSTICS
# Line 768 | Line 962 | option.
962   .SH AUTHOR
963   Greg Ward
964   .SH "SEE ALSO"
965 < getinfo(1), lookamb(1), oconv(1), pfilt(1), pinterp(1), pmblur(1),
966 < printf(3), ra_rgbe(1), rad(1), rtrace(1), rview(1)
965 > getinfo(1), lookamb(1), mkpmap(1), oconv(1), pdfblur(1), pfilt(1),
966 > 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