home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 6 / FreshFish_September1994.bin / bbs / misc / gfft-1.12.lha / GFFT / README < prev    next >
Text File  |  1994-08-29  |  18KB  |  377 lines
  1.                   Welcome to GFFT
  2.                   ------- -- ----
  3.  
  4.         This is the general readme file, which contains background
  5.     information about the GFFT program and directions to the other
  6.     documentation files included with GFFT.
  7.  
  8.         Before running GFFT on your Amiga system, read the file named
  9.     INSTALLATION.  If you experience problems while running GFFT, see
  10.     the file named Bugs.  If you would like to read about how to use
  11.     GFFT, you can read the file named GFFT.HELP, which is also used by
  12.     GFFT to display help messages.  After installing GFFT according to
  13.     the instructions, you can get help while running GFFT either from
  14.     the Workbench or from the CLI.
  15.  
  16.         If you want further information about the GNU General Public
  17.     License which applies to GFFT and the specific rights it gives you
  18.     to modify and distribute GFFT, or the no-warranty disclaimer which
  19.     applies to it, refer to the file named COPYING.
  20.  
  21.         Though GFFT is copyrighted under a General Public License and
  22.     the author respects and agrees with the ideas of the Free Software
  23.     Foundation, GFFT is not currently part of project GNU.  So please
  24.     direct any inquiries about the program itself to the author, and
  25.     not the Free Software Foundation.
  26.  
  27.         The most important files in this archive are provided with
  28.     icons so you can use them from the Workbench.  Two files not
  29.     provided with icons are the the Product-Info and History files.
  30.  
  31.  
  32.                GFFT README TABLE OF CONTENTS
  33.  
  34.     Preface
  35.     1.  What is GFFT?
  36.     2.  Who wrote GFFT?
  37.     3.  Where do I report bugs or make suggestions?
  38.     4.  How can I support the development of GFFT?
  39.     5.  How can I contribute code, beta-testing, and/or usage stories?
  40.     6.  What is the 'Share the Wealth' program?
  41.     7.  What if I want a specific enhancement now?
  42.     8.  What is a 'Contingent Donation'?
  43.     9.  What are my rights to use, modify, and distribute GFFT?
  44.     10.  The trademark and copyright statement
  45.  
  46.  
  47.     1.  What is GFFT?
  48.  
  49.         GFFT is an FFT-based spectrum analysis program with many
  50.     features.  By operating from stored sample data files, it offers
  51.     higher resolution and/or accuracy than real-time analyzers.  It
  52.     accepts 8, 12, or 16-bit data in in IFF 8SVX, AIFF, and AVR
  53.     formats, or in unformatted files, and can accept data points
  54.     entered through a console in floating point.
  55.         
  56.         GFFT can be operated from either a Workbench GUI or from a CLI
  57.     in interactive or batch modes.  It has built-in help facilities for
  58.     all operating modes with a 170+ Kb help file.
  59.  
  60.         GFFT can produce high quality spectrum plots on screen,
  61.     plotter, or printer, or save to Postscript or TeX files, or output
  62.     spectral data in text form to a console or file.  (GNUPLOT, a
  63.     separate program by other authors, is required for plotting
  64.     features.  GFFT is designed to invoke and control GNUPLOT
  65.     automatically.)  It can plot in 2D (Amplitude vs Frequency), or 3D
  66.     (Amplitude vs Frequency vs Time).  It allows the selection of
  67.     logarithmic X and/or Y axes, the dB scaling of X, and arbitrary 3D
  68.     rotation.  GFFT can show multiple spectra in the same plot, or
  69.     append spectral data bands from earlier sessions.
  70.  
  71.         GFFT provides 8 selectable FFT window types, including
  72.     Blackman-Harris 92 dB.  It can apply a special weighting for pink
  73.     noise testing.  Smoothing, calibration, ranging, and quantization
  74.     are also available.  There are no arbitrary limits to the number of
  75.     frequency bins or smoothing points, or to the length of data which
  76.     can be analyzed.
  77.  
  78.         GFFT is intended to be fairly universal in nature.
  79.     Furthermore, since it is provided under a GNU General Public
  80.     License and distributed with source code, a user with an
  81.     understanding of programming can adapt it to more specialized
  82.     requirements.  (I may also be able to help; see below.)
  83.  
  84.         Note that I am neither a mathematician nor a numerical analyst,
  85.     and while I have attempted to use well proven techniques when they
  86.     are known to me, some aspects of GFFT have been developed in an
  87.     ad-hoc fashion.  Thus, GFFT (and all the code provided with GFFT)
  88.     is not intended for use in applications such as engineering or
  89.     national defense or any application where inaccuracy could endanger
  90.     life or property.  There is ABSOLUTELY NO WARRANTY, express or
  91.     implied, concerning the performance or accuracy of GFFT.  The
  92.     general no-warranty disclaimer is given in the file named COPYING
  93.     which should be included with this distribution.
  94.  
  95.  
  96.     2.  Who wrote GFFT?
  97.  
  98.         GFFT was written by Charles P. Peterson.  (This is the first
  99.     released version for which there were no other contributors.)  The
  100.     sources of the ideas and algorithms in GFFT are too numerous to
  101.     mention here; some are mentioned in the code itself, some are in
  102.     the GFFT.HELP file and may be displayed using the help facilities
  103.     of GFFT.
  104.  
  105.  
  106.     3.  Where do I report bugs or make suggestions?
  107.  
  108.         Please report bugs, enhancement requests, etc., to me,
  109.     Charles P. Peterson, 4007 Enchanted Sun, San Antonio, Texas
  110.     78244-1254.  My current e-mail address is: 
  111.  
  112.             Charles_P_Peterson@fcircus.sat.tx.us
  113.  
  114.         Please include a description of how you use GFFT or would like
  115.     to use it.
  116.  
  117.         If you cannot contact me at the above address(es), a more
  118.     recent address might be available in a later distribution available
  119.     through Fish, AMINET, etc.
  120.  
  121.         If you would like information from me by mail concerning the
  122.     development status of GFFT, please use e-mail or include a SASE or
  123.     include sufficient funds to reimburse me for replying by mail.
  124.  
  125.  
  126.     4.  How can I support the development of GFFT?
  127.  
  128.         Please make a financial or material donation.  Cash donations
  129.     in any amount are always acceptable, and will help to support the
  130.     development of this software.
  131.  
  132.         You may also help by purchasing various services from me (as
  133.     permitted under the terms of the GNU General Public License and the
  134.     copyrights of software listed included):
  135.  
  136.         Copy of latest GFFT 1.x 'Deluxe Distribution'* (with notes and
  137.              extras).......................................$15 ($20)
  138.  
  139.         Copy of latest GFFT 1.x 'Expanded Deluxe Distribution'* (with
  140.         Gnuplot, POST, notes & more--see below)........$25 ($40)
  141.  
  142.         Early subscription to Deluxe GFFT 2.0 distribution (includes
  143.         everything in 1.x Deluxe, plus more notes, samples, graphs,
  144.             etc., with projected release 1st quarter '95)...$30 ($40)
  145.  
  146.         Early subscription to Expanded Deluxe GFFT 2.0 distribution 
  147.             ................................................$35 ($50)
  148.  
  149.         Additional support and/or enhancements.............$15/hour.
  150.         See also below under 'Contingent Donations.'
  151.  
  152.         (*These are described below.  Please read on.)
  153.  
  154.         Purchasing any of the above distributions or making an
  155.     equivalent donation will also entitle you for a limited amount (up
  156.     to one hour total) of support for up to one year from the date of
  157.     purchase by telephone, e-mail, or regular mail.  (You will be
  158.     responsible for long distance charges and/or return postage if
  159.     applicable.)  If you do not purchase a distribution or direct
  160.     support or make an equivalent donation, I may or may not answer
  161.     questions posed to me by e-mail (only).
  162.     
  163.         Listed prices are minimum suggested donations for software
  164.     services payable in US dollars only, and are valid through December
  165.     31, 1994.  These are to defray the costs and time of production and
  166.     shipping and to help support the further development of GFFT, and
  167.     NOT for any license to use or warranty, or support of products by
  168.     other authors.  Prices in parentheses are for delivery outside of
  169.     US (where feasible and not taxed or prohibited by law).
  170.  
  171.     Methods of payment (may) include (depending on local regulations)
  172.     cash (US currency only), check drawn on a US bank (sometimes
  173.     available outside US at major banks), or a (US or Canadian) postal
  174.     money order in US funds.  Orders will be shipped within 6 weeks (or
  175.     earlier) of receipt (if applicable).
  176.  
  177.         *The expanded deluxe distributions may include additional usage
  178.     notes and screen shots, at least one hardcopy example of a plot
  179.     made with GFFT, alternatively compiled versions (e.g., the IEEE
  180.     version which gives greater accuracy than the normal FFP version
  181.     for those without a floating point unit), addition