home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d572 / multiplot.lha / Multiplot / Docs / MultiPlot.doc.orig < prev    next >
Text File  |  1991-12-22  |  6KB  |  178 lines
  1. ORIGINAL DOCUMENTATION INCLUDED TO ABIDE BY ORIGINAL COPYRIGHT RESTRICTIONS
  2.  
  3.                    Header added November 1989 AGB
  4.  
  5.  
  6.  
  7.  
  8. **************************************************************************
  9.  
  10.         MultiPlot
  11.         Copyright (C) 1987 Tim Mooney
  12.  
  13.         MultiPlot is in the public domain.  It is intended to
  14.         be available free to anyone who wants it.  You may use and
  15.         distribute it as you like with the following restrictions:
  16.  
  17.         1)  You may not sell this software or charge more than a
  18.             small copying/hassle fee for distributing it.
  19.  
  20.         2)  You may not remove this notice from the distribution.
  21.  
  22.                 Tim Mooney
  23.                 5904 Vandegrift Ave.
  24.                 Rockville, MD 20851
  25.  
  26. ****************************************************************************
  27.  
  28.         MultiPlot plots data embedded in a text file.  You tell MultiPlot in
  29. which "columns" to expect numbers to plot.  MultiPlot reads the file, looking
  30. for lines containing numbers in all of those "columns".  (The first word on a
  31. line is, by definition here, in "column" 1.) When such a line is found,
  32. MultiPlot begins to store the numbers in arrays.  If, while accumulating an
  33. array of data, a line is found which doesn't contain numbers in all the
  34. target "columns", the array is set aside and MultiPlot continues reading,
  35. looking for more data.  Any number of plots can be accumulated in this way.
  36. Numbers may be real, integer, or mixed.
  37.  
  38. ***************************************************************************
  39. CALLING UP THE PROGRAM
  40.  
  41.         MultiPlot is run from the CLI with the following command:
  42.  
  43. MultiPlot [flags] filename
  44.  
  45.         The flags tell MultiPlot where, in the file, to look for numbers it
  46. can plot.  Let's say the file to be plotted is called "plotme.dat", and
  47. the lines in this file which contain data look like:
  48.  
  49. x       y       err_in_y
  50. .       .       .
  51. .       .       .
  52. .       .       .
  53.  
  54.   Some command line examples for this file:
  55.  
  56. 1)      MultiPlot plotme.dat
  57.  
  58.       THIS TELLS MultiPlot TO USE DEFAULTS FOR THE COLUMN NUMBERS.
  59.    MultiPlot ASSUMES THE FIRST COLUMN IS X DATA, AND THE SECOND
  60.    COLUMN IS Y DATA.
  61.  
  62. 2)      MultiPlot -x1y2 plotme.dat
  63.  
  64.    THIS MEANS EXACTLY THE SAME THING AS (1)
  65.  
  66. 3)      MultiPlot -x1y2e3 plotme.dat
  67.  
  68.       THE FIRST COLUMN IS X DATA, THE SECOND IS Y DATA, AND THE
  69.    THIRD IS ERROR_IN_Y DATA.  (MultiPlot DOESN'T COLLECT
  70.    ERROR_IN_Y DATA UNLESS YOU TELL IT TO.)
  71.  
  72. 4)      MultiPlot -x0y1 plotme.dat
  73.  
  74.       HERE IS SOMETHING NEW.  THIS SAYS THAT X DATA ARE IN COLUMN
  75.    0.  THERE IS NO COLUMN 0, HOWEVER.  MultiPlot UNDERSTANDS
  76.    THAT THE FILE CONTAINS NO X DATA, AND USES LINE NUMBERS --
  77.    RELATIVE TO THE BEGINNING OF A LIST -- FOR X.
  78.  
  79. 5)      MultiPlot -e plotme.dat
  80.  
  81.       THIS USES A LOT OF DEFAULTS: X IS ASSUMED TO BE IN COLUMN 1
  82.    SINCE NO -X FLAG OCCURS; Y IS ASSUMED TO BE IN THE NEXT
  83.    COLUMN SINCE NO -Y FLAG OCCURS.  THE COMMAND LINE SAYS
  84.    THAT THE FILE CONTAINS ERROR_IN_Y DATA, BUT DOESN'T SAY
  85.    WHERE;  THE DEFAULT IS THE COLUMN AFTER THE Y DATA.  WE
  86.    COULD HAVE GOTTEN THE SAME RESULT WITH
  87.       "MultiPlot -x1y2e3 plotme.dat".
  88.  
  89.  
  90. **************************************************************************
  91. SPECIFYING THE DISPLAY OF COLLECTED DATA
  92.  
  93.         When the file has been read, MultiPlot tells you how many lists of
  94. numbers it found and asks how to plot the data.  You choose which lists and
  95. how the chosen lists are to be plotted.  For each list, you can choose a
  96. color or accept a default color.  You can choose a line plot, a point plot,
  97. or both for any list.  If your choice includes a point plot, you can choose a
  98. point size.  (Defaults exist for every choice.)
  99.  
  100.         The line of text you type to tell MultiPlot how to plot the data is
  101. called a "HowTo string".  The syntax is tersely described in the instructions
  102. you can get interactively by typing "?".  I'm not going to repeat all the
  103. details here, but I will give examples which can be used with the sample data
  104. file "plotme.dat".
  105.  
  106. 1)      carriage return
  107.  
  108.       THIS GETS A DEFAULT FOR ALL ACCUMULATED LISTS: LINE PLOTS IN
  109.    COLORS BEGINNING WITH 0 AND INCREASING.
  110.  
  111. 2)      !p
  112.  
  113.       THIS GETS A POINT PLOT FOR ALL LISTS.  THE POINT SIZE IS 4
  114.    (DEFAULT).  THE COLORS BEGIN WITH 0 AND INCREASE.
  115.  
  116. 3)      1p 2p 3p 4p
  117.  
  118.       THIS GETS POINT PLOTS FOR THE FIRST FOUR LISTS AND NO PLOT FOR THE
  119.    REST.  THE COLORS ARE 1 2 3 4.  THE POINT SIZE IS 4.
  120.  
  121. 4)      p1 p2 p3 p4
  122.  
  123.       THIS GETS POINT PLOTS IN DEFAULT COLORS FOR THE FIRST FOUR LISTS
  124.    AND NO PLOT FOR THE REST.  THE POINT SIZE IS 1 (MINIMUM) FOR THE
  125.    FIRST PLOT, 2 FOR THE SECOND...
  126.  
  127. 5)      1l 1l 1l 1l
  128.  
  129.       THIS GETS LINE PLOTS FOR THE FIRST FOUR LISTS AND NO PLOT FOR THE
  130.    REST.  ALL PLOTS ARE IN COLOR 1.
  131.  
  132. 6)      0p 1p 2p 3p 0l 1l 2l 3l
  133.  
  134.       THIS GETS POINT PLOTS FOR THE FIRST FOUR LISTS AND LINE PLOTS FOR
  135.    THE NEXT FOUR.  THE POINT SIZE IS 4 SINCE IT IS NOT SPECIFIED.
  136.    THIS IS MY PERSONAL FAVORITE FOR THIS FILE SINCE THE FILE
  137.    COMPRISES FOUR LISTS OF DATA AND FOUR LISTS OF FITS TO THAT DATA.
  138.  
  139. 7)      0p - - - 1l
  140.  
  141.       THIS GETS A POINT PLOT IN COLOR 0 OF THE FIRST LIST AND A LINE
  142.    PLOT IN COLOR 1 OF THE FIFTH LIST.  NO OTHER LISTS ARE PLOTTED.
  143.    THE POINT SIZE IS 4.
  144.  
  145.  
  146. 8)      - 0p - - - 1l
  147.  
  148.       THIS GETS A POINT PLOT FOR THE SECOND LIST AND A LINE PLOT FOR THE
  149.    SIXTH.  OTHERWISE, THIS IS THE SAME AS (7)
  150.  
  151.  
  152.         There are more things you can specify about the plot.  I went a
  153. little crazy putting in options and still there are things left out.
  154. This will get you started.
  155.  
  156.  
  157. **************************************************************************
  158. MENUS, ETC.
  159.  
  160.         Once you have a plot on the screen, you can zoom in and out, call up
  161. a crosshair, and generally have a splashing time peering at your data from
  162. close in, far away, etc.  Using the "Make PltFile" item from the "Project"
  163. menu, you can write the display to a file that can then be sent to a (HPGL)
  164. plotter via something like
  165.  
  166.         "COPY MYFILE.PLT0 TO SER:"
  167.  
  168.    You can also export the full plot to IntroCAD by a two-step process:
  169.  
  170. 1) Select "Make TXTFile" from the "Project" menu;
  171. This creates a file called (in the current example) "myfile.txt0", which is
  172. a text file that can easily be translated to an IntroCAD file.
  173.  
  174. 2) run txt_2_icad from the CLI with a command like:
  175.  
  176.         "txt_2_icad myfile.txt0 myfile.cad"
  177.  
  178.