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

Comparing ray/doc/man/man1/rad.1 (file contents):
Revision 1.1 by greg, Tue Mar 11 19:20:21 2003 UTC vs.
Revision 1.12 by greg, Fri Jan 1 19:14:43 2021 UTC

# Line 1 | Line 1
1 < .\" RCSid "$Id"
1 > .\" RCSid "$Id$"
2   .TH RAD 1 2/1/99 RADIANCE
3   .SH NAME
4   rad - render a RADIANCE scene
# Line 7 | Line 7 | rad - render a RADIANCE scene
7   [
8   .B \-s
9   ][
10 < .B \-n
10 > .B "-n | -N npr"
11   ][
12   .B \-t
13   ][
# Line 35 | Line 35 | and makes appropriate calls to
35   .I rpict(1),
36   .I pfilt(1),
37   and/or
38 < .I rview(1)
38 > .I rvu(1)
39   to render a specific scene.
40   Variables in
41   .I rfile
# Line 57 | Line 57 | option tells
57   .I rad
58   not to take any action (ie. not to actually execute any commands).
59   The
60 + .I \-N
61 + option instructs
62 + .I rad
63 + to run as many as
64 + .I npr
65 + rendering processes in parallel.
66 + The
67   .I \-t
68   option tells
69   .I rad
# Line 124 | Line 131 | to produce a picture for each view.
131   The
132   .I \-o
133   option specifies an output device for
134 < .I rview
134 > .I rvu
135   (usually "x11")
136   and runs this interactive program instead, using the first view in
137   .I rfile
# Line 193 | Line 200 | how to adjust the exposure for display.
200   It is important to set this variable properly as it is used to
201   determine the ambient value.
202   An appropriate setting may be discovered by running
203 < .I rview
203 > .I rvu
204   and noting the exposure given by the "exposure =" command.
205   As in
206 < .I rview
206 > .I rvu
207   and
208   .I pfilt,
209   the exposure setting may be given either as a multiplier or as a
210 < number of f-stop adjustments (eg. +2 or -1.5).
210 > number of f\-stop adjustments (eg. +2 or \-1.5).
211   There is no default value for this variable.
212   If it is not given, an average level will be computed by
213   .I pfilt
# Line 288 | Line 295 | command line option.
295   Also, there are several standard view identifiers defined by
296   .I rad.
297   These standard views are specified by strings of the form
298 < "[Xx]?[Yy]?[Zz]?[vlcah]?".
298 > "[Xx]?[Yy]?[Zz]?[vlcahs]?".
299   (That is, an optional upper or lower case X followed by an optional
300   upper or lower case Y followed by an optional upper or lower case Z
301   followed by an optional lower case V, L, C, A or H.)\0
# Line 296 | Line 303 | The letters indicate the desired view position, where
303   means maximum X, lower case means minimum and so on.
304   The final letter is the view type, where 'v' is perspective (the
305   default), 'l' is parallel, 'c' is a cylindrical panorama,
306 < 'a' is angular fisheye, and 'h' is hemispherical fisheye.
306 > 'a' is angular fisheye, 'h' is hemispherical fisheye, and 's'
307 > is a planisphere (stereographic) fisheye.
308   A perspective view from maximum X, minimum Y would be "Xy" or "Xyv".
309   A parallel view from maximum Z would be "Zl".
310   If "ZONE" is an interior zone, the standard views will
# Line 311 | Line 319 | generated.
319   .TP
320   .BR UP
321   The vertical axis for this scene.
322 < A negative axis may be specified with a minus sign (eg. "-Y").
322 > A negative axis may be specified with a minus sign (eg. "\-Y").
323   There is no default value for this variable, although the standard
324   views assume Z is up if no other axis is specified.
325   .TP
# Line 363 | Line 371 | The default value is 0.
371   .BR PICTURE
372   This is the root name of the output picture file(s).
373   This name will have appended the view identifier (or a number if no
374 < id was used) and a ".pic" suffix.
374 > id was used) and a ".hdr" suffix.
375   If a picture corresponding to a specific view exists and is not out
376   of date with respect to the given octree, it will not be
377   re-rendered.
# Line 398 | Line 406 | This is the name of the file where "ambient" or diffus
406   values will be stored by
407   .I rpict
408   or
409 < .I rview.
409 > .I rvu.
410   Although it is not required, an ambient file should be given whenever
411   an interreflection calculation is expected.
412   This will optimize successive runs and minimize artifacts.
# Line 431 | Line 439 | For a space with penetrating sunlight casting bright p
439   few places, it should be set to HIGH.
440   The default value is "L".
441   .TP
442 + .BR PGMAP
443 + This variable designates a global photon map to be generated by
444 + .I mkpmap(1)
445 + and used to accelerate rendering.
446 + The file name must be followed by the number of photons to be stored
447 + in the map, and this number may be followed by a bandwidth for rendering,
448 + which can be two arguments if bias compensation is desired.
449 + There is no default value, meaning that a global photon map will not
450 + normally be created.
451 + .TP
452 + .BR PCMAP
453 + This variable designates a caustic photon map to be generated by
454 + .I mkpmap(1)
455 + and used during renderings to model light transmission by reflecting
456 + and refracting surfaces.
457 + The file name must be followed by the number of photons to be stored
458 + in the map, and this number may be followed by a bandwidth for rendering,
459 + which can be two arguments if bias compensation is desired.
460 + There is no default value, meaning that a caustic photon map will not
461 + normally be created.
462 + .TP
463   .BR OPTFILE
464   This is the name of a file in which
465   .I rad
# Line 438 | Line 467 | will place the appropriate rendering options.
467   This file can later be accessed by
468   .I rpict
469   or
470 < .I rview
470 > .I rvu
471   in subsequent manual runs using the at-sign ('@') file insert option.
472   (Using an "OPTFILE" also reduces the length of the rendering
473   command, which improves appearance and may even be necessary on some
# Line 464 | Line 493 | There is no default value for this variable.
493   .BR oconv
494   This variable may be used to specify special options to
495   .I oconv.
496 + If the first word of the first instance of this variable is not an option,
497 + it will be used in place of the default command path, "oconv".
498   See the
499   .I oconv(1)
500   manual page for a list of valid options.
# Line 471 | Line 502 | manual page for a list of valid options.
502   .BR mkillum
503   This variable may be used to specify additional options to
504   .I mkillum.
505 + If the first word of the first instance of this variable is not an option,
506 + it will be used in place of the default command path, "mkillum".
507   See the
508   .I rtrace(1)
509   manual page for a list of valid options.
510   .TP
511 + .BR mkpmap
512 + This variable may be used to specify additional options to
513 + .I mkpmap.
514 + If the first word of the first instance of this variable is not an option,
515 + it will be used in place of the default command path, "mkpmap".
516 + See the
517 + .I mkpmap(1)
518 + manual page for a list of valid options.
519 + .TP
520   .BR render
521   This variable may be used to specify additional options to
522   .I rpict
523   or
524 < .I rview.
524 > .I rvu.
525   These options will appear after the options set automatically by
526   .I rad,
527   and thus will override the default values.
528   .TP
529 + .BR rpict
530 + This variable may be used to specify overriding options specific to
531 + .I rpict.
532 + If the first word of the first instance of this variable is not an option,
533 + it will be used in place of the default command path, "rpict".
534 + See the
535 + .I rpict(1)
536 + man page for a list of valid options.
537 + .TP
538 + .BR rvu
539 + This variable may be used to specify overriding options specific to
540 + .I rvu.
541 + If the first word of the first instance of this variable is not an option,
542 + it will be used in place of the default command path, "rvu".
543 + See the
544 + .I rvu(1)
545 + man page for a list of valid options.
546 + .TP
547   .BR pfilt
548   This variable may be used to specify additional options to
549   .I pfilt.
550 + If the first word of the first instance of this variable is not an option,
551 + it will be used in place of the default command path, "pfilt".
552   See the
553   .I pfilt(1)
554   manual page for details.
# Line 519 | Line 581 | If we only want to see what default values
581   .I rad
582   would use without actually executing anything, we can invoke it thus:
583   .IP "" .2i
584 < rad -n -e sample.rif
584 > rad \-n \-e sample.rif
585   .PP
586   This will print the variables we have given as well as default
587   values
# Line 536 | Line 598 | result as it is needed to determine some of the opiton
598   Different option combinations have specific uses, ie:
599   .IP "" .2i
600   .br
601 < rad -v 0 sample.rif OPT=samp.opt        # build octree, put options in "sample.opt"
601 > rad \-v 0 sample.rif OPT=samp.opt       # build octree, put options in "sample.opt"
602   .br
603 < rad -n -e -s sample.rif > full.rif      # make a complete rad file
603 > rad \-n \-e \-s sample.rif > full.rif   # make a complete rad file
604   .br
605 < rad -n sample.rif > script.sh   # make a script of commands
605 > rad \-n sample.rif > script.sh  # make a script of commands
606   .br
607 < rad -V -v Zl -n -s sample.rif > plan.vf # make a plan view file
607 > rad \-V \-v Zl \-n \-s sample.rif > plan.vf     # make a plan view file
608   .br
609 < rad -t sample.rif               # update files after minor change to input
609 > rad \-t sample.rif              # update files after minor change to input
610   .br
611 < rad -s sample.rif &             # execute silently in the background
611 > rad \-s sample.rif &            # execute silently in the background
612 > .br
613 > rad \-N 2 sample.rif    # render views using two parallel rpict calls
614 > .br
615 > rad \-N 4 -v 1 sample.rif       # render first view with four rpiece calls
616   .PP
617   If we decide that the default values
618   .I rad
# Line 558 | Line 624 | QUAL= MED              # default was low
624   DET= low                # default was medium - our space is almost empty
625   PEN= True               # we want to see soft shadows from our window
626   VAR= hi         # daylight can result in fairly harsh lighting
627 < view= XYa -vv 120       # let's try a fisheye view
628 < PICT= tutor             # our picture name will be "tutor_XYa.pic"
627 > view= XYa \-vv 120      # let's try a fisheye view
628 > PICT= tutor             # our picture name will be "tutor_XYa.hdr"
629   .fi
630   .PP
631   Note the use of abbreviations, and the modification of a standard
# Line 567 | Line 633 | view.
633   Now we can invoke
634   .I rad
635   to take a look at our scene interactively with
636 < .I rview:
636 > .I rvu:
637   .IP "" .2i
638 < rad -o x11 sample.rif
638 > rad \-o x11 sample.rif
639   .PP
640   .I Rad
641   will run
642   .I oconv
643   first to create the octree (assuming it doesn't
644   already exist), then
645 < .I rview
645 > .I rvu
646   with a long list of options.
647   Let's say that from within
648 < .I rview,
648 > .I rvu,
649   we wrote out the view files "view1.vp" and "view2.vp".
650   We could add these to "sample.rif" like so:
651   .IP "" .2i
652   .nf
653 < view= vw1 -vf view1.vp          # Our first view
654 < view= vw2 -vf view2.vp          # Our second view
653 > view= vw1 \-vf view1.vp         # Our first view
654 > view= vw2 \-vf view2.vp         # Our second view
655   RESOLUTION= 1024                # Let's go for a higher resolution result
656   .fi
657   .PP
658   To start
659 < .I rview
659 > .I rvu
660   again using vw2 instead of the default, we use:
661   .IP "" .2i
662 < rad -o x11 -v vw2 sample.rif
662 > rad \-o x11 \-v vw2 sample.rif
663   .PP
664   Once we are happy with the variable settings in our file, we can run
665   .I rad
# Line 608 | Line 674 | $(PICTURE)_$(view).unf Unfinished output of
674   .SH AUTHOR
675   Greg Ward
676   .SH BUGS
677 + You cannot run more than one
678 + .I rad
679 + process at a time on the same input file,
680 + as the second process will attempt to recover the output files
681 + of the first process, damaging the results.
682 + The exceptions to this are running interactively via the
683 + .I \-o
684 + option, or rendering different views using the
685 + .I \-v
686 + option.
687 + .PP
688   Incremental building of octrees is not supported as it would add
689   considerable complexity to
690   .I rad.
# Line 644 | Line 721 | accurately determine the ambient value for
721   The use of upper and lower case naming for the standard views may be
722   problematic on systems that don't distinguish case in filenames.
723   .SH "SEE ALSO"
724 < glrad(1), make(1), mkillum(1), objview(1), oconv(1),
724 > glrad(1), make(1), mkillum(1), mkpmap(1), objview(1), oconv(1),
725   pfilt(1), raddepend(1), ranimate(1),
726 < rholo(1), rpict(1), rtrace(1), rview(1), touch(1), vgaimage(1), ximage(1)
726 > rholo(1), rpict(1), rpiece(1), rtrace(1), rvu(1),
727 > touch(1), vgaimage(1), ximage(1)

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines