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.16 by greg, Sat Jan 25 18:27:39 2014 UTC vs.
Revision 1.31 by greg, Tue Apr 22 17:12:25 2025 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 211 | 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
217 < 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 254 | Line 271 | 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 310 | 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 405 | 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 431 | 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 451 | 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 516 | Line 562 | Same as
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 565 | Line 687 | option (above) may be used to override this.
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 brushed appearance in specular highlights.
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
# Line 578 | Line 700 | 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 sets the upper limit
704 < of reflections past which Russian roulette will be used.
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
# Line 596 | Line 718 | continue rays with a probability equal to the ray weig
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 790 | 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.
# Line 799 | Line 936 | this option turns them off.
936   rpict \-vp 10 5 3 \-vd 1 \-.5 0 scene.oct > scene.hdr
937   .PP
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
# Line 818 | Line 962 | option.
962   .SH AUTHOR
963   Greg Ward
964   .SH "SEE ALSO"
965 < getinfo(1), lookamb(1), oconv(1), pdfblur(1), pfilt(1), pinterp(1), pmblur(1),
966 < printf(3), ra_rgbe(1), rad(1), rtrace(1), rvu(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