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.10 by greg, Tue Jun 14 03:34:14 2005 UTC vs.
Revision 1.29 by greg, Wed Nov 15 18:02:52 2023 UTC

# 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 152 | 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 203 | 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
209 < 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 263 | Line 288 | A warning about aiming failure will issued if
288   .I frac
289   is too large.
290   It is usually wise to turn off image sampling when using
291 < direct jitter by setting -ps to 1.
291 > direct jitter by setting \-ps to 1.
292   .TP
293   .BI -ds \ frac
294   Set the direct sampling ratio to
# Line 302 | Line 327 | change greater than the
327   specification will be calculated.
328   .TP
329   .BI -dr \ N
330 < Set the number of relays for secondary sources to
330 > Set the number of relays for virtual sources to
331   .I N.
332 < A value of 0 means that secondary sources will be ignored.
332 > A value of 0 means that virtual sources will be ignored.
333   A value of 1 means that sources will be made into first generation
334 < secondary sources; a value of 2 means that first generation
335 < secondary sources will also be made into second generation secondary
334 > virtual sources; a value of 2 means that first generation
335 > virtual sources will also be made into second generation virtual
336   sources, and so on.
337   .TP
338   .BI -dp \ D
339 < Set the secondary source presampling density to D.
339 > Set the virtual source presampling density to D.
340   This is the number of samples per steradian
341   that will be used to determine ahead of time whether or not
342   it is worth following shadow rays through all the reflections and/or
343 < transmissions associated with a secondary source path.
344 < A value of 0 means that the full secondary source path will always
343 > transmissions associated with a virtual source path.
344 > A value of 0 means that the full virtual source path will always
345   be tested for shadows if it is tested at all.
346   .TP
347   .BR \-dv
# Line 327 | Line 352 | This option may be desirable in conjunction with the
352   .I \-i
353   option so that light sources do not appear in the output.
354   .TP
355 < .BI -sj \ frac
356 < Set the specular sampling jitter to
357 < .I frac.
358 < This is the degree to which the highlights are sampled
359 < for rough specular materials.
360 < A value of one means that all highlights will be fully sampled
361 < using distributed ray tracing.
355 > .BI -ss \ samp
356 > Set the specular sampling to
357 > .I samp.
358 > For values less than 1, this is the degree to which the highlights
359 > are sampled for rough specular materials.
360 > A value greater than one causes multiple ray samples to be sent
361 > to reduce noise at a commmesurate cost.
362   A value of zero means that no jittering will take place, and all
363   reflections will appear sharp even when they should be diffuse.
364   This may be desirable when used in combination with image sampling
# Line 357 | Line 382 | accuracy and rendering time.
382   .TP
383   .BR -bv
384   Boolean switch for back face visibility.
385 < With this switch off, back faces of opaque objects will be invisible
386 < to all rays.
385 > With this switch off, back faces of all objects will be invisible
386 > to view rays.
387   This is dangerous unless the model was constructed such that
388 < all surface normals on opaque objects face outward.
388 > all surface normals face outward.
389   Although turning off back face visibility does not save much
390   computation time under most circumstances, it may be useful as a
391   tool for scene debugging, or for seeing through one-sided walls from
392   the outside.
368 This option has no effect on transparent or translucent materials.
393   .TP
394   .BI -av " red grn blu"
395   Set the ambient value to a radiance of
# Line 398 | Line 422 | indirect contributions, such as when both indoor and o
422   .BI -ab \ N
423   Set the number of ambient bounces to
424   .I N.
425 < This is the maximum number of diffuse bounces
426 < computed by the indirect calculation.
427 < A value of zero implies no indirect calculation.
425 > This is the maximum number of diffuse bounces computed by the indirect
426 > calculation. A value of zero implies no indirect calculation.
427 > .IP
428 > This value defaults to 1 in photon mapping mode (see
429 > .I -ap
430 > below), implying that global photon irradiance is always computed via
431 > .I one
432 > ambient bounce; this behaviour applies to any positive number of ambient
433 > bounces, regardless of the actual value specified.  A negative value enables
434 > a preview mode that directly visualises the irradiance from the global
435 > photon map without any ambient bounces.
436   .TP
437   .BI -ar \ res
438   Set the ambient resolution to
# Line 424 | Line 456 | A value of zero is interpreted as unlimited resolution
456   Set the ambient accuracy to
457   .I acc.
458   This value will approximately equal the error
459 < from indirect illuminance interpolation.
459 > from indirect irradiance interpolation.
460   A value of zero implies no interpolation.
461   .TP
462   .BI -ad \ N
463   Set the number of ambient divisions to
464   .I N.
465   The error in the Monte Carlo calculation of indirect
466 < illuminance will be inversely proportional to the square
466 > irradiance will be inversely proportional to the square
467   root of this number.
468   A value of zero implies no indirect calculation.
469   .TP
# Line 444 | Line 476 | show a significant change.
476   .BI -af \ fname
477   Set the ambient file to
478   .I fname.
479 < This is where indirect illuminance will be stored and retrieved.
480 < Normally, indirect illuminance values are kept in memory and
479 > This is where indirect irradiance will be stored and retrieved.
480 > Normally, indirect irradiance values are kept in memory and
481   lost when the program finishes or dies.
482 < By using a file, different invocations can share illuminance
482 > By using a file, different invocations can share irradiance
483   values, saving time in the computation.
484 < Also, by creating an ambient file during a low resolution rendering,
485 < better results can be obtained in a second high resolution pass.
484 > Also, by creating an ambient file during a low-resolution rendering,
485 > better results can be obtained in a second high-resolution pass.
486 > (It is a good idea to keep all of the calculation parameters the same,
487 > changing only the dimensions of the output picture.)\0
488   The ambient file is in a machine-independent binary format
489   which may be examined with
490   .I lookamb(1).
# Line 509 | Line 543 | Same as
543   except read modifiers to be included from
544   .I file.
545   .TP
546 + .BI -ap " file [bwidth1 [bwidth2]]"
547 + Enable photon mapping mode. Loads a photon map generated with
548 + .I mkpmap(1)
549 + from
550 + .I file,
551 + and evaluates the indirect irradiance depending on the photon type
552 + (automagically detected) using density estimates with a bandwidth of
553 + .I bwidth1
554 + photons, or the default bandwidth if none is specified (a warning will be
555 + issued in this case).
556 + .IP
557 + Global photon irradiance is evaluated as part of the ambient calculation (see
558 + .I \-ab
559 + above), caustic photon irradiance is evaluated at primary rays, and
560 + indirect inscattering in
561 + .I mist
562 + is accounted for by volume photons. Contribution photons are treated as
563 + global photons by
564 + .I rpict.
565 + .IP
566 + Additionally specifying
567 + .I bwidth2
568 + enables bias compensation for the density estimates with a
569 + minimum and maximum bandwidth of
570 + .I bwidth1
571 + and
572 + .I bwidth2,
573 + respectively.
574 + .IP
575 + Global photon irradiance may be optionally precomputed by
576 + .I mkpmap(1),
577 + in which case the bandwidth, if specified, is ignored, as the nearest photon
578 + is invariably looked up.
579 + .IP
580 + Using direct photons replaces the direct calculation with density estimates
581 + for debugging and validation of photon emission.
582 + .TP
583 + .BI -am " frac"
584 + Maximum search radius for photon map lookups.  Without this option, an
585 + initial maximum search radius is estimated for each photon map from the
586 + average photon distance to the distribution's centre of gravity.  It is then
587 + adapted to the photon density in subsequent lookups.  This option imposes a
588 + global fixed maximum search radius for
589 + .I all
590 + photon maps, thus defeating the automatic adaptation.  It is useful when
591 + multiple warnings about short photon lookups are issued.  Note that this
592 + option does not conflict with the bandwidth specified with the
593 + .I \-ap
594 + option; the number of photons found will not exceed the latter, but may be
595 + lower if the maximum search radius contains fewer photons, thus resulting in
596 + short lookups.  Setting this radius too large, on the other hand, may
597 + degrade performance.
598 + .TP
599 + .BI -ac " pagesize"
600 + Set the photon cache page size when using out-of-core photon mapping. The
601 + photon cache reduces disk I/O incurred by on-demand loading (paging) of
602 + photons, and thus increases performance. This
603 + is expressed as a (float) multiple of the density estimate bandwidth
604 + specified with
605 + .I \-ap
606 + under the assumption that photon lookups are local to a cache page. Cache
607 + performance is sensitive to this parameter: larger pagesizes will reduce the
608 + paging frequency at the expense of higher latency when paging does occur.
609 + Sensible values are in the range 4 (default) to 16.
610 + .TP
611 + .BI -aC " cachesize"
612 + Set the total number of photons cached when using out-of-core photon
613 + mapping, taking into account the pagesize specified by
614 + .I \-ac.
615 + Note that this is approximate as the number of cache pages is rounded to
616 + the nearest prime. This allows adapting the cache to the available physical
617 + memory. Cache performance is less sensitive to this parameter, and reasonable
618 + performance can obtained with as few as 10k photons. The default is 1M. This
619 + option recognises multiplier suffixes (k = 1e3, M = 1e6), both in upper and
620 + lower case.
621 + .TP
622   .BI -me " rext gext bext"
623   Set the global medium extinction coefficient to the indicated color,
624   in units of 1/distance (distance in world coordinates).
# Line 558 | Line 668 | option (above) may be used to override this.
668   .BR \-u
669   Boolean switch to control uncorrelated random sampling.
670   When "off", a low-discrepancy sequence is used, which reduces
671 < variance but can result in a brushed appearance in specular highlights.
671 > variance but can result in a dithered appearance in specular highlights.
672   When "on", pure Monte Carlo sampling is used in all calculations.
673   .TP
674   .BI -lr \ N
675   Limit reflections to a maximum of
676 < .I N.
676 > .I N,
677 > if N is a positive integer.
678   If
679   .I N
680   is zero, then Russian roulette is used for ray
681   termination, and the
682   .I -lw
683   setting (below) must be positive.
684 < If N is a negative integer, then this sets the upper limit
685 < of reflections past which Russian roulette will not be used.
684 > If N is a negative integer, then this limits the maximum
685 > number of reflections even with Russian roulette.
686   In scenes with dielectrics and total internal reflection,
687   a setting of 0 (no limit) may cause a stack overflow.
688   .TP
# Line 588 | Line 699 | continue rays with a probability equal to the ray weig
699   divided by the given
700   .I frac.
701   .TP
702 + .BI -cs \ Ns
703 + Use
704 + .I Ns
705 + bands for spectral sampling rather than the default RGB calculation space.
706 + The maximum setting is controlled by the compiler macro MAXCSAMP, and
707 + defaults to 24.
708 + Larger values for Ns will be reduced to MAXCSAMP.
709 + .TP
710 + .BI -cw " nmA nmB"
711 + Set extrema to the given wavelengths for spectral sampling.
712 + The default is 380 and 780 nanometers.
713 + The order specified does not matter.
714 + .TP
715 + .BI -pc " xr yr xg yg xb yb xw yw"
716 + Use the specified chromaticity pairs for output primaries and white
717 + point rather than the standard RGB color space.
718 + .TP
719 + .BR \-pRGB
720 + Output standard RGB values (the default).
721 + .TP
722 + .BR \-pXYZ
723 + Output standard CIE XYZ tristimulus values rather than RGB.
724 + .TP
725   .BI -S \ seqstart
726   Instead of generating a single picture based only on the view
727   parameters given on the command line, this option causes
# Line 774 | Line 908 | Set the time between progress reports to
908   A progress report writes the number of rays traced, the percentage
909   completed, and the CPU usage to the standard error.
910   Reports are given either automatically after the specified interval,
911 < or when the process receives a continue (-CONT) signal (see
911 > or when the process receives a continue (\-CONT) signal (see
912   .I kill(1)).
913   A value of zero turns automatic reporting off.
914   .TP
# Line 788 | Line 922 | Boolean switch for warning messages.
922   The default is to print warnings, so the first appearance of
923   this option turns them off.
924   .SH EXAMPLE
925 < rpict -vp 10 5 3 -vd 1 -.5 0 scene.oct > scene.pic
925 > rpict \-vp 10 5 3 \-vd 1 \-.5 0 scene.oct > scene.hdr
926   .PP
927 < rpict -S 1 -o frame%02d.pic scene.oct < keyframes.vf
927 > rpict \-S 1 \-o frame%02d.hdr scene.oct < keyframes.vf
928 > .PP
929 > To render ambient irradiance in photon mapping mode from a global photon
930 > map global.pm via one ambient bounce, and from a caustic photon map
931 > caustic.pm:
932 > .IP "" .2i
933 > rpict -ab 1 -ap global.pm 50 -ap caustic.pm 50 -vf scene.vf scene.oct >
934 > scene.hdr
935   .SH ENVIRONMENT
936   RAYPATH         the directories to check for auxiliary files.
937   .SH FILES
# Line 810 | Line 951 | option.
951   .SH AUTHOR
952   Greg Ward
953   .SH "SEE ALSO"
954 < getinfo(1), lookamb(1), oconv(1), pdfblur(1), pfilt(1), pinterp(1), pmblur(1),
955 < printf(3), ra_rgbe(1), rad(1), rtrace(1), rvu(1)
954 > getinfo(1), lookamb(1), mkpmap(1), oconv(1), pdfblur(1), pfilt(1),
955 > 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