ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/src/util/trad.hlp
(Generate patch)

Comparing ray/src/util/trad.hlp (file contents):
Revision 2.14 by greg, Wed Sep 13 13:15:29 1995 UTC vs.
Revision 2.26 by greg, Thu Jun 25 18:53:39 2015 UTC

# Line 1 | Line 1
1 <        $Id$
1 >        trad.hlp 2.18 10/20/98
2  
3   This help file is associated with the trad interface to the Radiance
4   rad(1) program.  Trad consists of trad.wsh and one do_*.tcl file for
# Line 398 | Line 398 | long as the overall size of the given box is close to
398   size of the space.
399  
400   The Zone entry windows may be manipulated in the following ways.
401 Control-U clears the current window.
401   Control-V pastes the contents of the current selection at the
402   insertion point.
403   Return moves the focus to the next window in the chain.
404  
405 + The "Auto" button may be used to set these values based on the bounding
406 + box of one or more Radiance scene files.
407 +
408 + .Zone.Auto
409 +
410 + Use this button to automatically determine the bounding box for this
411 + zone, based on the output of the "getbbox" command run on one or
412 + more Radiance scene files.
413 + The appropriate scene files are entered via a file
414 + selection dialogue box, which comes up after the button is pressed.
415 +
416 + The reason for selecting specific files rather than running getbbox
417 + on the entire scene is that a zone usually does not include large
418 + external objects, which may be present in the complete scene
419 + description.
420 +
421   .Zone.Detail
422  
423   The "Detail" setting indicates the relative level
# Line 472 | Line 487 | an important parameter for rendering accuracy.
487  
488   There are two basic ways to compute the exposure value.
489   The first is by trial and error, where the value is adjusted up and
490 < down within rview using the "e = value" command.
490 > down within rvu using the "e = value" command.
491   Though it sounds flaky, this is the most reliable way to set the
492   exposure (and ambient level) in general lighting situations.
493  
# Line 490 | Line 505 | tot_flux is given in watts.
505   (Divide total lumens by 179 lumens/watt to get watts.)
506  
507   The exposure value may either be given as a positive real value, or
508 < as a real value preceeded by a '+' or '-' indicating a positive or
508 > as a real value preceded by a '+' or '-' indicating a positive or
509   negative number of f-stops (powers of two) from the original value.
510  
511   If no exposure is given, pfilt will automatically compute the
# Line 530 | Line 545 | and/or parameters, and press the "Change" button.
545   To remove an unwanted view, select it and press the "Delete" button.
546   To undo this action, simply press the "Add" button again.
547  
548 < The first view in the list is the default given to rview during
548 > The first view in the list is the default given to rvu during
549   interactive rendering, and is the first view rendered in a batch run.
550   To change the default view, select the newly desired view and press
551   the "Set Default" button.
# Line 569 | Line 584 | An invented name should be kept as short as possible,
584   added to the picture file name along with the standard ".pic" suffix.
585  
586   The standard views are specified by strings of the form
587 < "[Xx]?[Yy]?[Zz]?[vlahc]?".
587 > "[Xx]?[Yy]?[Zz]?[vlahsc]?".
588   (That is, an optional upper or lower case X followed by an optional
589   upper or lower case Y followed by an optional upper or lower case Z
590 < followed by an optional lower case V, L, A, H or C.)
590 > followed by an optional lower case view type.)
591   The letters indicate the desired view position, where upper case "X"
592   means maximum X, lower case "y" means minimum Y and so on.
593   The final letter is the view type, where 'v' is perspective (the
594   default), 'l' is parallel, 'a' is angular fisheye, 'h' is
595 < hemispherical fisheye and 'c' is for cylindrical panorama.
596 < A perspective view from maximum X, minimum Y would be "Xy" or
597 < "Xyv".
595 > hemispherical fisheye, 's' is for planisphere (stereographic) fisheye,
596 > and 'c' is for cylindrical panorama.
597 > A perspective view from maximum X, minimum Y would be "Xy" or "Xyv".
598   A parallel view from maximum Z would be "Zl".
599   If "ZONE" is an interior zone, the standard views will
600   be inside the perimeter.
# Line 599 | Line 614 | Otherwise, it is usually necessary to specify a set of
614   define a view.
615  
616   The simplest view specification is of the form "-vf viewfile", where
617 < "viewfile" is a file created with the rview "view" command, or a
617 > "viewfile" is a file created with the rvu "view" command, or a
618   Radiance picture.
619   This method of naming views, although convenient, is not the best
620   since it is difficult to know exactly where such a view is by
# Line 618 | Line 633 | interaction mode for trad.
633   Consult the rpict(1) manual page for a full description of the various
634   view options, all of which begin with "-v".
635   Just briefly, the "-vt?" option sets the view type, where "?" is
636 < replaced by one of the letters "v, l, a, h or c", corresponding to
636 > replaced by one of the letters "v, l, a, h, s or c", corresponding to
637   perspective, parallel, angular fisheye, hemispherical fisheye
638   and cylindrical panorama, respectively.
639   The "-vp x y z" option sets the view position (eyepoint), where "x y z"
# Line 682 | Line 697 | The "Clear" button simply clears the "Name" and "Optio
697   for the convenience of entering a new view.
698   It has no effect on the rad input variables.
699  
685 Note that Control-U will always clear an entry box whose cursor is
686 active.
687
700   .Views.Default
701  
702   The "Set Default" button may be used to make the selected view the
703   default view for rendering.
704   This simply moves the view to the top of the list in the rad input file.
705 < The default view will be the one normally rendered by rview when rad
705 > The default view will be the one normally rendered by rvu when rad
706   is started interactively, and is the first view rendered in a batch
707   process.
708  
# Line 707 | Line 719 | The standard view up vector may be set to the positive
719   the positive Y axis (+Y), the positive Z axis (+Z), the negative
720   X axis (-X), the negative Y axis (-Y), or the negative Z axis (-Z).
721  
722 < This setting may always be overriden by the "-vu xd yd zd" option,
722 > This setting may always be overridden by the "-vu xd yd zd" option,
723   and will be altered for a particular view if it happens to be
724   parallel to the view direction.
725  
726 + .Views.Eyesep
727 +
728 + The eye separation is used for generating stereo views of
729 + the scene.
730 + It is the measured distance between a viewer's pupils in world
731 + coordinate units.
732 + It is not used directly by rad, but should be set for other programs
733 + that need it, such as rholo and glrad.
734 +
735   .Views.Picture
736  
737   The root picture file name is given in the "Picture" entry window.
# Line 817 | Line 838 | The "Report" variable may be used to specify a time in
838   minutes) between progress reports.
839  
840   Other windows allow the user to customize the options to oconv(1),
841 < mkillum(1), rview(1) and rpict(1), and pfilt(1).
841 > mkillum(1), rvu(1) and rpict(1), and pfilt(1).
842  
843   .Options.Quality
844  
# Line 862 | Line 883 | will be treated as points.
883   It only means that some accuracy and possibly some smoothness
884   will be traded for speed in the shadow calculations.
885  
886 + .Options.Pgmap
887 +
888 + The "Pgmap" specifies the file to hold the global photons computed
889 + by the "mkpmap" command, followed by the number of photons to generate
890 + (required).
891 + A typical photon count for a global map is on the order of 100-200K.
892 + (A 'K', 'M', or 'G' may follow the value to indicate thousands, millions,
893 + or billions of photons.)
894 + By convention, photon map files are given a ".pmp" suffix.
895 + An optional third parameter specifies the bandwidth to use
896 + for the global photons during rendering, and this value should be
897 + around 50.
898 +
899 + .Options.PgmDelete
900 +
901 + The "Delete" button next to the "Pgmap" window on the Options
902 + screen allows you to remove the named global photon map file.
903 + This is usually done when a change is made to the "mkpmap" options,
904 + as the file will be regenerated automatically after most scene changes.
905 +
906 + .Options.Pcmap
907 +
908 + The "Pcmap" specifies the file to hold the caustic photons computed
909 + by the "mkpmap" command, followed by the number of photons to generate
910 + (required).
911 + A typical photon count for a global map is on the order of 1000K (1M).
912 + (A 'K', 'M', or 'G' may follow the value to indicate thousands, millions,
913 + or billions of photons.)
914 + By convention, photon map files are given a ".pmp" suffix.
915 + An optional third parameter specifies the bandwidth to use
916 + for the global photons during rendering, and this value should be
917 + around 50.
918 + (See the "Pgmap" topic under the current help category.)
919 +
920 + .Options.PcmDelete
921 +
922 + The "Delete" button next to the "Pcmap" window on the Options
923 + screen allows you to remove the named caustic photon map file.
924 + This is usually done when a change is made to the "mkpmap" options,
925 + as the file will be regenerated automatically after most scene changes.
926 +
927   .Options.Ambfile
928  
929   The "Ambfile" is the file used to store Radiance ambient values for
# Line 895 | Line 957 | effort.
957  
958   The "Optfile" setting assigns a file to hold rendering options,
959   which may be a convenience when these options are reused for
960 < rtrace(1) or rpiece(1), or manual invocations of rview or rpict.
960 > rtrace(1) or rpiece(1), or manual invocations of rvu or rpict.
961   Using an options file also reduces the size of the command line,
962   making it a little easier on the eye.
963  
# Line 946 | Line 1008 | indicate this by not specifying any illum or scene fil
1008   .Options.Mkillum
1009  
1010   The "mkillum opts" window may be used to specify options to the
1011 < mkillum(1) command, whose options are actually passed to rtrace(1).
1011 > mkillum(1) command.
1012   These options apply only if there are one or more "Illum" files
1013   named on the Scene screen.
1014  
1015   It is very important to set mkillum options sensibly,
1016   since rad does not have the intelligence to do it for you.
1017  
1018 + .Options.Mkpmap
1019 +
1020 + The "mkpmap opts" window may be used to specify options
1021 + to the mkpmap(1) command.
1022 + There are no default values, and rad does not set these
1023 + options intelligently.
1024 +
1025   .Options.Render
1026  
1027   The "render opts" window is used to specify additional options to
1028 < the rview(1) and rpict(1) rendering programs.
1028 > the rvu(1) and rpict(1) rendering programs.
1029   Most of the important parameters are computed by rad, so this
1030   window is usually used to override specific parameters or to give
1031   additional information, such as which materials to exclude from the
# Line 1005 | Line 1074 | This screen is where the actual Radiance programs are
1074   run, usually via rad(1).
1075   The top row of buttons is used to update the octree following a
1076   change to one or more input files.
1077 < The "rview" button starts an interactive rendering in the
1077 > The "rvu" button starts an interactive rendering in the
1078   foreground.
1079   The next set of buttons provides for the control of a batch
1080   rendering process, taking place in the background.
# Line 1083 | Line 1152 | by the "Touch" button.
1152   (This will still cause the ambient file to be removed,
1153   unfortunately.)
1154  
1155 < .Action.Rview
1155 > .Action.Rvu
1156  
1157 < The "rview" button on the Action screen starts an interactive
1157 > The "rvu" button on the Action screen starts an interactive
1158   rendering for the selected view, indicated by the menu button
1159   just to the right.
1160 < Other views may be accessed within rview using the "L name"
1160 > Other views may be accessed within rvu using the "L name"
1161   command, and new views can be added with the "V name"
1162   command.
1163  
# Line 1098 | Line 1167 | Instead, give it a new name (or no name, which will sh
1167   a number later), then use the Views screen to override the previous
1168   view definition with the new one.
1169   (See the "View" topic in the current
1170 < help category, the "Change" topic under "Views" and the rview(1)
1170 > help category, the "Change" topic under "Views" and the rvu(1)
1171   manual page for more information.)
1172  
1173   If the octree is out-of-date, it will be rebuilt before rendering
# Line 1107 | Line 1176 | begins.
1176   .Action.View
1177  
1178   The Action screen contains two menus for selecting views.
1179 < The top menu, next to the "rview" button, sets the view to start
1180 < with in rview, and is selected from the current view list.
1179 > The top menu, next to the "rvu" button, sets the view to start
1180 > with in rvu, and is selected from the current view list.
1181   The second view menu, next to the "Start" button for batch
1182   rendering, selects the view or views to render in batch mode.
1183   If the special entry "ALL" is selected, then every view in the
1184   current list will be rendered if it hasn't been already.
1185  
1186 < The view menu next to the "rview" button will be disabled if there
1186 > The view menu next to the "rvu" button will be disabled if there
1187   is only one view to choose from.
1188   The view menu next to the "Start" button will be disabled if there
1189   is a batch job in progress, and thus the view cannot be changed.
# Line 1122 | Line 1191 | is a batch job in progress, and thus the view cannot b
1191   The batch rendering view menu also selects the view or views
1192   to use in producing a script during a dry run.
1193  
1194 + .Action.Processes
1195 +
1196 + The "Number of processes" slider controls how many independent
1197 + processes are initiated by the "rvu" and "Start" buttons above
1198 + and below.
1199 + This should be set no greater than the number of virtual cores
1200 + on your system.
1201 +
1202 + For interactive rendering, the "new" command within rvu may
1203 + be used to change the number of processes running.
1204 +
1205 + For rendering in the background, the number of processes will
1206 + never be greater than the number of views if all views are
1207 + being rendered.
1208 + If only a single view is selected for rendering, rad
1209 + will call rpiece to render it in tiles using the given
1210 + number of processes.
1211 +
1212   .Action.Start
1213  
1214   The "Start" button for batch rendering on the Action screen
# Line 1359 | Line 1446 | details.)
1446   The print command window on the Results screen contains the system
1447   command to use in printing out finished Radiance pictures.
1448   The "%s" format field, which must appear somewhere in the command,
1449 < is replaced by the selected Radiance picture file name(s).
1449 > is replaced by the selected Radiance picture file name.
1450 > This command is executed multiple times if multiple files are
1451 > selected.
1452  
1453   The default command is "ra_ps %s | lpr", which converts the Radiance
1454   picture to a black and white PostScript file and sends it to the lpr
1455   print spooler.
1456 + Add a "-c" option to "ra_ps" if the printer supports color.
1457   If your printer does not understand PostScript, or your system does
1458   not support lpr, this command must obviously be changed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines