
                        DIGITAL FILTER PACKAGE (DFP)
                             Version:  1.0.1

             Department of Electrical and Computer Engineering 
                      Ryerson Polytechnic University           
                         Toronto, Ontario, CANADA              


 
INTRODUCTION
----------------------------------------------------------------------------
The Digital Filter Package (DFP) is a user friendly GUI front-end to digital
filter design with MATLAB. DFP extends the basic digital filter design
functionality of MATLAB in two important ways.

* Filter coefficients can be quantized. This feature is of particular
  importance if the filter will eventually be implemented on a fixed point
  digital signal processor.

* DFP also generates assembler code for the designed digital filter. In the
  current DFP release (ver 1.0) this option is available only for the Motorola
  DSP56k family of fixed point processors.

The following list presents the main features of DFP. This list is by no
means comprehensive.   I recommend everyone to spend some time using the 
package in order to have a better understanding of DFP's capabilities.

   FILTER TYPES
   ------------
   * Lowpass.
   * Highpass.
   * Bandpass.
   * Bandstop.
   * Differentiator.
   * Hilbert transformer.

   FILTER DESIGN METHODS
   ---------------------
   * FIR: Remez (Parks-McClellan) equiripple filter design.
   * FIR: Windowed linear phase digital filter design.
   * FIR: Least squares linear phase filter design.
   * IIR: Butterworth filter design.
   * IIR: Chebychev-I filter design.
   * IIR: Chebychev-II filter design.
   * IIR: Elliptic filter design.
   * Interactive Pole-Zero Placement (*).

   FILTER ORDER ESTIMATION BASED ON FILTER SPECIFICATIONS

   FILTER IMPLEMENTATION
   ---------------------
   * Polynomial.
   * Lattice.
   * Cascade of biquad sections (for IIR).

   FILTER COEFFICIENT FORMAT
   -------------------------
   * Floating point,
   * Fixed point. The user can specify:
       1. total number of bits (any positive integer),
       2. number of integer bits,
       3. two's complement or "unsigned integer" formats.

   OUTPUT OPTIONS
   --------------
   * Transfer filter coefficients to the MATLAB workspace.
   * Motorola DSP56K code generation

   DISPLAY OPTIONS
   ---------------
   * Magnitude Response (linear/dB).
   * Filter target display (linear/dB if applicable).
   * Phase Response (degrees/radians, wrap/unwrap).
   * Group Delay (user specified points).
   * Unit Sample Response (user specified points).
   * Pole-Zero Plot.
   * Filter Coefficients (in floating point, hexadecimal, octal, and binary
     formats) in scrollable text fields.

   OTHER FEATURES
   --------------
   * Global and individual customization.
   * GUI based customization of DFP parameters.
   * Automatic color assignment for monochrome and color monitors.
   * Error checking.
   * On-line, context sensitive help facility (*)

(*) These features are yet not available with the current release.


REQUIREMENTS
----------------------------------------------------------------------------
DFP requires MATLAB version 4.2 (or higher) and the Signal Processing
Toolbox (version 3.0 or higher). DFP also requires a number of M-files from
the Mathworks UITOOLS distribution which may not be part of standard Matlab
distribution. If at the Matlab prompt you type "help uitools" and receive
the "uitools not found" message, then you need UITOOLS. The standard DFP
distribution contains all the required UITOOLS files (there are 9 of them).
For installation instructions, please read the installation manual.

If you want to download the entire UTOOLS package, they are available from
the Mathworks ftp site at ftp://ftp.mathworks.com/pub/mathworks/. You will
find the UITOOLS in the "/pub/mathworks/toolbox/uitools/" directory.

DFP has been tested on Sun workstations running Solaris, SunOS, on 486 and
Pentium class Intel based computers running Linux, Windows 3.1 and Windows
95. Please note that as of this release date (25.February.1997) DFP has not
been tested with MATLAB version 5.0.


COPYRIGHT
----------------------------------------------------------------------------
This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.

Copyright  1997, Mehmet Zeytinoglu


DOCUMENTATION
----------------------------------------------------------------------------
The current release of DFP includes the following documentation:

   * List of known bugs (bugs.txt).
   * Installation guide (install.txt).
   * User guide (usrguide.txt).
   * Release Notes (relnotes.txt).

All these files are in ASCII text format and can be found in the
DFP_ROOT/doc directory where DFP_ROOT is the directory where DFP has been
installed. The user can further access information about each M-file in the
DFP distribution by using the standard, on-line MATLAB help facility by
typing "help name-of-Mfile".


ACKNOWLEDGMENTS
----------------------------------------------------------------------------
In writing this package I have used code written by other MATLAB users. I
have retained their copyright notices and/or names in these files. However,
I also added a brief notice to these files if I had modified any one of
them. In particular, I would like to express my thanks to the following
people who have made their code available:

   * Erik A. Johnson (arrow.m)
   * Kevin G. Kohrt (dateme.m)
   * Hans Olsson (dec2bin.m).
   * Uwe Petersen (timedate.m)
   * D.L. Hallman (uiprint.m)
   * Motorola DSP bulletin board for most of the assembler code templates.


CONTACT INFORMATION
----------------------------------------------------------------------------
Mehmet Zeytinoglu
Department of Electrical and Computer Engineering
Ryerson Polytechnic University
Toronto, Ontario, M5B 2K3, CANADA
Tel: (416) 979 5000 ext 6078
Fax: (416) 979 5280
E-mail: mzeytin@ee.ryerson.ca


---------------------------
Revised: March 11, 1997.
