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