diff docs/aimDemonstrations @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/aimDemonstrations	Fri May 20 15:19:45 2011 +0100
@@ -0,0 +1,131 @@
+aimDemonstrations
+
+The following is a list of demonstration scripts available to
+illustrate the operation of AIM and the different auditory
+representations that it produces. The scripts are stored in
+[aimdirectory]/scripts.
+
+The syntax for the demos can be obtained by typing 
+
+> aimdemo_???_??? help 
+
+where '???_???' is one of the extensions listed below.  The simplest
+way to begin is to copy the wave file "cegc" from the waves directory
+to the current working directory, and type 
+
+> aimdemo_gtf_all cegc
+
+NOTE: The byte order for cegc is "little endian" (used by DEC,
+IBM and SGI machines).  A byte reversed version with "big-endian"
+order is the wave "cegc_br". (This is the order used in SUN and HP
+machines.)
+
+The sound in cegc is a set of stationary and gliding click trains that
+play a lazy major triad (C-E-G) and its octave (C) over 2.1 sec.  The
+click train at the start (C) is a particularly useful test and demo
+stimulus. 
+
+Once one or two of the aimdemos have been shown to work with cegc, you
+should be in a position to try them on your own waves.
+
+
+
+I. The Funcional Version of AIM:
+
+
+1. aimdemo_gtf_all   <wave_file>
+   
+   This script illustrates all stages of the functional version of AIM
+   using the "auditory route". It focuses on landscape displays and
+   the instructions involved are:
+
+	       genwav (display input waveform), 
+               genstp (generate stapes velocity),
+               genbmm (generate basilar membrane motion),
+               gennap (generate neural activity pattern),
+               gensai (generate stabilized auditory image) and
+               genspl (generate spiral version of auditory image).  
+
+
+2. aimdemo_gtf_sai  <wave_file>
+
+   This script presents the wave in <wave_file> using genwav, and
+   then produces its rectangular auditory image using gensai. It is
+   the simplest auditory image demo.
+
+
+3. aimdemo_gtf_spectra   <wave_file>
+   
+   This script illustrates the functional version of AIM using the
+   "spectral route".  It focuses on spactral displays and the
+   instructions involved are:
+
+	       genwav (display input waveform), 
+               genasa (generate auditory spectral analysis), and
+               genepn (generate excitation pattern)
+
+
+4. aimdemo_gtf_2dat  <wave_file>
+
+   The script illustrates 2-dimensional adaptive-thresholding
+   (2D-AT) using genwav, genstp, genbmm and finally gennap. 
+
+
+
+II. The Physiological Version of AIM:
+
+
+1. aimdemo_tlf_all    <wave_file>
+ 
+   This demo script illustrates the entire physiological
+   version of AIM using the "auditory route".  It uses the
+   transmission-line filterbank (option filter=tlf) and the Meddis
+   neural transduction module (option transduction=Meddis).  The
+   instructions involved are:
+
+               genwav (display input waveform), 
+               genstp (generate stapes velocity),
+               genbmm (generate basilar membrane motion),
+               gennap (generate neural activity pattern),
+               acgram (generate autocorrelogram).
+
+   
+2. aimdemo_tlf_med  <wave_file>
+
+   The script illustrates the Meddis Haircell module.  The AIM
+   functions involved are genwav, genbmm and gennap.
+
+
+3. aimdemo_tlf_spectra   <wave_file>
+
+   This script illustrates the "spectral route" through the
+   physiological version of AIM.  It focuses on spectral displays and
+   the instructions involved are genwav, genasa and genepn.
+   
+
+4. aimdemo_tlf_lowhigh <wave_file>
+
+   This script illustrates the level dependancies in the physiological
+   version of AIM, and its ability to simulate cochlear damage. The
+   instructions involved are:
+
+   genwav [display input wave], 
+   genbmm [cochlea level = 30dB], 
+   genbmm [cochlea level = 90dB],
+   genbmm [total OHC destruction, cochlea level = 60dB],
+   gennap [Normal cochlea + Meddis high spont-rate fibre] and
+   genasa [total OHC destruction, with no feedback]
+          Note: - very poor frequency resolution.
+
+
+5. aimdemo_tlf_std  <wave_file>
+
+   The script illustrates the standard level outputs in the physiological
+   version of AIM.  It shows the simulations of a normal cochlea.
+   The AIM functions involved are:
+
+   genwav [display input wave],
+   genbmm [normal cochlea level = 60dB],
+   gennap [normal cochlea level = 60dB],
+   genasa [norma cochlea, without log compression].
+