home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 200-299 / ff292.lzh / MultiPlot / Docs / Multiplot.doc < prev    next >
Text File  |  1989-12-10  |  10KB  |  245 lines
  1.  
  2.                           MULTIPLOT XLN
  3.  
  4. This is program placed in the Public Domain for free use WITH THE
  5.        SPECIFIC EXCEPTION OF REDISTRIBUTION FOR PROFIT.
  6.                             November 1989
  7.  
  8.                    Walter & Eliza Hall Institute,
  9.               c/o PostOffice, Royal Melbourne Hospital,
  10.                       Parkville 3053. VICTORIA
  11.  
  12. This is the first release of Multiplot XLN. It is expected to
  13. receive distribution via Fred Fish. If you notice any repeatable
  14. bugs or have any suggestions for improvement of enhancement,
  15. please send them to me at the address below.
  16.  
  17. This release includes the Plt: device. The inclusion of this program
  18. does not in any way effect or imply distribution conditions.
  19. The distribution conditions of the Plt: device are described in the file
  20. Plt.doc.
  21.  
  22.  
  23. HISTORY
  24.  
  25. Multiplot was originally written by Tim Mooney as a plotting
  26. utility for use with mCAD, his freeware CAD program. It supported
  27. a flexible input textfile format, many plotting options, and HPLG
  28. plotter output. It was not an intuitive program, and its full
  29. power was difficult to realise. It was also very limited in
  30. output formats and had no support for printers.
  31.  
  32. Some of these problems were addressed in PLOT, an intuition
  33. interface which created an environment from which Multiplot and a
  34. collection on conversion files could be called. However the major
  35. problem of a non-intuitive way of selecting plotting options
  36. remained (the "get how to" window), and it was not possible to
  37. print output from within the program.
  38.  
  39. Multiplot XLN resolves these problems.
  40.  
  41. SUMMARY
  42.  
  43. Multiplot XLN is a fully intuitive data plotting program. It
  44. plots data points as (x,y) coordinates with or without error
  45. bars. It can plot multiplot sets of data points using colour or
  46. point size to represent the deferent sets. A set may be joined by
  47. a line or plotted as discrete points. The input file for
  48. multiplot is a simple textfile and my be created in the NotePad.
  49. Output may be in any of the following formats: IntroCAD, Draw,
  50. mCAD, IFF, HPLG. The graph can be printed to any workbench
  51. printer by transparent use of the PLT: device.
  52.  
  53.  
  54. REQUIREMENTS
  55.  
  56. Workbench 1.3 (or higher) and maths libraries, the PLT: device
  57. (plt-handler in l: and the mountlist for plt added to the devs:
  58. mountlist), at least 1Mb RAM. The files Multiplot, txt_2_icad and
  59. plot2draw must be kept together in the same directory. Text on
  60. screen currently uses Times.font sizes 14 and 24 point. If these
  61. fonts are absent, the default font will be used.
  62.  
  63.  
  64. INPUT FILE FORMAT
  65.  
  66. Multiplot accepts a simple ascii file for input of data. The data
  67. must consist of columns of numbers. Text heading the file will be
  68. ignored with the exception of lines beginning with:
  69.  
  70. *TITLE*   Text will be used for a title.
  71. *XLABEL*  Text will be used for a label on X axis.
  72. *YLABEL*  Text will be used for a label on Y axis.
  73.  
  74. Blank lines or lines of text interrupting the columns of
  75. numbers are interpreted as separating sets of data, and each set
  76. will be plotted individually in, for example, a different colour
  77. or point size.
  78.  
  79. See plotme.dat or eric for examples of input file format.
  80.  
  81.  
  82. STARTING OUT
  83.  
  84. From the CLI:  > multiplot [filename]
  85. Type multiplot with or without the filename of the input data
  86. file. If a '?' is used as an argument, a simple description of
  87. usage is given.
  88.  
  89. From the Workbench: Double click on the Multiplot icon OR
  90. Edit your input file in a simple editor (NotePad will do fine),
  91. and save with an icon. You can then change the file's default
  92. tool (INFO from the lefthand Workbench menu) to
  93. Multiplot:Multiplot or whatever the file path is. Multiplot will
  94. then be automatically invoked when the file is double clicked. An
  95. alternative to this is to not change the file's default tool, but
  96. to click on the file to highlight it hold the shift key down, and
  97. then double click on the Multiplot icon. It doesn't matter if you
  98. get them around the wrong way.
  99.  
  100. THE DATA SELECTION WINDOW
  101.  
  102. After being started, Multiplot tries to work out whether it is on
  103. a PAL or NTSC machine, and opens a screen of the appropriate
  104. size. The next thing you see is the DATA SELECTION WINDOW. If you
  105. started Multiplot by telling it what file you wanted to plot, the
  106. file's name will be in a little box. Sometimes if the name is
  107. very long, the box is empty. Don't worry, Multiplot still knows
  108. what you want. If you started Multiplot without telling it what
  109. file you want, the default file name will appear in the box. The
  110. PATH button will call up a file requester to help with browsing
  111. directory trees looking for wanted data files. Beneath the file
  112. selection box are three other boxes to indicate what column the
  113. X, Y and Error values are in. A '0' indicates values are absent.
  114. For example if the Error box has a '0', no error bars will be
  115. plotted. If the X box has a '0', unit increases in the X values
  116. will be assumed. When satisfied with the file and column
  117. specification, hit the return key or click on the Continue=>
  118. arrow.
  119.  
  120. THE HOW TO PLOT WINDOW
  121.  
  122. The HOW TO PLOT window is the first level of choosing plot
  123. options. In this window you may turn the error bars on (if
  124. available) or off, turn a cross grid on of off, and choose the
  125. number of tic marks along the X and Y axes. You can also choose
  126. to have the data plotted in either default points (all sets
  127. plotted as points, each in a different colour) or lines. If you
  128. wish to specify plotting options for each data set individually,
  129. click off the default plot. Hit the Continue=> button when happy
  130. with you selections. If a default plot was chosen, you will pass
  131. straight to the screen plot. If not the next window is the CUSTOM
  132. PLOT window.
  133.  
  134. THE CUSTOM PLOT WINDOW
  135.  
  136. This is the next level in choosing plot options. For each data
  137. set for plotting, this window will appear to allow you to select
  138. plot colours, whether line or point, and if point, point size.
  139. For example, in the example plot supplied, the first four data
  140. sets are raw experimental results. The next four data sets are
  141. the curve fits provided by another program. In this case, it is
  142. appropriate to plot the first four data sets as points with error bars, with each data set in a different colour. This is achieved
  143. by leaving the DEFAULT selector ON, an clicking the LINE/POINT
  144. selector to point. Click on the Continue=> button four times to
  145. accept point plots with cycling colours. For the fifth data set,
  146. change the default selector to OFF, choose colour '8' (grey) and
  147. change the LINE/POINT selector to LINE. Accept this choice for
  148. the remaining four data sets by clicking on the Continue=> button
  149. four times. The plot will now be rendered on the screen.
  150.  
  151. THE PLOT WINDOW
  152.  
  153. The PLOT window fills the entire high resolution screen and
  154. contains a hand crafted menu for your computing pleasure. The
  155. menus available are PROJECT which relates to the loading, saving
  156. and printing or plots, EDIT which allows modification of the
  157. plot, resizing, shifting and zoom, and the OPTIONS menu which
  158. changes the boarder colour, turns the axes, grid and cross hair
  159. on or off and returns you to the HOW TO PLOT window. The major
  160. menu items are described below.
  161.  
  162. NEW
  163.  
  164. Returns you to the DATA SELECTION window for loading a new file.
  165. You will NOT be prompted by a requester asking if you really
  166. REALLY want to restart. This is because 1) You almost certainly
  167. do. and 2) You don't actually loose very much even if you didn't.
  168.  
  169. SAVE
  170.  
  171. Plots may be saved in any of the following formats: IFF (loads
  172. into DPaint), Draw (loads into Draw2000 etc), IntroCAD (an
  173. excellent CAD program), mCAD (a PD CAD program), and HPLG plotter
  174. language. Please note the following restrictions: Currently Draw,
  175. IntroCAD, and mCAD saves do not include the numbers or labels on axes.
  176. You will need to jot these down when saving in these formats. A
  177. Draw save does not include information for the colours. Data is
  178. saved in a single colour. Draw saves require the program
  179. Plot2Draw to be in the same directory as Multiplot. IntroCAD
  180. saves require the program Txt_2_Icad to be in the same directory
  181. as Multiplot. Hopefully, some of these restrictions will be
  182. addressed in later releases of Multiplot.
  183.  
  184. Please Note:
  185. #   Neither Professional Page nor PageStream handle Draw files with large
  186.     dimensions very well. If your dimensions are greater than 200 units,
  187.     these programs often scramble the data. Rescale your data to keep
  188.     within these limits if you wish to import to either of these
  189.     programs.
  190.  
  191.  
  192. PRINT
  193.  
  194. Printing is achieved via the transparent use of the PLT: device.
  195. The plt-handler must be in your l: directory, and the PLT:
  196. mountlist must be added to your DEVS:mountlist. You do not need
  197. to mount the device. Multiplot will mount PLT: automatically if
  198. it is not already mounted. Currently printed copy does not include
  199. labels on the axes, but does include values.
  200.  
  201. QUIT
  202.  
  203. Quit does the obvious, with the same restrictions noted in the
  204. section on NEW.
  205.  
  206. ZOOM
  207.  
  208. Allows closeup views of areas of the data. Overzealous use results
  209. in an interesting red and black logo at the top of the screen.
  210. It is safe if you are sensible.
  211.  
  212. LOCKS
  213.  
  214. Allows either the X or Y dimension to be frozen while the other
  215. is zoomed or rescaled. very useful when used in conjunction with
  216. the other items in this menu (Zoom, Slide, FullPlot).
  217.  
  218. OPTIONS
  219.  
  220. Best left to exploration.
  221.  
  222. THE FUTURE
  223.  
  224. Probable enhancements to come are: coloured colour selecter, example
  225. point sizes in the point selecter, user definable on screen fonts,
  226. printed and saved output of screen text, colour for Draw saves and
  227. bar graphs. Suggestions welcomed.
  228.  
  229. CONCLUSION
  230.  
  231. Multiplot is the first intuitive Data plotting program for the
  232. Amiga. It allows extremely rapid visualisation of experimental
  233. data with a wide selection of output formats. It does a simple
  234. job, but does it well. If you have suggestions, questions, bug
  235. finds or are just feeling lonely (!), please write:
  236.  
  237. Dr Alan G Baxter,
  238. Walter & Eliza Hall Institute,
  239. c/o Post Office, Royal Melbourne Hospital,
  240. Parkville 3053,
  241. AUSTRALIA
  242.  
  243. Thanks to Tim Mooney for the great code, and Graeme Riddle for
  244. testing.
  245.