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.18 by gwlarson, Tue Oct 20 11:52:15 1998 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  
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 749 | Line 767 | to maintain a specific pixel aspect ratio (1 by defaul
767  
768   The default value for this variable is "512".
769  
770 + .Views.Rawfile
771 +
772 + The "Rawfile" entry window determines if and where the raw output picture
773 + from rpict will be saved.
774 + If the entry is empty, the file will be removed after rendering and
775 + filtering.
776 + This is the normal action, since the raw file
777 + takes up disk space and is not generally useful.
778 + However, if you wish to perform some special filtering function,
779 + this file can be renamed instead of removed by giving a
780 + root file name in this entry window.
781 + The final name in this case will be the given root plus and
782 + underscore plus the view name followed by a ".pic" suffix.
783 +
784 + In the special case when the raw file name and picture file name are
785 + the same, the raw file is saved and no filtering takes place.
786 +
787 + .Views.Zfile
788 +
789 + The "Zfile" entry window gives the root name of the file in which to
790 + store the raw (binary floating point) distances to pixels in the
791 + original generated image.
792 + If this entry is empty, then no z-file will be saved.
793 +
794 + The final z-file name will be the given root plus an underscore plus
795 + the view name plus a ".zbf" suffix.
796 +
797 + To convert this image to human-readable form, the program "od" will
798 + work on some systems, or the Radiance "pvalue" program may be used
799 + to first convert it to a greyscale Radiance picture using the
800 + options "-r -h -b -df `getinfo -d < pictname`" where "pictname" is
801 + replaced by the raw picture file name.
802 + (Getinfo simply gets the original image dimensions, which are not
803 + stored in the z-file.)
804 +
805   .Views.Copy
806  
807   The "Copy" button in the Views screen permits those variables
# Line 761 | Line 814 | untouched.
814  
815   .Views.Revert
816  
817 < The "Revert" button is a convenient way to revert to the original
817 > The "Revert" button is a convenient way to revert to the original
818   values in the rad input file.
819   Only the variables on the Views screen will be affected, but any changes
820   to these variables since the last save will be lost.
# Line 820 | Line 873 | details.)
873  
874   .Options.Penumbras
875  
876 < The "Penumbras" setting determines whether or not Radiance will
876 > The "Penumbras" setting determines whether or not Radiance will
877   make a special effort to generate soft shadows from area light sources.
878   Since this is a potentially expensive calculation, penumbras should
879   only be switched "On" when they are really needed.
# Line 848 | Line 901 | vary according to the location and characteristics of
901  
902   .Options.AmbDelete
903  
904 < The "Delete" button next to the "Ambfile" window on the Options
904 > The "Delete" button next to the "Ambfile" window on the Options
905   screens allows you to remove the named ambient file.
906   This is usually done when a change to one or more rad variables
907   casts doubt on the accuracy of the values stored in this file.
# Line 879 | Line 932 | a given rendering has progressed.
932   Normally, progress reports and errors during batch renderings
933   are sent to the error file given by the root of the rad input
934   file name followed by the ".err" suffix.
935 < (See the "Errors" topic under the "Action" screen category.)
935 > (See the "CheckErr" topic under the "Action" screen category.)
936   If you wish these reports and errors to be directed to a different
937   file, follow the time interval by a space and a file name.
938  
939   No setting on this variable means do not report rendering progress.
940 < A zero setting means the same thing, and may be used when a
940 > A zero setting means the same thing, and may be used when a
941   separate error file is desired but progress reports are not.
942  
943   .Options.Oconv
# Line 925 | Line 978 | since rad does not have the intelligence to do it for
978  
979   The "render opts" window is used to specify additional options to
980   the rview(1) and rpict(1) rendering programs.
981 < Most of the important parameters are computed by rad, so this
981 > Most of the important parameters are computed by rad, so this
982   window is usually used to override specific parameters or to give
983   additional information, such as which materials to exclude from the
984   interreflection calculation.
# Line 978 | Line 1031 | foreground.
1031   The next set of buttons provides for the control of a batch
1032   rendering process, taking place in the background.
1033   Finally, the bottom set of buttons allows you to preview what would
1034 < happen during a batch rendering, or (equivalently) make a script of
1034 > happen during a batch rendering, or (equivalently) make a script of
1035   UNIX commands for later execution.
1036  
1037   When the Action screen is first brought up, the message window
# Line 1053 | Line 1106 | unfortunately.)
1106  
1107   .Action.Rview
1108  
1109 < The "rview" button on the Action screen starts an interactive
1110 < rendering for the selected view, indicated by the menu button
1109 > The "rview" button on the Action screen starts an interactive
1110 > rendering for the selected view, indicated by the menu button
1111   just to the right.
1112 < Other views may be accessed within rview using the "L name"
1113 < command, and new views can be added with the "V name"
1112 > Other views may be accessed within rview using the "L name"
1113 > command, and new views can be added with the "V name"
1114   command.
1062 (See the rview(1) man page and the "View" topic in the current
1063 help category for more information.)
1115  
1116 < If the octree is out-of-date, it will be rebuilt before rendering
1116 > When using the "V" command to change an existing view, do not
1117 > give it an existing name because the previous view will not be overridden.
1118 > Instead, give it a new name (or no name, which will show up as
1119 > a number later), then use the Views screen to override the previous
1120 > view definition with the new one.
1121 > (See the "View" topic in the current
1122 > help category, the "Change" topic under "Views" and the rview(1)
1123 > manual page for more information.)
1124 >
1125 > If the octree is out-of-date, it will be rebuilt before rendering
1126   begins.
1127  
1128   .Action.View
1129  
1130   The Action screen contains two menus for selecting views.
1131 < The top menu, next to the "rview" button, sets the view to start
1131 > The top menu, next to the "rview" button, sets the view to start
1132   with in rview, and is selected from the current view list.
1133 < The second view menu, next to the "Start" button for batch
1133 > The second view menu, next to the "Start" button for batch
1134   rendering, selects the view or views to render in batch mode.
1135 < If the special entry "ALL" is selected, then every view in the
1135 > If the special entry "ALL" is selected, then every view in the
1136   current list will be rendered if it hasn't been already.
1137  
1138 < The batch rendering view menu also selects the view or views
1138 > The view menu next to the "rview" button will be disabled if there
1139 > is only one view to choose from.
1140 > The view menu next to the "Start" button will be disabled if there
1141 > is a batch job in progress, and thus the view cannot be changed.
1142 >
1143 > The batch rendering view menu also selects the view or views
1144   to use in producing a script during a dry run.
1145  
1146   .Action.Start
1147  
1148 < The "Start" button for batch rendering on the Action screen
1149 < initiates a rad rendering process in the background using the
1148 > The "Start" button for batch rendering on the Action screen
1149 > initiates a rad rendering process in the background using the
1150   selected view or views shown on the menu button to the right.
1151  
1152   If any of the rad variables have been changed since the
# Line 1090 | Line 1155 | your changes before starting a background process.
1155   If you discard these changes, then the batch rendering will be
1156   conducted using the previously saved values.
1157  
1158 < Once a background process is going, the "Start" button is
1159 < disabled, and rendering progress can be monitored by checking
1158 > Once a background process is going, the "Start" button is
1159 > disabled, and rendering progress can be monitored by checking
1160   the error file periodically.
1161 < (This file is named by the root of the rad input file followed by
1161 > (This file is named by the root of the rad input file followed by
1162   ".err".)
1163 < When a batch process is started or already running, this button
1164 < will be disabled.
1163 > When a batch process is started or already running, or when a
1164 > process is on another host and its status is unknown,
1165 > this button will be disabled.
1166  
1167 < The background process can be killed during this or later
1167 > The background process can be killed during this or later
1168   invocations of trad using the "Kill" button.
1169 + If the process was started on another machine and the status is unknown,
1170 + it will be necessary to run trad from the other host or remove the error
1171 + file manually before starting a background process on this machine.
1172 + This is to protect you from the great confusion that results when two
1173 + machines are working from the same project file.
1174  
1175   .Action.Kill
1176  
1177 < The batch rendering "Kill" button kills the
1177 > The batch rendering "Kill" button kills the
1178   background process started earlier with the "Start" button.
1179 < The rad process id is taken from the first line of the error file,
1179 > The rad process id is taken from the first line of the error file,
1180   and this process and all its children are killed when the
1181   button is pressed.
1182  
1183 < So long as there is an ambient file specified in the Options
1184 < screen, no data is lost by killing and restarting a batch
1183 > So long as there is an ambient file specified in the Options
1184 > screen, no data is lost by killing and restarting a batch
1185   rendering, though some new startup costs will be incurred.
1186  
1187 < The "Kill" button is disabled if no running batch process is
1188 < detected.
1187 > The "Kill" button is disabled if no running batch process is
1188 > detected on the current host machine.
1189  
1190   .Action.CheckErr
1191  
1192   Pressing the "Check errors" button
1193 < displays the contents of the batch rendering error file, named
1194 < by the root of the current rad input file followed by the ".err"
1193 > displays the contents of the batch rendering error file, named
1194 > by the root of the current rad input file followed by the ".err"
1195   suffix.
1196 < This file will contain the command lines executed by rad so far,
1197 < and may or may not contain additional progress reports from
1196 > This file will contain the command lines executed by rad so far,
1197 > and may or may not contain additional progress reports from
1198   rpict, depending on the initial setting of the "REPORT" variable.
1199  
1200   If no error file exists, this button will be disabled.
# Line 1131 | Line 1202 | If no error file exists, this button will be disabled.
1202   .Action.Script
1203  
1204   The dry run "Script" button runs rad with the
1205 < "-n" option so that you may see the commands that would be
1205 > "-n" option so that you may see the commands that would be
1206   executed during a batch run without actually executing them.
1207 < If a file is named in the window next to this button, the output
1207 > If a file is named in the window next to this button, the output
1208   will simply be written to that file.
1209 < If no file is named, a temporary file is created and an editor
1209 > If no file is named, a temporary file is created and an editor
1210   window is opened on it.
1211  
1212   Producing a dry run also writes the "Optfile" if one is specified
# Line 1143 | Line 1214 | on the Options screen.
1214   This may be useful for computing rendering parameters for rtrace(1)
1215   or rpiece(1).
1216  
1217 < The view or views are selected by the same menu used for
1217 > The view or views are selected by the same menu used for
1218   batch rendering.
1219 < (See the "View" topic under the current help category for more
1219 > (See the "View" topic under the current help category for more
1220   information.)
1221  
1222   .Action.Edit
1223  
1224 < The dry run "Edit" button is used to edit the named script file
1224 > The dry run "Edit" button is used to edit the named script file
1225   created by pressing the "Script" button.
1226   If no file is named, this button is ineffective.
1227  
1228   .Action.Delete
1229  
1230 < The "Delete" button removes the named script file, created by the
1230 > The "Delete" button removes the named script file, created by the
1231   "Script" button.
1232 < If no file is named, or the named file does not exist, this button has
1232 > If no file is named, or the named file does not exist, this button has
1233   no effect.
1234  
1235   .Results.Intro
1236  
1237   This button selects the trad Results screen.
1238 < This screen permits rendered pictures to be displayed,
1238 > This screen permits rendered pictures to be displayed,
1239   converted to other image formats, and printed.
1240 < Only finished pictures may be converted or printed, but
1241 < incomplete pictures (i.e. aborted renderings or renderings in
1240 > Only finished pictures may be converted or printed, but
1241 > incomplete pictures (i.e. aborted renderings or renderings in
1242   progress) may be displayed interactively.
1243  
1244   The left-hand window shows a list of completed views, and the
1245 < right-hand window shows views that have been started but not
1245 > right-hand window shows views that have been started but not
1246   finished.
1247 < Note that other views may not even be started, thus may not
1247 > Note that other views may not even be started, thus may not
1248   appear in either list.
1249 < Also, just because a view appears on the Results screen, it does
1250 < not mean that view is up-to-date with respect to the Radiance
1249 > Also, just because a view appears on the Results screen, it does
1250 > not mean that view is up-to-date with respect to the Radiance
1251   input files.
1252 < (The best way currently to tell which pictures are out-of-date
1253 < is to press the "Script" button on the Action screen and examine
1252 > (The best way currently to tell which pictures are out-of-date
1253 > is to press the "Script" button on the Action screen and examine
1254   the output.)
1255  
1256   .Results.Finished
# Line 1212 | Line 1283 | Shift-click also allows views to be added to the selec
1283  
1284   .Results.Rescan
1285  
1286 < The "Rescan" button on the Results screen is used to update the
1287 < finished and unfinished view lists, in case one or more pictures
1286 > The "Rescan" button on the Results screen is used to update the
1287 > finished and unfinished view lists, in case one or more pictures
1288   has completed since the Results screen was brought up.
1289  
1290   .Results.Delete
1291  
1292   The "Delete" button on the Results screen is used to remove the
1293   selected picture files from the filesystem.
1294 + Associated raw picture and z-buffer files
1295 + will also be deleted if they exist.
1296   Verification is required before any action is taken.
1297  
1298   .Results.Display
# Line 1307 | Line 1380 | details.)
1380   The print command window on the Results screen contains the system
1381   command to use in printing out finished Radiance pictures.
1382   The "%s" format field, which must appear somewhere in the command,
1383 < is replaced by the selected Radiance picture file name(s).
1383 > is replaced by the selected Radiance picture file name.
1384 > This command is executed multiple times if multiple files are
1385 > selected.
1386  
1387   The default command is "ra_ps %s | lpr", which converts the Radiance
1388   picture to a black and white PostScript file and sends it to the lpr
1389   print spooler.
1390 + Add a "-c" option to "ra_ps" if the printer supports color.
1391   If your printer does not understand PostScript, or your system does
1392   not support lpr, this command must obviously be changed.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines