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.3 by greg, Tue Dec 9 15:59:06 2003 UTC vs.
Revision 1.11 by greg, Tue May 26 10:00:46 2015 UTC

# Line 7 | Line 7 | rad - render a RADIANCE scene
7   [
8   .B \-s
9   ][
10 < .B "-n|-N npr"
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 131 | 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 200 | 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 295 | 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 303 | 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 318 | 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 370 | 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 405 | 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 438 | 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 + There is no default value, meaning that a global photon map will not
449 + normally be created.
450 + .TP
451 + .BR PCMAP
452 + This variable designates a caustic photon map to be generated by
453 + .I mkpmap(1)
454 + and used during renderings to model light transmission by reflecting
455 + and refracting surfaces.
456 + The file name must be followed by the number of photons to be stored
457 + in the map, and this number may be followed by a bandwidth for rendering.
458 + There is no default value, meaning that a caustic photon map will not
459 + normally be created.
460 + .TP
461   .BR OPTFILE
462   This is the name of a file in which
463   .I rad
# Line 445 | Line 465 | will place the appropriate rendering options.
465   This file can later be accessed by
466   .I rpict
467   or
468 < .I rview
468 > .I rvu
469   in subsequent manual runs using the at-sign ('@') file insert option.
470   (Using an "OPTFILE" also reduces the length of the rendering
471   command, which improves appearance and may even be necessary on some
# Line 471 | Line 491 | There is no default value for this variable.
491   .BR oconv
492   This variable may be used to specify special options to
493   .I oconv.
494 + If the first word of the first instance of this variable is not an option,
495 + it will be used in place of the default command path, "oconv".
496   See the
497   .I oconv(1)
498   manual page for a list of valid options.
# Line 478 | Line 500 | manual page for a list of valid options.
500   .BR mkillum
501   This variable may be used to specify additional options to
502   .I mkillum.
503 + If the first word of the first instance of this variable is not an option,
504 + it will be used in place of the default command path, "mkillum".
505   See the
506   .I rtrace(1)
507   manual page for a list of valid options.
508   .TP
509 + .BR mkpmap
510 + This variable may be used to specify additional options to
511 + .I mkpmap.
512 + If the first word of the first instance of this variable is not an option,
513 + it will be used in place of the default command path, "mkpmap".
514 + See the
515 + .I mkpmap(1)
516 + manual page for a list of valid options.
517 + .TP
518   .BR render
519   This variable may be used to specify additional options to
520   .I rpict
521   or
522 < .I rview.
522 > .I rvu.
523   These options will appear after the options set automatically by
524   .I rad,
525   and thus will override the default values.
526   .TP
527 + .BR rpict
528 + This variable may be used to specify overriding options specific to
529 + .I rpict.
530 + If the first word of the first instance of this variable is not an option,
531 + it will be used in place of the default command path, "rpict".
532 + See the
533 + .I rpict(1)
534 + man page for a list of valid options.
535 + .TP
536 + .BR rvu
537 + This variable may be used to specify overriding options specific to
538 + .I rvu.
539 + If the first word of the first instance of this variable is not an option,
540 + it will be used in place of the default command path, "rvu".
541 + See the
542 + .I rvu(1)
543 + man page for a list of valid options.
544 + .TP
545   .BR pfilt
546   This variable may be used to specify additional options to
547   .I pfilt.
548 + If the first word of the first instance of this variable is not an option,
549 + it will be used in place of the default command path, "pfilt".
550   See the
551   .I pfilt(1)
552   manual page for details.
# Line 526 | Line 579 | If we only want to see what default values
579   .I rad
580   would use without actually executing anything, we can invoke it thus:
581   .IP "" .2i
582 < rad -n -e sample.rif
582 > rad \-n \-e sample.rif
583   .PP
584   This will print the variables we have given as well as default
585   values
# Line 543 | Line 596 | result as it is needed to determine some of the opiton
596   Different option combinations have specific uses, ie:
597   .IP "" .2i
598   .br
599 < rad -v 0 sample.rif OPT=samp.opt        # build octree, put options in "sample.opt"
599 > rad \-v 0 sample.rif OPT=samp.opt       # build octree, put options in "sample.opt"
600   .br
601 < rad -n -e -s sample.rif > full.rif      # make a complete rad file
601 > rad \-n \-e \-s sample.rif > full.rif   # make a complete rad file
602   .br
603 < rad -n sample.rif > script.sh   # make a script of commands
603 > rad \-n sample.rif > script.sh  # make a script of commands
604   .br
605 < rad -V -v Zl -n -s sample.rif > plan.vf # make a plan view file
605 > rad \-V \-v Zl \-n \-s sample.rif > plan.vf     # make a plan view file
606   .br
607 < rad -t sample.rif               # update files after minor change to input
607 > rad \-t sample.rif              # update files after minor change to input
608   .br
609 < rad -s sample.rif &             # execute silently in the background
609 > rad \-s sample.rif &            # execute silently in the background
610 > .br
611 > rad \-N 2 sample.rif    # render views using two parallel rpict calls
612 > .br
613 > rad \-N 4 -v 1 sample.rif       # render first view with four rpiece calls
614   .PP
615   If we decide that the default values
616   .I rad
# Line 565 | Line 622 | QUAL= MED              # default was low
622   DET= low                # default was medium - our space is almost empty
623   PEN= True               # we want to see soft shadows from our window
624   VAR= hi         # daylight can result in fairly harsh lighting
625 < view= XYa -vv 120       # let's try a fisheye view
626 < PICT= tutor             # our picture name will be "tutor_XYa.pic"
625 > view= XYa \-vv 120      # let's try a fisheye view
626 > PICT= tutor             # our picture name will be "tutor_XYa.hdr"
627   .fi
628   .PP
629   Note the use of abbreviations, and the modification of a standard
# Line 574 | Line 631 | view.
631   Now we can invoke
632   .I rad
633   to take a look at our scene interactively with
634 < .I rview:
634 > .I rvu:
635   .IP "" .2i
636 < rad -o x11 sample.rif
636 > rad \-o x11 sample.rif
637   .PP
638   .I Rad
639   will run
640   .I oconv
641   first to create the octree (assuming it doesn't
642   already exist), then
643 < .I rview
643 > .I rvu
644   with a long list of options.
645   Let's say that from within
646 < .I rview,
646 > .I rvu,
647   we wrote out the view files "view1.vp" and "view2.vp".
648   We could add these to "sample.rif" like so:
649   .IP "" .2i
650   .nf
651 < view= vw1 -vf view1.vp          # Our first view
652 < view= vw2 -vf view2.vp          # Our second view
651 > view= vw1 \-vf view1.vp         # Our first view
652 > view= vw2 \-vf view2.vp         # Our second view
653   RESOLUTION= 1024                # Let's go for a higher resolution result
654   .fi
655   .PP
656   To start
657 < .I rview
657 > .I rvu
658   again using vw2 instead of the default, we use:
659   .IP "" .2i
660 < rad -o x11 -v vw2 sample.rif
660 > rad \-o x11 \-v vw2 sample.rif
661   .PP
662   Once we are happy with the variable settings in our file, we can run
663   .I rad
# Line 615 | Line 672 | $(PICTURE)_$(view).unf Unfinished output of
672   .SH AUTHOR
673   Greg Ward
674   .SH BUGS
675 + You cannot run more than one
676 + .I rad
677 + process at a time on the same input file,
678 + as the second process will attempt to recover the output files
679 + of the first process, damaging the results.
680 + The exceptions to this are running interactively via the
681 + .I \-o
682 + option, or rendering different views using the
683 + .I \-v
684 + option.
685 + .PP
686   Incremental building of octrees is not supported as it would add
687   considerable complexity to
688   .I rad.
# Line 651 | Line 719 | accurately determine the ambient value for
719   The use of upper and lower case naming for the standard views may be
720   problematic on systems that don't distinguish case in filenames.
721   .SH "SEE ALSO"
722 < glrad(1), make(1), mkillum(1), objview(1), oconv(1),
722 > glrad(1), make(1), mkillum(1), mkpmap(1), objview(1), oconv(1),
723   pfilt(1), raddepend(1), ranimate(1),
724 < rholo(1), rpict(1), rtrace(1), rview(1), touch(1), vgaimage(1), ximage(1)
724 > rholo(1), rpict(1), rpiece(1), rtrace(1), rvu(1),
725 > touch(1), vgaimage(1), ximage(1)

Diff Legend

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