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.2 by greg, Fri Oct 28 11:09:52 1994 UTC vs.
Revision 2.14 by greg, Wed Sep 13 13:15:29 1995 UTC

# Line 2 | Line 2
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
5 < each screen.  There are currently seven such screens:  Action, File,
6 < Options, Results, Scene, Views and Zone.
5 > each screen.  There are currently seven such screens:  File, Scene,
6 > Zone, Views, Options, Action and Results.
7  
8   .Trad.Intro
9  
# Line 48 | Line 48 | the left mouse button while holding the control key ov
48   curiosity in the main trad window.
49   (In general, only active windows are given help file links -- click
50   on these rather than the text labels.)
51 + Additional search capabilities are available over all topics using
52 + the "Grep" button.
53  
54   For help on the help facility itself, Control-click on the problem
55   help widget or on the window title in the upper right corner for
# Line 55 | Line 57 | more general information.
57   (To get back to trad-specific help, press the "HELP" button in the
58   main trad window or Control-click on a trad widget.)
59  
58 Once the help window has been displayed, it is usually best to
59 lower or iconify it rather than dismissing it if further help is
60 needed.
61 This way, you will not have to wait for the help file to be read in
62 all over again every time you have a question.
63
60   .Trad.Messages
61  
62 < Informative messages, commands executed by rad, and errors
62 > Informative messages, commands executed by rad, and errors
63   appear in the message window at the bottom of the trad frame.
64 < Growing the trad window means growing this message window, and
64 > Growing the trad window means growing this message window, and
65   not much else.
66   This is not really necessary, since the window will be grown
67   automatically if the message requires it.
# Line 339 | Line 335 | All other variables will be unaffected.
335  
336   .Scene.Revert
337  
338 < The "Revert" button is a convenient way to revert to the original
338 > The "Revert" button is a convenient way to revert to the original
339   values in the rad input file.
340   Only the variables on the Scene screen will be affected, but any changes
341   to these variables since the last save will be lost.
# Line 353 | Line 349 | This zone need not correspond exactly to any interior
349   walls, as it is used primarily to set rendering parameters and
350   standard viewpoints.
351  
352 < An interior zone means that standard viewpoints will be selected
352 > An interior zone means that standard viewpoints will be selected
353   from the inside of this box.
354   An exterior zone means that standard viewpoints will be selected
355   from the outside of this box.
356 < The default zone is an exterior one computed from the bounding box
356 > The default zone is an exterior one computed from the bounding box
357   of the entire scene.
358   (Note that this is not usually desirable.)
359  
# Line 371 | Line 367 | the rad manual page.
367  
368   .Zone.Type
369  
370 < There are two types of zones understood by rad, "Interior" and
370 > There are two types of zones understood by rad, "Interior" and
371   "Exterior".
372 < An interior zone is indicated when renderings generally take place
372 > An interior zone is indicated when renderings generally take place
373   inside a specified 3-d box.
374   A typical example might be a single room or auditorium.
375   An exterior zone is indicated when renderings generally take place
# Line 505 | Line 501 | used for exterior zones and 0.01 for interior zones.
501  
502   The "Copy" button on the Zone screen takes all values for this
503   screen from another rad input file, replacing the current values.
504 < Specifically, the rad variables "ZONE, DETAIL, INDIRECT,
504 > Specifically, the rad variables "ZONE, DETAIL, INDIRECT,
505   VARIABILITY and EXPOSURE" will be copied from the named file.
506  
507   All other variables will be left untouched.
508  
509   .Zone.Revert
510  
511 < The "Revert" button is a convenient way to revert to the original
511 > The "Revert" button is a convenient way to revert to the original
512   values in the rad input file.
513   Only the variables on the Zone screen will be affected, but any changes
514   to these variables since the last save will be lost.
# Line 524 | Line 520 | This screen provides a means of setting the multi-valu
520   "view" variable.
521   Each view setting is listed by name, or by number if no name has
522   been assigned.
523 < To add a new view, enter a unique name and specify the view
523 > To add a new view, enter a unique name and specify the view
524   options,
525   then press the "Add" or "Set Default" button.
526   If a view with the same name already exists, it is unconditionally
# Line 534 | Line 530 | and/or parameters, and press the "Change" button.
530   To remove an unwanted view, select it and press the "Delete" button.
531   To undo this action, simply press the "Add" button again.
532  
533 < The first view in the list is the default given to rview during
533 > The first view in the list is the default given to rview during
534   interactive rendering, and is the first view rendered in a batch run.
535   To change the default view, select the newly desired view and press
536   the "Set Default" button.
# Line 569 | Line 565 | The standard view is "X" is used if no views are speci
565  
566   Each view has a unique name, which may be chosen at the user's
567   discretion or taken from a list of standard views, described below.
568 < An invented name should be kept as short as possible, since it is
568 > An invented name should be kept as short as possible, since it is
569   added to the picture file name along with the standard ".pic" suffix.
570  
571   The standard views are specified by strings of the form
572 < "[Xx]?[Yy]?[Zz]?[vlah]?".
572 > "[Xx]?[Yy]?[Zz]?[vlahc]?".
573   (That is, an optional upper or lower case X followed by an optional
574   upper or lower case Y followed by an optional upper or lower case Z
575 < followed by an optional lower case V, L, A or H.)
575 > followed by an optional lower case V, L, A, H or C.)
576   The letters indicate the desired view position, where upper case "X"
577   means maximum X, lower case "y" means minimum Y and so on.
578   The final letter is the view type, where 'v' is perspective (the
579 < default), 'l' is parallel, 'a' is angular fisheye, and 'h' is
580 < hemispherical fisheye.
581 < A perspective view from maximum X, minimum Y would be "Xy" or
579 > default), 'l' is parallel, 'a' is angular fisheye, 'h' is
580 > hemispherical fisheye and 'c' is for cylindrical panorama.
581 > A perspective view from maximum X, minimum Y would be "Xy" or
582   "Xyv".
583   A parallel view from maximum Z would be "Zl".
584   If "ZONE" is an interior zone, the standard views will
# Line 622 | Line 618 | interaction mode for trad.
618   Consult the rpict(1) manual page for a full description of the various
619   view options, all of which begin with "-v".
620   Just briefly, the "-vt?" option sets the view type, where "?" is
621 < replaced by one of the letters "v, l, a or h", corresponding to
622 < perspective, parallel, angular and hemispherical fisheye, respectively.
623 < The "-vp x y z" option sets the view position (eyepoint), where "x y z"
621 > replaced by one of the letters "v, l, a, h or c", corresponding to
622 > perspective, parallel, angular fisheye, hemispherical fisheye
623 > and cylindrical panorama, respectively.
624 > The "-vp x y z" option sets the view position (eyepoint), where "x y z"
625   is replaced by the position in 3-space.
626   The "-vd xd yd zd" option sets the view direction, where "xd yd zd"
627   is a vector pointing in the desired direction.
# Line 633 | Line 630 | the eyepoint from the look-at point.  Vector normaliza
630   unnecessary.)
631   The "-vh horiz" and "-vv vert" options set the horizontal and
632   vertical view sizes, respectively.
633 < For perspective views, these correspond to full camera angles in
633 > For perspective views, these correspond to full camera angles in
634   degrees.
635   For parallel views (using the "-vtl" option), they correspond to
636   image plane size in world coordinates.
# Line 648 | Line 645 | In particular, make sure that each option and each arg
645   space between it and whatever follows.
646  
647   Hitting return in the "Options" window is equivalent to pressing the
648 < "Add" button.
648 > "Add" button followed by the "Clear" button.
649  
650   .Views.Add
651  
# Line 749 | Line 746 | to maintain a specific pixel aspect ratio (1 by defaul
746  
747   The default value for this variable is "512".
748  
749 + .Views.Rawfile
750 +
751 + The "Rawfile" entry window determines if and where the raw output picture
752 + from rpict will be saved.
753 + If the entry is empty, the file will be removed after rendering and
754 + filtering.
755 + This is the normal action, since the raw file
756 + takes up disk space and is not generally useful.
757 + However, if you wish to perform some special filtering function,
758 + this file can be renamed instead of removed by giving a
759 + root file name in this entry window.
760 + The final name in this case will be the given root plus and
761 + underscore plus the view name followed by a ".pic" suffix.
762 +
763 + In the special case when the raw file name and picture file name are
764 + the same, the raw file is saved and no filtering takes place.
765 +
766 + .Views.Zfile
767 +
768 + The "Zfile" entry window gives the root name of the file in which to
769 + store the raw (binary floating point) distances to pixels in the
770 + original generated image.
771 + If this entry is empty, then no z-file will be saved.
772 +
773 + The final z-file name will be the given root plus an underscore plus
774 + the view name plus a ".zbf" suffix.
775 +
776 + To convert this image to human-readable form, the program "od" will
777 + work on some systems, or the Radiance "pvalue" program may be used
778 + to first convert it to a greyscale Radiance picture using the
779 + options "-r -h -b -df `getinfo -d < pictname`" where "pictname" is
780 + replaced by the raw picture file name.
781 + (Getinfo simply gets the original image dimensions, which are not
782 + stored in the z-file.)
783 +
784   .Views.Copy
785  
786   The "Copy" button in the Views screen permits those variables
# Line 761 | Line 793 | untouched.
793  
794   .Views.Revert
795  
796 < The "Revert" button is a convenient way to revert to the original
796 > The "Revert" button is a convenient way to revert to the original
797   values in the rad input file.
798   Only the variables on the Views screen will be affected, but any changes
799   to these variables since the last save will be lost.
# Line 820 | Line 852 | details.)
852  
853   .Options.Penumbras
854  
855 < The "Penumbras" setting determines whether or not Radiance will
855 > The "Penumbras" setting determines whether or not Radiance will
856   make a special effort to generate soft shadows from area light sources.
857   Since this is a potentially expensive calculation, penumbras should
858   only be switched "On" when they are really needed.
# Line 848 | Line 880 | vary according to the location and characteristics of
880  
881   .Options.AmbDelete
882  
883 < The "Delete" button next to the "Ambfile" window on the Options
883 > The "Delete" button next to the "Ambfile" window on the Options
884   screens allows you to remove the named ambient file.
885   This is usually done when a change to one or more rad variables
886   casts doubt on the accuracy of the values stored in this file.
# Line 879 | Line 911 | a given rendering has progressed.
911   Normally, progress reports and errors during batch renderings
912   are sent to the error file given by the root of the rad input
913   file name followed by the ".err" suffix.
914 < (See the "Errors" topic under the "Action" screen category.)
914 > (See the "CheckErr" topic under the "Action" screen category.)
915   If you wish these reports and errors to be directed to a different
916   file, follow the time interval by a space and a file name.
917  
918   No setting on this variable means do not report rendering progress.
919 < A zero setting means the same thing, and may be used when a
919 > A zero setting means the same thing, and may be used when a
920   separate error file is desired but progress reports are not.
921  
922   .Options.Oconv
# Line 925 | Line 957 | since rad does not have the intelligence to do it for
957  
958   The "render opts" window is used to specify additional options to
959   the rview(1) and rpict(1) rendering programs.
960 < Most of the important parameters are computed by rad, so this
960 > Most of the important parameters are computed by rad, so this
961   window is usually used to override specific parameters or to give
962   additional information, such as which materials to exclude from the
963   interreflection calculation.
# Line 978 | Line 1010 | foreground.
1010   The next set of buttons provides for the control of a batch
1011   rendering process, taking place in the background.
1012   Finally, the bottom set of buttons allows you to preview what would
1013 < happen during a batch rendering, or (equivalently) make a script of
1013 > happen during a batch rendering, or (equivalently) make a script of
1014   UNIX commands for later execution.
1015  
1016   When the Action screen is first brought up, the message window
# Line 1053 | Line 1085 | unfortunately.)
1085  
1086   .Action.Rview
1087  
1088 < The "rview" button on the Action screen starts an interactive
1089 < rendering for the selected view, indicated by the menu button
1088 > The "rview" button on the Action screen starts an interactive
1089 > rendering for the selected view, indicated by the menu button
1090   just to the right.
1091 < Other views may be accessed within rview using the "L name"
1092 < command, and new views can be added with the "V name"
1091 > Other views may be accessed within rview using the "L name"
1092 > command, and new views can be added with the "V name"
1093   command.
1062 (See the rview(1) man page and the "View" topic in the current
1063 help category for more information.)
1094  
1095 < If the octree is out-of-date, it will be rebuilt before rendering
1095 > When using the "V" command to change an existing view, do not
1096 > give it an existing name because the previous view will not be overridden.
1097 > Instead, give it a new name (or no name, which will show up as
1098 > a number later), then use the Views screen to override the previous
1099 > view definition with the new one.
1100 > (See the "View" topic in the current
1101 > help category, the "Change" topic under "Views" and the rview(1)
1102 > manual page for more information.)
1103 >
1104 > If the octree is out-of-date, it will be rebuilt before rendering
1105   begins.
1106  
1107   .Action.View
1108  
1109   The Action screen contains two menus for selecting views.
1110 < The top menu, next to the "rview" button, sets the view to start
1110 > The top menu, next to the "rview" button, sets the view to start
1111   with in rview, and is selected from the current view list.
1112 < The second view menu, next to the "Start" button for batch
1112 > The second view menu, next to the "Start" button for batch
1113   rendering, selects the view or views to render in batch mode.
1114 < If the special entry "ALL" is selected, then every view in the
1114 > If the special entry "ALL" is selected, then every view in the
1115   current list will be rendered if it hasn't been already.
1116  
1117 < The batch rendering view menu also selects the view or views
1117 > The view menu next to the "rview" button will be disabled if there
1118 > is only one view to choose from.
1119 > The view menu next to the "Start" button will be disabled if there
1120 > is a batch job in progress, and thus the view cannot be changed.
1121 >
1122 > The batch rendering view menu also selects the view or views
1123   to use in producing a script during a dry run.
1124  
1125   .Action.Start
1126  
1127 < The "Start" button for batch rendering on the Action screen
1128 < initiates a rad rendering process in the background using the
1127 > The "Start" button for batch rendering on the Action screen
1128 > initiates a rad rendering process in the background using the
1129   selected view or views shown on the menu button to the right.
1130  
1131   If any of the rad variables have been changed since the
# Line 1090 | Line 1134 | your changes before starting a background process.
1134   If you discard these changes, then the batch rendering will be
1135   conducted using the previously saved values.
1136  
1137 < Once a background process is going, the "Start" button is
1138 < disabled, and rendering progress can be monitored by checking
1137 > Once a background process is going, the "Start" button is
1138 > disabled, and rendering progress can be monitored by checking
1139   the error file periodically.
1140 < (This file is named by the root of the rad input file followed by
1140 > (This file is named by the root of the rad input file followed by
1141   ".err".)
1142 < When a batch process is started or already running, this button
1143 < will be disabled.
1142 > When a batch process is started or already running, or when a
1143 > process is on another host and its status is unknown,
1144 > this button will be disabled.
1145  
1146 < The background process can be killed during this or later
1146 > The background process can be killed during this or later
1147   invocations of trad using the "Kill" button.
1148 + If the process was started on another machine and the status is unknown,
1149 + it will be necessary to run trad from the other host or remove the error
1150 + file manually before starting a background process on this machine.
1151 + This is to protect you from the great confusion that results when two
1152 + machines are working from the same project file.
1153  
1154   .Action.Kill
1155  
1156 < The batch rendering "Kill" button kills the
1156 > The batch rendering "Kill" button kills the
1157   background process started earlier with the "Start" button.
1158 < The rad process id is taken from the first line of the error file,
1158 > The rad process id is taken from the first line of the error file,
1159   and this process and all its children are killed when the
1160   button is pressed.
1161  
1162 < So long as there is an ambient file specified in the Options
1163 < screen, no data is lost by killing and restarting a batch
1162 > So long as there is an ambient file specified in the Options
1163 > screen, no data is lost by killing and restarting a batch
1164   rendering, though some new startup costs will be incurred.
1165  
1166 < The "Kill" button is disabled if no running batch process is
1167 < detected.
1166 > The "Kill" button is disabled if no running batch process is
1167 > detected on the current host machine.
1168  
1169   .Action.CheckErr
1170  
1171   Pressing the "Check errors" button
1172 < displays the contents of the batch rendering error file, named
1173 < by the root of the current rad input file followed by the ".err"
1172 > displays the contents of the batch rendering error file, named
1173 > by the root of the current rad input file followed by the ".err"
1174   suffix.
1175 < This file will contain the command lines executed by rad so far,
1176 < and may or may not contain additional progress reports from
1175 > This file will contain the command lines executed by rad so far,
1176 > and may or may not contain additional progress reports from
1177   rpict, depending on the initial setting of the "REPORT" variable.
1178  
1179   If no error file exists, this button will be disabled.
# Line 1131 | Line 1181 | If no error file exists, this button will be disabled.
1181   .Action.Script
1182  
1183   The dry run "Script" button runs rad with the
1184 < "-n" option so that you may see the commands that would be
1184 > "-n" option so that you may see the commands that would be
1185   executed during a batch run without actually executing them.
1186 < If a file is named in the window next to this button, the output
1186 > If a file is named in the window next to this button, the output
1187   will simply be written to that file.
1188 < If no file is named, a temporary file is created and an editor
1188 > If no file is named, a temporary file is created and an editor
1189   window is opened on it.
1190  
1191   Producing a dry run also writes the "Optfile" if one is specified
# Line 1143 | Line 1193 | on the Options screen.
1193   This may be useful for computing rendering parameters for rtrace(1)
1194   or rpiece(1).
1195  
1196 < The view or views are selected by the same menu used for
1196 > The view or views are selected by the same menu used for
1197   batch rendering.
1198 < (See the "View" topic under the current help category for more
1198 > (See the "View" topic under the current help category for more
1199   information.)
1200  
1201   .Action.Edit
1202  
1203 < The dry run "Edit" button is used to edit the named script file
1203 > The dry run "Edit" button is used to edit the named script file
1204   created by pressing the "Script" button.
1205   If no file is named, this button is ineffective.
1206  
1207   .Action.Delete
1208  
1209 < The "Delete" button removes the named script file, created by the
1209 > The "Delete" button removes the named script file, created by the
1210   "Script" button.
1211 < If no file is named, or the named file does not exist, this button has
1211 > If no file is named, or the named file does not exist, this button has
1212   no effect.
1213  
1214   .Results.Intro
1215  
1216   This button selects the trad Results screen.
1217 < This screen permits rendered pictures to be displayed,
1217 > This screen permits rendered pictures to be displayed,
1218   converted to other image formats, and printed.
1219 < Only finished pictures may be converted or printed, but
1220 < incomplete pictures (i.e. aborted renderings or renderings in
1219 > Only finished pictures may be converted or printed, but
1220 > incomplete pictures (i.e. aborted renderings or renderings in
1221   progress) may be displayed interactively.
1222  
1223   The left-hand window shows a list of completed views, and the
1224 < right-hand window shows views that have been started but not
1224 > right-hand window shows views that have been started but not
1225   finished.
1226 < Note that other views may not even be started, thus may not
1226 > Note that other views may not even be started, thus may not
1227   appear in either list.
1228 < Also, just because a view appears on the Results screen, it does
1229 < not mean that view is up-to-date with respect to the Radiance
1228 > Also, just because a view appears on the Results screen, it does
1229 > not mean that view is up-to-date with respect to the Radiance
1230   input files.
1231 < (The best way currently to tell which pictures are out-of-date
1232 < is to press the "Script" button on the Action screen and examine
1231 > (The best way currently to tell which pictures are out-of-date
1232 > is to press the "Script" button on the Action screen and examine
1233   the output.)
1234  
1235   .Results.Finished
# Line 1212 | Line 1262 | Shift-click also allows views to be added to the selec
1262  
1263   .Results.Rescan
1264  
1265 < The "Rescan" button on the Results screen is used to update the
1266 < finished and unfinished view lists, in case one or more pictures
1265 > The "Rescan" button on the Results screen is used to update the
1266 > finished and unfinished view lists, in case one or more pictures
1267   has completed since the Results screen was brought up.
1268  
1269   .Results.Delete
1270  
1271   The "Delete" button on the Results screen is used to remove the
1272   selected picture files from the filesystem.
1273 + Associated raw picture and z-buffer files
1274 + will also be deleted if they exist.
1275   Verification is required before any action is taken.
1276  
1277   .Results.Display

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines