# file: $isip/util/speech/isip_transform_builder/AAREADME.text
# version: $Id: AAREADME.text 8380 2002-07-14 18:26:47Z picone $
#

-------------------------------------------------------------------------------
I. QUICK START

To install the Transform Builder, after unpacking use

   make install

After you have installed, you can run Transform Builder with the
following command line:
      
   isip_transform_builder

-------------------------------------------------------------------------------
II. DESCRIPTION

The Transform Builder is a GUI for our front end utility, isip_transform,
that allows the user to draw signal flow graphs and compile
them into a form that can be used to process data.
         
We provide a library of algorithms, known as our Algorithm library,
that consists of many of the common signal processing algorithms
in use today. Also included in this library are primitive building
blocks, such as the math class, that can be used to create
arbitrarily complex algorithms.

The Transform Builder tool consists of a main panel and a set of
controls that can be assessed via drop-down menus. It is written
entirely in Java. Below is a brief description of the structure
of the software.

II.A. SOFTWARE

The TransformBuilder sources files include three parts:

   (1) Java Source Files

       - Configure Menu class 
         CongfigBoxInOut.java
	 ConfigBoxSub.java
	 SubConfigBoxParam.java
	 SubConfigBox.java
	 ConfigBox.java
	 Digraph.java
	 SubDiGraph.java

       - Vertex button class
	 Vertex.java
	 Association.java
  
       - Directed acyclic graph class
	 DiGraph.java
	 MainMenu.java
	 WorkArea.java
	 SubWorkArea.java
	 Number.java
	 EnvProperties.java
	 Data.java

   (2) Global Constants Definition and Initialization
     
       - Constants.java

   (3) Parser for resources file
     
       - Parser.java

   (4) Main driver program
  
       - TransformBuilder.java
  
II.B. RESOURCES

These files contain various resources used by the tool:

   (1) AAREADME.txt
     
       This file provides a detailed description of the organization
       of the tool.

   (2) resources.txt

       The file allows users to specify parameters for every algorithm class.
       It allows the tool to be reconfigured without changing the underlying
       software. The format of this file follows the resources conventions
       used in X Windows.

   (3) overview.txt

       The file provides basic information about this tool.

   (4) tutorial.txt
     
       This file provides some examples of how to use this tool.
       We also have an extensive on-line tutorial - see the man page
       for more details.

II.C. IMAGE FILES

This tool uses several bitmaps for icons, etc.:

   (1) input.gif: icon for the input block

   (2) output.gif: icon for the output block

   (3) algorithm_00.gif: icon for the algorithm block
			 (except the Generator and CoefficientLabel classes)

   (4) gen.gif: icon Generator block

   (5) container.gif: icon for Container block

   (6) container_input.gif: icon for Container input block
   
   (7) container_output.gif: icon for Container output block
   
   (8) custom.gif: icon for CoefficientLabel block

II.D. EXAMPLES

(1) This is an example of a graph that generates a signal, computes
    the energy, and outputs energy as a function of time:
    
		Gen
		 |
	        Wind
		 |
		Ener
		 |  
		Out


(2) This is an example of a graph that computes energy of an input file:

		Inp
		 |
		Wind
		 |
		Ener
		 |
		Out

(3) This is an example of a graph that mixes an input signal with
    a generated signal (e.g., speech plus noise):


		Inp    Gen
		 |     /
		 |    /  
		 Conn
		  |
		 Wind
		  |
		 Ener
		  |
		 Out 

-------------------------------------------------------------------------------
III. CONTACT POINTS

This package is distributed by the Institute for Signal and Information
Processing (http://www.isip.msstate.edu/) at Mississippi State University
(http://www.msstate.edu/). We have a free help facility available via email
by mailing help@isip.msstate.edu. This service can be used for assistance
in installing and running the system, requests for features, bug reports,
and other comments, complaints, suggestions, etc. Typically, we are able
to reply to your mail within a single business day.

For more extensive documentation on this project and the software
distribution, please visit the web pages:

 http://www.isip.msstate.edu/projects/speech/
 http://www.isip.msstate.edu/projects/speech/software
 http://www.isip.msstate.edu/projects/speech/software/tutorials/production/current/index.html

-------------------------------------------------------------------------------
IV. LICENSE

Institute for Signal and Information Processing
Mississippi State University

LICENSE AGREEMENT

This software is distributed without any restrictions.
You may copy, distribute, or modify this software as you see fit.

This package is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantibility and fitness for a particular purpose.
