home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d2xx / d231 / plot.lha / Plot / Docs / Readme < prev    next >
Text File  |  1989-07-23  |  12KB  |  251 lines

  1.  
  2.                              PLOT 1.2
  3.  
  4.                            © AG BAXTER
  5.  
  6. This is program placed in the Public Domain for free use WITH THE
  7.        SPECIFIC EXCEPTION OF REDISTRIBUTION FOR PROFIT.
  8.                             June 1989
  9.  
  10.                    Walter & Eliza Hall Institute,
  11.               c/o PostOffice, Royal Melbourne Hospital,
  12.                      Parkville 3053. VICTORIA
  13.  
  14.      PLOT 1.2 is an intuition interface for the data plotting programs
  15. MultiPlot and ThreeDPlot, which were written by Tim Mooney and have
  16. been placed in the public domain. These programs are powerful tools
  17. for manipulating data but are marred by their inconvenience to use.
  18. ThreeDPlot requires that the data file be converted to binary before
  19. loading, both programs output files which need further processing before
  20. they can be input into a CAD program, and both use complex command line
  21. arguments which may discourage some users.
  22.  
  23.      PLOT 1.2 corrects these faults and provides a convenient way to
  24. use these excellent programs swifty and conveniently, providing the
  25. appearance of a single integrated data manipulation system.
  26.  
  27.                          SYSTEM REQUIREMENTS
  28.  
  29.     Amiga with a minimum of 512K memory (1MB is useful), Amiga DOS, the
  30. assignment of a T: directory (assign to disk if <1MB memory), a window
  31. based screen editor, the presence of "run", "copy" and "cd" in the C:
  32. directory, and the font ruby 12 in the FONTS: directory.
  33.  
  34.  If the version of Plot you have is 1.21, you will also need the newcon-
  35. handler (DOS 1.3) in the l: directory. The following files should be in
  36. a single directory, either assigned the name "PLOT:" or in the root
  37. directory of a volume (disk) titled PLOT.
  38.  
  39.  
  40.                                 FILES
  41.  
  42. Plot           Intuition interface
  43. Multiplot      2D plotting program
  44. ThreeDPlot     3D net plotting program
  45. Txt_2_Icad     Converts output from Multiplot and ThreeDPlot to IntroCAD
  46. Plot2Draw      Converts output from Mutiplot and ThreeDPlot to Draw format.
  47. Plot2mCAD      Adds an icon to output from Multiplot and ThreeDPlot.
  48. Dat_2_Bin      Converts data to a format accepted by ThreeDPlot
  49. Icad_2_Text    Converts IntroCAD format to mCAD format
  50.  
  51.  
  52.                                PLOT
  53.  
  54.     Plot may be started from the CLI by typing "PLOT" at the prompt, or
  55. from WorkBench by double clicking its icon. It will open its own window
  56. with a tile bar and menu strip at the top.
  57.     Beneath the title bar are three large buttons. The buttons labeled
  58. "2D PLOT" and "3D PLOT" are mutually exclusive and one should be selected
  59. before plotting your data. The middle button labeled "EDIT" calls up the
  60. editor of your choice from within Plot and loads the file listed in the
  61. FileName selector. This allows you to edit or create a data file without
  62. exiting PLOT. A new file may be created by entering a novel name, clicking
  63. on the "EDIT" button, hitting "OK" on the warning that a file of that name
  64. does not exist, and then selecting "YES" when asked if you would like to
  65. create a new file.
  66.  
  67.     Beneath these three buttons is the FileName requester in which you
  68. enter the full pathname of the file you wish to edit or plot, and the "PATH"
  69. button which will call up a directory-listing style of file requester.
  70.  
  71.     The next part of the screen is devided into two. On the left side is
  72. a series of buttons related to plotting 2D graphs, and on the right side is
  73. a series on buttons for selecting options when plotting 3D graphs. The 2D
  74. plotting buttons largely describe the data file format (see below). The 3D
  75. plotting buttons toggle options such as cross net for 3D plot, axes, and
  76. rendering of the underside of the 3D plot. The best way to find out
  77. what these do is to try them out on the data file PLOT:data/plot3D.
  78.  
  79.  
  80.  
  81. DATAFILE FORMATS
  82.  
  83.     A 2D data file is flexible in format. It must contain values in columns,
  84. but what values in which columns can be varied. A good scheme is to place
  85. the X values in the first column, Y values in the second and values of
  86. Error-in-Y in the third (if they exist). Whatever you choose, indicate your
  87. format to PLOT by pushing the selection buttons on the left of the screen.
  88. If none are selected, PLOT will default to X in the first column, Y in the
  89. second, and will not plot error bars.
  90.  
  91.     The 3D PLOT part of the program is a lot more fussy about the format
  92. of its data file. If the file is not correct in format, it will cause the
  93. computer to crash. A future enhancement of plot will be 3D data file
  94. format checking, but for now, you will just have to be careful. The 3D
  95. data file must consist of a single column of numbers with the exception
  96. of the first line which must contain the number of X values and the
  97. number of Y values with a single space between the two figures. Directly
  98. below this line in the first column of the screen should be first the X
  99. values in increasing order and then the Y values in increasing order. Below
  100. this should be the Z values, reading left to right for each row from the
  101. front to the back. The last line of the data file should be the string
  102. "end_of_file" without the quotes. See ThreeDPlot.doc for more information.
  103. The on/off buttons on the right side of the screen can be used
  104. to select the options for the 3D plot. The default is for the crossnet, axes
  105. and the underside to be drawn.
  106.  
  107. PLOTTING
  108.  
  109.     The large button at the bottom of the screen makes it all happen. Both
  110. types of PLOTs will open an interactive window to communicate with you.
  111. For a 2D plot, this is called the "How To" window, and can be recalled
  112. from within the plot to change some options. These options are extensive
  113. and received as a command string which describes to Multiplot the required
  114. tick spacing, whether a grid is desired, point size, presence of error
  115. bars and line colours. A full description of the command arguments may be
  116. obtained by hitting "?" at the "How To" prompt. You will have to resize to
  117. window to read all the help message. A default plot will be obtained by
  118. simply hitting return at the prompt.
  119.  
  120.     The window opened for a 3D plot  doesn't expect any input from you. It
  121. lets you know how it is getting on plotting your picture. A complex 3D
  122. graph will take many minutes to calculate, so be patient. When the data
  123. has been processed, the program will ask you for the veiwing angle you
  124. would like to veiw the graph from. Hitting return will give you a sensible
  125. default. The screen will go blank while PLOT calculates the screen image.
  126. Again BE PATIENT. Your Amiga will be working flat out calculating the 3D
  127. image. THIS PROGRAM DOES NOT HANG!!! When the graph is drawn, the veiwing
  128. angle can be changed by hitting the cursor keys. This has the effect of
  129. moving the corner of the net nearest to you 10° in the direction of the
  130. arrow on the cursor key. Recalculation takes about the same length of time
  131. as calculating the image the first time. The commonest problem people find
  132. when they use PLOT is they try to plot an enormous 3D plot, hit a few keys,
  133. wonder why nothing happens and then complain about the screen redrawing
  134. itself spontaneously a minute later. REMEMBER... YOU ARE ONLY RUNNING A
  135. 68000! IT TAKES A WHILE TO DO SEVERAL MILLION CALCULATIONS!!!
  136.  
  137.                 *******----->>>>  WAIT  <<<<-------*******
  138.  
  139.      After selecting any of the menu options you will need to hit a cursor
  140. key to redraw the graph with the new options. In this way, multiple new
  141. options may be included before redrawing. If you select the "Make CADFile"
  142. munu option, nothing will happen until after you quit the ThreeDPlot screen.
  143. The CAD file will then be written to the same directory that the data was
  144. obtained from. This again requires some calculation, so on returning to the
  145. PLOT window, WAIT UNTIL AFTER THE DISK IS ACCESSED if you have saved the
  146. graph before pushing any other buttons. The calculation and writing time
  147. is particularly long if writing in the DRAW format. For example a net plot
  148. with 10,000 intersections will take about HALF AN HOUR TO WRITE in Draw
  149. format. This is a problem with the Draw file format, and cannot be expected
  150. to improve dramatically in future releases.
  151.  
  152. SAVING DEFAULTS
  153.  
  154.     PLOT now supports saveable defaults. These are for the screen editor,
  155. mode (2D or 3D), and file format (Draw, IntroCAD or mCAD). If a file named
  156. Plot.def is in the PLOT: directory, this will always be used and cannot
  157. be overwritten. If you don't like these defaults, delete this file. On saving
  158. defaults, a file of the same name is written to the s: directory. This is
  159. the second location searched for the default file on starting up. To
  160. change these defaults, change the selections for editor, mode and file
  161. format and select Save Defaults from the Project Menu.
  162.     To change the editor, select Define Editor from the Edit menu. You will
  163. be presented with a box to write the name of the editor you prefer to use.
  164. You can include any command line arguments that the editor accepts between
  165. its name and the name of the file to be edited.
  166.  
  167. EGs:
  168.         ed                         use the WB editor
  169.         sys:system/Memacs          use this editor which is not in c:
  170.         DME -t46 -l0 -w640 -h124   use this editor with a nice sized window
  171.  
  172. After entering the editor and file path if not in the c: directory, plus
  173. any arguments if desired, click the use box. The newly selected editor will
  174. now be used for the rest of the session. To save the default for next time,
  175. select Save Defaults from the Project Menu, and ensure there is not a file
  176. called Plot.def in the PLOT: directory.
  177.  
  178.  
  179. CHANGING OUTPUT FILE FORMAT
  180.  
  181.     To change the file format your plot will be saved in, select the desired
  182. format from the Format Menu. This must be done before starting the plot.
  183. If you only use one CAD program, save this format as your default. The format
  184. which is active at the time of saving defaults is the one that will become
  185. your default format.
  186.  
  187. BITS AND PIECES
  188.  
  189. Please note the following:
  190.  
  191. #   Values along the axes are not saved in the CAD files. You will have to
  192.        them back in in a drawing program.
  193.  
  194. #   Draw output is currently only in one colour.
  195.  
  196. #   Neither Draw nor mCAD can be started by clicking on the project icons
  197.        of a saved file (Their fault, not mine). IntroCAD can.
  198.  
  199. #   In 2D Plots, the line between the second last and last data point is
  200.        not included in the saved file. This is to allow space between the
  201.        intended last point and the extra one you are all going to add to
  202.        the end of your data files to sit in the border. This is because the
  203.        border is drawn as close to the plotted data as possible and
  204.        obscures the last point and its error bar.
  205.  
  206. #   The IntroCAD format allows Quad density dot matrix printed output if
  207.        you own IntroCAD. The Draw format allows Laser printing if you own
  208.        a good DTP package.
  209.  
  210. #   Neither Professional Page nor PageStream handle Draw files with large
  211.        dimensions very well. If your dimensions are greater than 200 units,
  212.        these programs often scramble the data. Rescale your data to keep
  213.        within these limits if you wish to import to either of these
  214.        programs.
  215.  
  216. #   If you are not sure about how a feature works, test it out on a little
  217.        file first. Enormous plots look great but take an enourmous amount
  218.        of time to generate.
  219.  
  220. #   To get the hang of the program and its data file formats, have a look at
  221.        PLOT:data/graph2D and PLOT:data/graph3D, both supplied with PLOT.
  222.        For a thrill, plot PLOT:cos3D.
  223.  
  224. RELEASE HISTORY
  225.  
  226. Feb 1988  Batch file version.
  227. Feb 1989  First version of Plot. No file requester. IntroCAD only.
  228. Apr 1989  PLOT 1.0 released.
  229. Jun 1989  Added menus, definable editor, defaults, Draw and mCAD support,
  230.           changed to NTSC sized screen.
  231.  
  232. THANKS
  233.  
  234.      Thanks to Tim Mooney for writing MultiPlot, ThreeDPlot, IntroCAD
  235. and others, and for sending the source and suggestions freely. Thanks
  236. to Charlie Heath for the file requester, and to Graeme Riddle for testing
  237. and suggestions.
  238.  
  239.  
  240.     Bug finds and suggestions for PLOT to me at the above address. Source
  241. available on request. Praise for the programs Multiplot and ThreeDPlot
  242. to:
  243.  
  244.                              Tim Mooney
  245.                         5904 Vandegrift Ave.
  246.                         Rockville, MD 20851
  247.                                 USA
  248.  
  249.  
  250.  
  251.