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.17 by greg, Fri May 17 14:59:20 1996 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 402 | 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.
405 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 494 | 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 505 | Line 516 | used for exterior zones and 0.01 for interior zones.
516  
517   The "Copy" button on the Zone screen takes all values for this
518   screen from another rad input file, replacing the current values.
519 < Specifically, the rad variables "ZONE, DETAIL, INDIRECT,
519 > Specifically, the rad variables "ZONE, DETAIL, INDIRECT,
520   VARIABILITY and EXPOSURE" will be copied from the named file.
521  
522   All other variables will be left untouched.
523  
524   .Zone.Revert
525  
526 < The "Revert" button is a convenient way to revert to the original
526 > The "Revert" button is a convenient way to revert to the original
527   values in the rad input file.
528   Only the variables on the Zone screen will be affected, but any changes
529   to these variables since the last save will be lost.
# Line 524 | Line 535 | This screen provides a means of setting the multi-valu
535   "view" variable.
536   Each view setting is listed by name, or by number if no name has
537   been assigned.
538 < To add a new view, enter a unique name and specify the view
538 > To add a new view, enter a unique name and specify the view
539   options,
540   then press the "Add" or "Set Default" button.
541   If a view with the same name already exists, it is unconditionally
# Line 534 | 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 rview 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 580 | The standard view is "X" is used if no views are speci
580  
581   Each view has a unique name, which may be chosen at the user's
582   discretion or taken from a list of standard views, described below.
583 < An invented name should be kept as short as possible, since it is
583 > An invented name should be kept as short as possible, since it is
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]?[vlah]?".
587 > "[Xx]?[Yy]?[Zz]?[vlahc]?".
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 or H.)
590 > followed by an optional lower case V, L, A, H or C.)
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, and 'h' is
595 < hemispherical fisheye.
596 < A perspective view from maximum X, minimum Y would be "Xy" or
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".
598   A parallel view from maximum Z would be "Zl".
599   If "ZONE" is an interior zone, the standard views will
# Line 622 | 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 or h", corresponding to
637 < perspective, parallel, angular and hemispherical fisheye, respectively.
638 < The "-vp x y z" option sets the view position (eyepoint), where "x y z"
636 > replaced by one of the letters "v, l, a, h 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"
640   is replaced by the position in 3-space.
641   The "-vd xd yd zd" option sets the view direction, where "xd yd zd"
642   is a vector pointing in the desired direction.
# Line 633 | Line 645 | the eyepoint from the look-at point.  Vector normaliza
645   unnecessary.)
646   The "-vh horiz" and "-vv vert" options set the horizontal and
647   vertical view sizes, respectively.
648 < For perspective views, these correspond to full camera angles in
648 > For perspective views, these correspond to full camera angles in
649   degrees.
650   For parallel views (using the "-vtl" option), they correspond to
651   image plane size in world coordinates.
# Line 648 | Line 660 | In particular, make sure that each option and each arg
660   space between it and whatever follows.
661  
662   Hitting return in the "Options" window is equivalent to pressing the
663 < "Add" button.
663 > "Add" button followed by the "Clear" button.
664  
665   .Views.Add
666  
# Line 685 | 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  
688 Note that Control-U will always clear an entry box whose cursor is
689 active.
690
700   .Views.Default
701  
702   The "Set Default" button may be used to make the selected view the
# Line 710 | 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  
# Line 749 | Line 758 | to maintain a specific pixel aspect ratio (1 by defaul
758  
759   The default value for this variable is "512".
760  
761 + .Views.Rawfile
762 +
763 + The "Rawfile" entry window determines if and where the raw output picture
764 + from rpict will be saved.
765 + If the entry is empty, the file will be removed after rendering and
766 + filtering.
767 + This is the normal action, since the raw file
768 + takes up disk space and is not generally useful.
769 + However, if you wish to perform some special filtering function,
770 + this file can be renamed instead of removed by giving a
771 + root file name in this entry window.
772 + The final name in this case will be the given root plus and
773 + underscore plus the view name followed by a ".pic" suffix.
774 +
775 + In the special case when the raw file name and picture file name are
776 + the same, the raw file is saved and no filtering takes place.
777 +
778 + .Views.Zfile
779 +
780 + The "Zfile" entry window gives the root name of the file in which to
781 + store the raw (binary floating point) distances to pixels in the
782 + original generated image.
783 + If this entry is empty, then no z-file will be saved.
784 +
785 + The final z-file name will be the given root plus an underscore plus
786 + the view name plus a ".zbf" suffix.
787 +
788 + To convert this image to human-readable form, the program "od" will
789 + work on some systems, or the Radiance "pvalue" program may be used
790 + to first convert it to a greyscale Radiance picture using the
791 + options "-r -h -b -df `getinfo -d < pictname`" where "pictname" is
792 + replaced by the raw picture file name.
793 + (Getinfo simply gets the original image dimensions, which are not
794 + stored in the z-file.)
795 +
796   .Views.Copy
797  
798   The "Copy" button in the Views screen permits those variables
# Line 761 | Line 805 | untouched.
805  
806   .Views.Revert
807  
808 < The "Revert" button is a convenient way to revert to the original
808 > The "Revert" button is a convenient way to revert to the original
809   values in the rad input file.
810   Only the variables on the Views screen will be affected, but any changes
811   to these variables since the last save will be lost.
# Line 820 | Line 864 | details.)
864  
865   .Options.Penumbras
866  
867 < The "Penumbras" setting determines whether or not Radiance will
867 > The "Penumbras" setting determines whether or not Radiance will
868   make a special effort to generate soft shadows from area light sources.
869   Since this is a potentially expensive calculation, penumbras should
870   only be switched "On" when they are really needed.
# Line 848 | Line 892 | vary according to the location and characteristics of
892  
893   .Options.AmbDelete
894  
895 < The "Delete" button next to the "Ambfile" window on the Options
895 > The "Delete" button next to the "Ambfile" window on the Options
896   screens allows you to remove the named ambient file.
897   This is usually done when a change to one or more rad variables
898   casts doubt on the accuracy of the values stored in this file.
# Line 879 | Line 923 | a given rendering has progressed.
923   Normally, progress reports and errors during batch renderings
924   are sent to the error file given by the root of the rad input
925   file name followed by the ".err" suffix.
926 < (See the "Errors" topic under the "Action" screen category.)
926 > (See the "CheckErr" topic under the "Action" screen category.)
927   If you wish these reports and errors to be directed to a different
928   file, follow the time interval by a space and a file name.
929  
930   No setting on this variable means do not report rendering progress.
931 < A zero setting means the same thing, and may be used when a
931 > A zero setting means the same thing, and may be used when a
932   separate error file is desired but progress reports are not.
933  
934   .Options.Oconv
# Line 925 | Line 969 | since rad does not have the intelligence to do it for
969  
970   The "render opts" window is used to specify additional options to
971   the rview(1) and rpict(1) rendering programs.
972 < Most of the important parameters are computed by rad, so this
972 > Most of the important parameters are computed by rad, so this
973   window is usually used to override specific parameters or to give
974   additional information, such as which materials to exclude from the
975   interreflection calculation.
# Line 978 | Line 1022 | foreground.
1022   The next set of buttons provides for the control of a batch
1023   rendering process, taking place in the background.
1024   Finally, the bottom set of buttons allows you to preview what would
1025 < happen during a batch rendering, or (equivalently) make a script of
1025 > happen during a batch rendering, or (equivalently) make a script of
1026   UNIX commands for later execution.
1027  
1028   When the Action screen is first brought up, the message window
# Line 1053 | Line 1097 | unfortunately.)
1097  
1098   .Action.Rview
1099  
1100 < The "rview" button on the Action screen starts an interactive
1101 < rendering for the selected view, indicated by the menu button
1100 > The "rview" button on the Action screen starts an interactive
1101 > rendering for the selected view, indicated by the menu button
1102   just to the right.
1103 < Other views may be accessed within rview using the "L name"
1104 < command, and new views can be added with the "V name"
1103 > Other views may be accessed within rview using the "L name"
1104 > command, and new views can be added with the "V name"
1105   command.
1062 (See the rview(1) man page and the "View" topic in the current
1063 help category for more information.)
1106  
1107 < If the octree is out-of-date, it will be rebuilt before rendering
1107 > When using the "V" command to change an existing view, do not
1108 > give it an existing name because the previous view will not be overridden.
1109 > Instead, give it a new name (or no name, which will show up as
1110 > a number later), then use the Views screen to override the previous
1111 > view definition with the new one.
1112 > (See the "View" topic in the current
1113 > help category, the "Change" topic under "Views" and the rview(1)
1114 > manual page for more information.)
1115 >
1116 > If the octree is out-of-date, it will be rebuilt before rendering
1117   begins.
1118  
1119   .Action.View
1120  
1121   The Action screen contains two menus for selecting views.
1122 < The top menu, next to the "rview" button, sets the view to start
1122 > The top menu, next to the "rview" button, sets the view to start
1123   with in rview, and is selected from the current view list.
1124 < The second view menu, next to the "Start" button for batch
1124 > The second view menu, next to the "Start" button for batch
1125   rendering, selects the view or views to render in batch mode.
1126 < If the special entry "ALL" is selected, then every view in the
1126 > If the special entry "ALL" is selected, then every view in the
1127   current list will be rendered if it hasn't been already.
1128  
1129 < The batch rendering view menu also selects the view or views
1129 > The view menu next to the "rview" button will be disabled if there
1130 > is only one view to choose from.
1131 > The view menu next to the "Start" button will be disabled if there
1132 > is a batch job in progress, and thus the view cannot be changed.
1133 >
1134 > The batch rendering view menu also selects the view or views
1135   to use in producing a script during a dry run.
1136  
1137   .Action.Start
1138  
1139 < The "Start" button for batch rendering on the Action screen
1140 < initiates a rad rendering process in the background using the
1139 > The "Start" button for batch rendering on the Action screen
1140 > initiates a rad rendering process in the background using the
1141   selected view or views shown on the menu button to the right.
1142  
1143   If any of the rad variables have been changed since the
# Line 1090 | Line 1146 | your changes before starting a background process.
1146   If you discard these changes, then the batch rendering will be
1147   conducted using the previously saved values.
1148  
1149 < Once a background process is going, the "Start" button is
1150 < disabled, and rendering progress can be monitored by checking
1149 > Once a background process is going, the "Start" button is
1150 > disabled, and rendering progress can be monitored by checking
1151   the error file periodically.
1152 < (This file is named by the root of the rad input file followed by
1152 > (This file is named by the root of the rad input file followed by
1153   ".err".)
1154 < When a batch process is started or already running, this button
1155 < will be disabled.
1154 > When a batch process is started or already running, or when a
1155 > process is on another host and its status is unknown,
1156 > this button will be disabled.
1157  
1158 < The background process can be killed during this or later
1158 > The background process can be killed during this or later
1159   invocations of trad using the "Kill" button.
1160 + If the process was started on another machine and the status is unknown,
1161 + it will be necessary to run trad from the other host or remove the error
1162 + file manually before starting a background process on this machine.
1163 + This is to protect you from the great confusion that results when two
1164 + machines are working from the same project file.
1165  
1166   .Action.Kill
1167  
1168 < The batch rendering "Kill" button kills the
1168 > The batch rendering "Kill" button kills the
1169   background process started earlier with the "Start" button.
1170 < The rad process id is taken from the first line of the error file,
1170 > The rad process id is taken from the first line of the error file,
1171   and this process and all its children are killed when the
1172   button is pressed.
1173  
1174 < So long as there is an ambient file specified in the Options
1175 < screen, no data is lost by killing and restarting a batch
1174 > So long as there is an ambient file specified in the Options
1175 > screen, no data is lost by killing and restarting a batch
1176   rendering, though some new startup costs will be incurred.
1177  
1178 < The "Kill" button is disabled if no running batch process is
1179 < detected.
1178 > The "Kill" button is disabled if no running batch process is
1179 > detected on the current host machine.
1180  
1181   .Action.CheckErr
1182  
1183   Pressing the "Check errors" button
1184 < displays the contents of the batch rendering error file, named
1185 < by the root of the current rad input file followed by the ".err"
1184 > displays the contents of the batch rendering error file, named
1185 > by the root of the current rad input file followed by the ".err"
1186   suffix.
1187 < This file will contain the command lines executed by rad so far,
1188 < and may or may not contain additional progress reports from
1187 > This file will contain the command lines executed by rad so far,
1188 > and may or may not contain additional progress reports from
1189   rpict, depending on the initial setting of the "REPORT" variable.
1190  
1191   If no error file exists, this button will be disabled.
# Line 1131 | Line 1193 | If no error file exists, this button will be disabled.
1193   .Action.Script
1194  
1195   The dry run "Script" button runs rad with the
1196 < "-n" option so that you may see the commands that would be
1196 > "-n" option so that you may see the commands that would be
1197   executed during a batch run without actually executing them.
1198 < If a file is named in the window next to this button, the output
1198 > If a file is named in the window next to this button, the output
1199   will simply be written to that file.
1200 < If no file is named, a temporary file is created and an editor
1200 > If no file is named, a temporary file is created and an editor
1201   window is opened on it.
1202  
1203   Producing a dry run also writes the "Optfile" if one is specified
# Line 1143 | Line 1205 | on the Options screen.
1205   This may be useful for computing rendering parameters for rtrace(1)
1206   or rpiece(1).
1207  
1208 < The view or views are selected by the same menu used for
1208 > The view or views are selected by the same menu used for
1209   batch rendering.
1210 < (See the "View" topic under the current help category for more
1210 > (See the "View" topic under the current help category for more
1211   information.)
1212  
1213   .Action.Edit
1214  
1215 < The dry run "Edit" button is used to edit the named script file
1215 > The dry run "Edit" button is used to edit the named script file
1216   created by pressing the "Script" button.
1217   If no file is named, this button is ineffective.
1218  
1219   .Action.Delete
1220  
1221 < The "Delete" button removes the named script file, created by the
1221 > The "Delete" button removes the named script file, created by the
1222   "Script" button.
1223 < If no file is named, or the named file does not exist, this button has
1223 > If no file is named, or the named file does not exist, this button has
1224   no effect.
1225  
1226   .Results.Intro
1227  
1228   This button selects the trad Results screen.
1229 < This screen permits rendered pictures to be displayed,
1229 > This screen permits rendered pictures to be displayed,
1230   converted to other image formats, and printed.
1231 < Only finished pictures may be converted or printed, but
1232 < incomplete pictures (i.e. aborted renderings or renderings in
1231 > Only finished pictures may be converted or printed, but
1232 > incomplete pictures (i.e. aborted renderings or renderings in
1233   progress) may be displayed interactively.
1234  
1235   The left-hand window shows a list of completed views, and the
1236 < right-hand window shows views that have been started but not
1236 > right-hand window shows views that have been started but not
1237   finished.
1238 < Note that other views may not even be started, thus may not
1238 > Note that other views may not even be started, thus may not
1239   appear in either list.
1240 < Also, just because a view appears on the Results screen, it does
1241 < not mean that view is up-to-date with respect to the Radiance
1240 > Also, just because a view appears on the Results screen, it does
1241 > not mean that view is up-to-date with respect to the Radiance
1242   input files.
1243 < (The best way currently to tell which pictures are out-of-date
1244 < is to press the "Script" button on the Action screen and examine
1243 > (The best way currently to tell which pictures are out-of-date
1244 > is to press the "Script" button on the Action screen and examine
1245   the output.)
1246  
1247   .Results.Finished
# Line 1212 | Line 1274 | Shift-click also allows views to be added to the selec
1274  
1275   .Results.Rescan
1276  
1277 < The "Rescan" button on the Results screen is used to update the
1278 < finished and unfinished view lists, in case one or more pictures
1277 > The "Rescan" button on the Results screen is used to update the
1278 > finished and unfinished view lists, in case one or more pictures
1279   has completed since the Results screen was brought up.
1280  
1281   .Results.Delete
1282  
1283   The "Delete" button on the Results screen is used to remove the
1284   selected picture files from the filesystem.
1285 + Associated raw picture and z-buffer files
1286 + will also be deleted if they exist.
1287   Verification is required before any action is taken.
1288  
1289   .Results.Display
# Line 1307 | Line 1371 | details.)
1371   The print command window on the Results screen contains the system
1372   command to use in printing out finished Radiance pictures.
1373   The "%s" format field, which must appear somewhere in the command,
1374 < is replaced by the selected Radiance picture file name(s).
1374 > is replaced by the selected Radiance picture file name.
1375 > This command is executed multiple times if multiple files are
1376 > selected.
1377  
1378   The default command is "ra_ps %s | lpr", which converts the Radiance
1379   picture to a black and white PostScript file and sends it to the lpr
1380   print spooler.
1381 + Add a "-c" option to "ra_ps" if the printer supports color.
1382   If your printer does not understand PostScript, or your system does
1383   not support lpr, this command must obviously be changed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines