home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / plot / cgplt.arc / CGPLT.DOC < prev    next >
Text File  |  1987-05-17  |  18KB  |  791 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.                                         CGPLT
  20.  
  21.                                COLOR GRAPHICS PLOTTER
  22.  
  23.                                     VERSION  3.00
  24.  
  25.  
  26.                                     USER's GUIDE
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                                                               Steven Murphy
  46.                                                        4784 Bermuda Ave  #H
  47.                                                  San Diego, CA 92107 - 3862
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.                                  UPDATE  INFORMATION
  82.  
  83.  
  84.  
  85.  
  86.  
  87.                Version 3.00 has many improvements over the 2.XX versions.
  88.  
  89.           Most notably is the addition of Bar Graphs.  The speed at which
  90.  
  91.           it runs has also been increased and two more point indicators
  92.  
  93.           have been added.  As for input files and saved screen plot there
  94.  
  95.           are no incompatibilities between older versions and version 3.00.
  96.  
  97.  
  98.  
  99.                Things for the future (if there is enough interest) include:
  100.  
  101.           log scales and hopefully a printer driver.
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                          ii
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.                                   TABLE OF CONTENTS
  139.  
  140.  
  141.           User Supported Software  ...............................    iv
  142.  
  143.           System Requirements  ...................................    1
  144.  
  145.           Backing up CGPLT .......................................    1
  146.  
  147.           Getting Started  .......................................    1
  148.  
  149.           Hard Copies  ...........................................    2
  150.  
  151.           F1   ...................................................    2
  152.  
  153.           Alt - A  ...............................................    2
  154.  
  155.           Alt - C  ...............................................    2
  156.  
  157.           Alt - E  ...............................................    2
  158.  
  159.           Zooming  ...............................................    3
  160.  
  161.           Limitations of CGPLT ...................................    3
  162.  
  163.           Some General Hints  ....................................    4
  164.  
  165.           Let's do an Example  ...................................    5
  166.  
  167.           One Catch   ............................................    7
  168.  
  169.           Disclaimer  .............................................   8
  170.  
  171.           Copy Permission  ........................................   8
  172.  
  173.           Update Info  ............................................   8
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                          iii
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.                                User-Supported Software
  207.  
  208.  
  209.              You're encouraged to copy and share this diskette with others.
  210.  
  211.  
  212.                If after evaluating this program you find it to be useful,
  213.           a $5.00 -> $10.00 donation to:
  214.  
  215.                                      S. Murphy
  216.                                      4784 Bermuda Ave.  #H
  217.                                      San Diego, CA  92107 - 3862
  218.  
  219.           would be a nice gesture.
  220.  
  221.                User-supported software is an experiment in distributing
  222.           computer programs, based on these beliefs:
  223.  
  224.           I.
  225.                   That the value and utility of software is best assessed
  226.           by the user on his/her own system.
  227.  
  228.           II.
  229.                   That the creation of personal computer software can and
  230.           should be supported by the computing community.
  231.  
  232.           III.
  233.                   That the copying of programs should be encouraged, rather
  234.           than restricted.
  235.  
  236.  
  237.                Anyone may legally obtain an evaluation copy of the program
  238.           from a friend or computer club.  After you've had a chance to use
  239.           and evaluate the program in your own environment, you're trusted
  240.           to either forward a payment to the author, or to discontinue use
  241.           of the program.  In either case, you are encouraged to let others
  242.           copy the program for evaluation.
  243.  
  244.                Free distribution of software and voluntary payment for its
  245.           use, eliminates costs for advertising and copy protection
  246.           schemes. Users obtain quality software at greatly reduced cost.
  247.           They can try it out before buying, and do so at their own pace
  248.           and in the comfort of their own home or office.  Naturally the
  249.           best programs will survive, based purely on their quality and
  250.           usefulness.
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.                                          iv
  261.  
  262.  
  263.  
  264.  
  265.  
  266.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         1
  267.  
  268.  
  269.  
  270.  
  271.                             CGPLT  (Color Graphics Plotter)
  272.  
  273.  
  274.           REQUIREMENTS
  275.  
  276.                This program requires 256k an a color graphics adapter.  It
  277.           was written on an IBM compatible.
  278.  
  279.  
  280.  
  281.           BACKUP
  282.  
  283.                As with all software you should make a backup copy of it for
  284.           actual use and tuck the original away for safe keeping.  My
  285.           suggestion for getting the most out of this program is to create
  286.           a disk with system on it (you can use the FORMAT /S command or
  287.           the SYS command).  Then copy GRAPHICS.COM from your DOS disk to
  288.           the disk you just put system on.  Now copy CGPLT.EXE to disk (to
  289.           do the examples copy CGPLT?.* and you will have all the files).
  290.  
  291.  
  292.  
  293.           GETTING STARTED
  294.  
  295.                The next step is to create some data for plotting.  This
  296.           program was originally written to display the solution to
  297.           computer simulations.  This is what is meant by have a program
  298.           generate the data file in method A.  Plotting is also used for a
  299.           host of other things so method B is given as a quick and easy way
  300.           of entering data points.  The two methods are described as
  301.           follows :
  302.  
  303.  
  304.                     A]   Have the program that is going to generate
  305.                          the data points OPEN a sequential output file.
  306.                          Then have the program write the X,Y points, with
  307.                          one set to a line, to the file separating X & Y
  308.                          with either a comma or several spaces.
  309.  
  310.  
  311.                     B]   Type  " copy con: [d:][path] {filename.ext}  <CR>
  312.                          ", you should now be on a blank line.  Enter your
  313.                          data points one set to a line, X Y, separating
  314.                          them with a comma or blank spaces followed by a
  315.                          <CR> (NOTE: Do Not use the <Tab> key to insert the
  316.                          spaces).  When they are all entered and you are on
  317.                          the blank line just below your last point hold
  318.                          down the <Ctrl> key and type " Z ".  You should
  319.                          see " ^Z ".  Now type " <CR> ".  The computer
  320.                          should respond with " 1 File copied " followed by
  321.                          the DOS prompt.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         2
  333.  
  334.  
  335.  
  336.           HARD COPIES
  337.  
  338.                Now before you actually plot you should decide if you want a
  339.           hard copy or not. If you would like a hardcopy of the plot turn
  340.           on your printer and type GRAPHICS at the dos prompt, then hit
  341.           <CR>.  This will allow you to do a screen dump by hitting SHIFT-
  342.           PRTSC after the plot is made.
  343.  
  344.  
  345.                If you just want to view the plot or to save the screen
  346.           image for future recall you don't have to bother with GRAPHICS.
  347.           Now your ready to start CGPLT.  At the DOS prompt type CGPLT and
  348.           hit <CR> and you will see my opening message about User-Supported
  349.           Software.  After you're done reading it just hit the space bar to
  350.           continue.  The program will now ask you a series of questions
  351.           about how you want things plotted.
  352.  
  353.  
  354.                Once the plot is on the screen the following keys apply:
  355.  
  356.           F1
  357.  
  358.                F1 brings up a help screen that list the keys that are
  359.           active and gives you a reminder as to what the numbers mean when
  360.           you are choosing options for plotting a file.
  361.  
  362.  
  363.           Alt - A
  364.  
  365.                If you decide you would like to change some thing in a plot
  366.           you just made type " <Alt>-<A>" this will put you back at the
  367.           Choose Data menu of the program so you can select a different set
  368.           of files to be plotted.
  369.  
  370.  
  371.           Alt - C
  372.  
  373.                To change one or more of the files you are plotting or the
  374.           attributes they are plotted with use " <Alt>-<C> ".  This puts
  375.           you in the Change Data menu which will let you change files,
  376.           replace files, or add files if you have less than five read in at
  377.           the moment.
  378.  
  379.  
  380.           Alt - E
  381.  
  382.                If you would like to quit type " <Alt>-<E> " for Exit and
  383.           you should be back at the DOS prompt.
  384.  
  385.  
  386.  
  387.  
  388.           ZOOMING
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         3
  399.  
  400.  
  401.  
  402.                The ability to input the axes limits allows the user to zoom
  403.           in or out on any given plot.  Example: if after making a plot you
  404.           decide that only a certain part of the graph is what you are
  405.           truly interested in, look at the axes and determine the values
  406.           that the important part falls within.  Now type Alt-A (for Again)
  407.           and select the same files you did last time only this time when
  408.           the prompt comes up for autoscale or user input limits, select
  409.           user input limits and enter the limits of interest.  The plotting
  410.           time will be the same as before because CGPLT always plots all
  411.           the points (it clips what every falls out side the plotting
  412.           window) but now you will only see the part you were interested
  413.           in.
  414.  
  415.  
  416.           LIMITATIONS
  417.  
  418.                Some notes on the limits of CGPLT.
  419.  
  420.                1)  CGPLT can plot up to 5 curves (bar or line or a mix of
  421.                    both) on a single graph.
  422.  
  423.                2)  It will only read up to the first 500 points out of each
  424.                    data file.
  425.  
  426.                3)  It will save created plots to disk in binary form for
  427.                    faster recall.
  428.  
  429.                4)  The Y axis can be inverted but not the X axis.
  430.  
  431.                5)  If you try to temporarily SHELL to DOS and CGPLT can not
  432.                    find COMMAND.COM you will get ERROR 05 and the program
  433.                    will terminate.
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         4
  465.  
  466.  
  467.  
  468.           SOME GENERAL HINTS
  469.  
  470.                       If you know you are going to have a file longer than
  471.                    500 points make your program write it into several files
  472.                    that are no more than 500 points long.  This way you can
  473.                    plot all the pieces on a single graph and have your
  474.                    continuous curve up to 2,500 points long.  If you
  475.                    already have a file longer than 500 points you can
  476.                    always use an editor to cut it into 500 point chunks for
  477.                    plotting.
  478.  
  479.                       One point to consider is that the region for the
  480.                    graph is approximately 519 pixels across so unless your
  481.                    curve does a lot of vertical traveling you gain very
  482.                    little additional accuracy for a lot more work by going
  483.                    over 500 points per curve.
  484.  
  485.                       Bar graphs are even more limited than line plots.
  486.                    In my testing of CGPLT it was found that if you go much
  487.                    over 30 bars per graph it is hard to distinguish the
  488.                    boundaries of any given bar because they become too
  489.                    closely packed.
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         5
  531.  
  532.  
  533.           LET'S DO AN EXAMPLE
  534.  
  535.  
  536.                Included with CGPLT.EXE and CGPLT.DOC are CGPLT.DAT and
  537.           CGPLT2.DAT.  These two files are used in the following example:
  538.  
  539.                dos prompt> CGPLT <CR>
  540.  
  541.                     my opening statement
  542.  
  543.                SPACEBAR
  544.  
  545.                     what keys are used by CGPLT
  546.  
  547.                SPACEBAR
  548.  
  549.                     option menu
  550.  
  551.                1 <CR>
  552.  
  553.                     color graphics plotting routine
  554.  
  555.                CGPLT.DAT <CR>          1<CR>      0<CR>
  556.                <CR>
  557.  
  558.                     reading points
  559.                     how many files to include in this plot
  560.  
  561.                1<CR>
  562.  
  563.                     file number
  564.  
  565.                1<CR>
  566.  
  567.                     axis scaling
  568.  
  569.                2<CR>
  570.  
  571.                     y-axis label
  572.  
  573.                Y | AXIS <CR>
  574.  
  575.                     x-axis label
  576.  
  577.                X - AXIS <CR>
  578.  
  579.                     title label
  580.  
  581.                CGPLT EXAMPLE <CR>
  582.  
  583.                     graph appears
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         6
  597.  
  598.  
  599.  
  600.                ALT-C
  601.  
  602.                     which to change/replace
  603.  
  604.                2<CR>
  605.                CGPLT2.DAT<CR>           4<CR>               0<CR>
  606.  
  607.                     reading points
  608.                     change/replace another
  609.  
  610.                N<CR>
  611.  
  612.                     how many files to include in this plot
  613.  
  614.                1<CR>
  615.  
  616.                     file number
  617.  
  618.                2<CR>
  619.  
  620.                     axis scaling
  621.  
  622.                2<CR>
  623.  
  624.                     y-axis label
  625.  
  626.                Y | AXIS <CR>
  627.  
  628.                     x-axis label
  629.  
  630.                X - AXIS <CR>
  631.  
  632.                     title label
  633.  
  634.                CGPLT EXAMPLE 2 <CR>
  635.  
  636.                     graph appears
  637.  
  638.                ALT-E
  639.  
  640.                     you are now back at the dos prompt
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         7
  663.  
  664.  
  665.  
  666.           ONE CATCH
  667.  
  668.                I have done my best to test this program for bugs and have
  669.           not found any so far.  This of course does not mean that no one
  670.           else will.
  671.  
  672.                In testing it with a lot of odd cases I have found one
  673.           catch.  The catch goes like this :
  674.  
  675.                If your data has a large offset in the points CGPLT may
  676.           round off your tic mark values.  What is meant by a large offset
  677.           is when N >> delta N.  Which is shown in the following example :
  678.  
  679.                               X              Y
  680.                            --------       ---------
  681.                               1           100000.4
  682.                               2           100000.3
  683.                               3           100000.2
  684.                               4           100000.1
  685.  
  686.                In the above data points  X is of the same order of
  687.           magnitude as delta X but, Y is 6 orders of magnitude greater than
  688.           delta Y.  So when CGPLT numbered the tics it would round off the
  689.           last digit where the change is occurring.  One solution to this
  690.           problem is subtract a constant from your data.  Which for my
  691.           example means you should plot:
  692.  
  693.                               X              Y
  694.                            --------       ---------
  695.                               1             0.4
  696.                               2             0.3         Y-axis + 100000.0
  697.                               3             0.2
  698.                               4             0.1
  699.  
  700.                Now delta Y is also of the same order as Y.  To show the
  701.           correction that was made only requires making a small note on the
  702.           appropriate axis to add the constant to the displayed values.
  703.           This catch can occur on either or both of the axes depending on
  704.           your data.  In general though most users will probably never
  705.           encounter this quirk.
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.  
  723.  
  724.  
  725.  
  726.  
  727.  
  728.         CGPLT    Version 3.00    Copyright 1987       S. Murphy         8
  729.  
  730.  
  731.  
  732.  
  733.           DISCLAIMER
  734.  
  735.                Users of CGPLT do so at their own risk.  The author is not
  736.           responsible for the users use, misuse, or abuse of CGPLT.  Users
  737.           are entirely responsible for the loss or damage of any kind
  738.           caused by CGPLT.
  739.  
  740.  
  741.           COPY PERMISSION
  742.  
  743.                Individuals and Computer clubs (non-profit) are granted
  744.           permission by the author to copy the CGPLT diskette for their own
  745.           use or for others to evaluate, so long as no price or other
  746.           consideration is charged besides a handling and disk charge of no
  747.           more than $6.00.  The program and/or documentation may not be
  748.           modified in any way and are to be distributed together.
  749.  
  750.  
  751.  
  752.                If you find any bugs or have any suggestions or criticisms
  753.           please feel free to write me at :
  754.  
  755.  
  756.  
  757.                                S. Murphy
  758.                                4784 Bermuda Ave  #H
  759.                                San Diego, CA  92107 - 3862
  760.  
  761.  
  762.           UPDATE INFO
  763.  
  764.                For those who contribute $10.00 or more and send a 5 1/4"
  765.           disk with a self addressed stamped envelope I will send them an
  766.           update or if they request a copy with out the opening screen and
  767.           the key def screen suppressed if they wish.  I only ask that the
  768.           copies with the opening screen removed not be distributed.  One
  769.           final point, for those contributor mentioned above I do have a
  770.           copy of the current version that supports 8087/80287 NCP this
  771.           copy is approximately 7K smaller than the version that emulates
  772.           the 8087/80287 NCP and run faster (at least for the 8087).
  773.  
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.