home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 053.lha / Egraph / Egraph.doc < prev    next >
Text File  |  1986-11-20  |  7KB  |  194 lines
  1.  
  2. NAME
  3.  
  4.      egraph - a program to graph data
  5.  
  6.      AMIGA version Copyright © Laurence E. Turner 1986
  7.  
  8.      Permission is granted to any individual or educational institution
  9.      to use, copy, or redistribute this program so long as it is not 
  10.      sold and provided that the copyright notice and the UCEE graph 
  11.      logo are retained.
  12.      
  13.  
  14. SYNOPSIS
  15.  
  16.      egraph [-1] [-a] [-g] [-c | -l | -p] [ -h "graph header"]
  17.         [ -X | -x number ] [ -Y | -y number ] [-w] [ file1 ]
  18.         [ file2 ] [ file3 ] [ file4 ] [ file5 ]
  19.  
  20. DESCRIPTION
  21.  
  22.       Egraph was developed for use by students and staff of
  23.      the Department of Electrical Engineering at the University of
  24.      Calgary, Calgary, Alberta, Canada. It is used extensively for
  25.      both course work and research.  The original UNIX based 
  26.      version supports many different output devices including
  27.      pen plotters, graphics terminals and alphanumeric terminals.
  28.      The AMIGA version supports only the AMIGA display and printer.
  29.  
  30.      
  31.           Egraph reads pairs of x and y values from a list of files
  32.      and draws a formated graph.
  33.  
  34.           The default graph mode allows multiple curves to appear
  35.      on the same plot for comparison purposes.  Four unique curve
  36.      fonts are supported: solid curves, dashed curves, dotted curves
  37.      and long dashed curves.  The fonts are sequenced in the above
  38.      order, if more than four curves are to be drawn the above sequence
  39.      is repeated as many times as required.  For multiple curve plots
  40.      simply supply up to five  file name arguments to egraph. 
  41.  
  42.        The maximum number of data points is unlimited but faster
  43.      response time is possible if the number of data points less
  44.      than 400.
  45.  
  46. OPTIONS
  47.  
  48.            -1  one color plot enable (default is multicolor plot)
  49.        
  50.            -a  delete the labeled axis and inhibit auto scaling
  51.  
  52.            -g  draw a grid over the plotting region       
  53.  
  54.            -c  pole/zero plot mode, data points of first file
  55.                are plotted as crosses, of second file as
  56.                circles, data points of all following files are
  57.                connected with lines. (default is graph mode)
  58.            -l  connect all data points with lines (default is
  59.                graph mode)
  60.            -p  plot only data points (default is graph mode)
  61.  
  62.            -h  "title string in quotes" Places a title at
  63.                the bottom of the graph.
  64.  
  65.            -X  plot a standard log scale on the X (horizontal)
  66.                axis
  67.            -Y  plot a standard log scale on the Y (vertical)
  68.                axis
  69.            -x  convert X (horizontal) axis data to log scaling.
  70.                The number following -x is the log multiplier.
  71.                 (used for decibel scaling)
  72.                 ie.
  73.                    -x 20   >-performs->    20 * log10(X)
  74.            -y  convert Y (vertical) axis data to log scaling.
  75.  
  76.                The number following -y is the log multiplier.
  77.                 (used for decibel scaling)
  78.                 ie.
  79.                    -y 10   >-performs->    10 * log10(Y)
  80.  
  81.            -P  inhibit messages to standard error (Error messages
  82.                are not inhibited, info and warnings are).  This
  83.                was used to prevent message text from being sent
  84.                to an HPplotter.  If more than one option is chosen
  85.            This should be the first option in the option list.
  86.  
  87.            -w  Load "egraph.opt" file; All of the above options
  88.                can appear in this special file, plus the following
  89.            "n" (name axis) and "f" (force scale) options. 
  90.  
  91.                  n  label the graphs axis.  A prompt for the
  92.                     X axis string will appear, followed by a
  93.                     Y axis string prompt.  An axis string is
  94.                     terminated by a carrage return.
  95.            
  96.                  f  force scales to user defined values for the
  97.                     minimum and maximum of the X and Y axis.  Prompts
  98.                     will appear for the minimum, maximum, and number
  99.                     of major divisions for both the X and Y axis.
  100.                     if the the number of divisions for either the X
  101.                     or the X axis is zero, then auto scaling for
  102.                     that axis is re-enabled.
  103.  
  104.            The format for each option in this file is
  105.                   (each option appears on it's own line):
  106.  
  107.                   h "title string in quotes"
  108.                   n "X axis label" "Y axis label"
  109.                   l
  110.                   p
  111.                   c
  112.                   x number
  113.                   y number
  114.                   X
  115.                   Y
  116.                   g
  117.                   P
  118.                   1
  119.                   a
  120.                   f Xlow Xhigh numb_X_div Ylow Yhigh numb_Y_div
  121.  
  122.                  (note that `w' may NOT appear in this option
  123.                  file)
  124.  
  125.      EXAMPLE OF AN "egraph.opt" FILE
  126.         (everything between the arrows, not including the arrows,
  127.      must exist in the file)
  128.  
  129.       ->
  130.       h "Magnitude response of a 10rd order butterworth filter"
  131.       n "FREQUENCY in Hz" "MAGNITUDE in dB"
  132.       X
  133.       y 20
  134.       g
  135.       <-
  136.  
  137. FILES MENU
  138.  
  139.     Input data is read and graphed using file names defined by:
  140.  
  141.         current files:    Data file name(s) previously entered
  142.                 either from the command line or using
  143.                 the "new files" menu.
  144.         new files:    Using a requester, enter or modify
  145.                 the input file name(s).
  146.  
  147.     The "save menu" item, when selected saves the current options
  148.     in the file egraph.opt ( in the current directory).
  149.  
  150.     The "about egraph" menu item displays information about egraph.
  151.  
  152. OPTIONS MENU
  153.  
  154.     This menu allows all of the options described above for the
  155.     command line interface to be entered using the menu.
  156.  
  157. PRINTER MENU
  158.  
  159.     Two screendump modes are supported:
  160.  
  161.         autosize:    The aspect ratio is retained while
  162.                   using the complete page width.
  163.         one-to-one:    Each screen pixel is mapped to a 
  164.                 printer pixel.
  165.     
  166.     The printer preferences should be set to:
  167.  
  168.         Threshold  8
  169.         Negative Image
  170.         Black and White
  171.     
  172. VERSIONS        
  173.  
  174.      There is also a UNIX version of egraph called piped.egraph which
  175.      does the same thing as egraph but the input file is piped to
  176.      it ( for use with applications programs). A multiple graph UNIX
  177.      version of egraph (called mgraph)is also available.
  178.  
  179.                                 
  180. AUTHORS
  181.         K. Jorgensen, L.E. Turner, M.R. Smith
  182.     Department of Electrical Engineering,
  183.     The University of Calgary,
  184.     Calgary, Alberta, Canada  T2N 1N4
  185.  
  186. BUGS
  187.     For further information on egraph or to report bugs,
  188.     write to:
  189.         
  190.         Laurence Turner
  191.         Department of Electrical Engineering
  192.         The University of Calgary
  193.         Calgary, Alberta, Canada  T2N 1N4
  194.