annotate README.html @ 4:537f939baef0 tip

various bug fixes and changed copyright message
author Stefan Bleeck <bleeck@gmail.com>
date Tue, 16 Aug 2011 14:37:17 +0100
parents 74dedb26614d
children
rev   line source
tomwalters@0 1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
tomwalters@0 2 <html>
tomwalters@0 3 <head>
tomwalters@0 4 <title>AIM-MAT Readme</title>
tomwalters@0 5 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
tomwalters@0 6 </head>
tomwalters@0 7
tomwalters@0 8 <body>
tomwalters@0 9 <h1>Getting started with <a href="http://www.soton.ac.uk/aim/">AIM-MAT</a></h1>
tomwalters@0 10 <pre>
tomwalters@0 11 AIM-MAT v 1.5
tomwalters@0 12 $Date: 20011-04-06 $
tomwalters@0 13 </pre>
tomwalters@0 14 <ul>
tomwalters@0 15 <li>To install AIM-MAT, recursively add the <font face="Courier New, Courier, mono">aim-mat</font>,
tomwalters@0 16 <font face="Courier New, Courier, mono">tools</font> and <font face="Courier New, Courier, mono">demo</font>
tomwalters@0 17 folders to your MATLAB path</li>
tomwalters@0 18 <li>To test the installation, run <font face="Courier New, Courier, mono">demo_aim2006_gtfb</font>
tomwalters@0 19 from the <font face="Courier New, Courier, mono">demo</font> folder, this
tomwalters@0 20 runs the analysis of the four scaled vowel sounds seen in the documentation.
tomwalters@0 21 The script opens six figure windows, one for each stage of the model, and
tomwalters@0 22 plots the output of each stage for the four vowels.</li>
tomwalters@0 23 <li>To run AIM with a GUI type <font face="Courier New, Courier, mono">aim</font>
tomwalters@0 24 at the prompt</li>
tomwalters@0 25 </ul>
tomwalters@0 26 <hr>
tomwalters@0 27 <h2>System Requirements </h2>
tomwalters@0 28 <p>AIM-MAT was developed using MATLAB 7 and above.</p>
tomwalters@0 29 <p>The package should work on any platform supporting MATLAB 6.5 or above, with
tomwalters@0 30 the Signal Processing Toolbox installed.</p>
tomwalters@0 31 <p>AIM-MAT has been tested while in development on the following platforms:</p>
tomwalters@0 32 <ul><li>Windows XP with MATLAB versions 6.5, 7.1, R2006a</li>
tomwalters@0 33 <li>Mac OS X (version 10.4 onwards) with MATLAB version 7.1 and R2007b</li>
tomwalters@0 34 <li>Ubuntu Linux with MATLAB versions 7.1, R2007b and R2008a</li></ul>
tomwalters@0 35 <hr>
tomwalters@0 36 <h2>Tips for getting started</h2>
tomwalters@0 37 <ul>
tomwalters@0 38 <li>If AIM-MAT is started from the command-line with no parameters, a file-open dialogue box will be displayed. Select the .wav or .aiff file you wish to process using this box.</li>
tomwalters@0 39 <li>AIM-MAT is a MATLAB implementation of the Auditory Image Model. The buttons
tomwalters@0 40 along the top of the main AIM-MAT window correspond to stages of this model.
tomwalters@0 41 The model runs from left to right across the window. The calculation of any
tomwalters@0 42 section of the model is contingent upon the calculation of the stage before
tomwalters@0 43 it.</li>
tomwalters@0 44 <li>To enable any of the buttons at the top of the AIM-MAT window, simply check
tomwalters@0 45 the 'recalculate' checkbox below that button. This will automatically check
tomwalters@0 46 any other parts of the module that need recalculating.</li>
tomwalters@0 47
tomwalters@0 48 <li>If any section of the model needs calculating, the surround of the button
tomwalters@0 49 for that section will light up <font color="#0033FF">blue</font>. If the section
tomwalters@0 50 needs <em>re</em>calculating the button surround will light up <font color="#990000">red</font>.
tomwalters@0 51 Sections of the model which have been calculated have button surrounds in
tomwalters@0 52 <font color="#006600">dark green</font>. The section whose output is currently
tomwalters@0 53 displayed has the button surround illumninated in <font color="#33CC00">bright
tomwalters@0 54 green</font>.</li>
tomwalters@0 55 <li>To get the contents of the AIM-MAT workspace into the MATLAB command line workspace at any point, simply select 'Copy current data to workspace (data)' from the 'Edit' menu.</li>
tomwalters@0 56 <li>The plot window will show no activity for the first few frames of the output
tomwalters@0 57 of the SAI module. This is because it takes a finite time for the stabilised
tomwalters@0 58 image to build up. Use the 'Frame #' slider in the bottom left of the GUI
tomwalters@0 59 to move on a few frames and see the image to build up.</li>
tomwalters@0 60 <li>The autoscaling function should scale each plot to a reasonable level, however,
tomwalters@0 61 if the activity in the plot window looks to large or too small, you can use
tomwalters@0 62 the 'autoscale' button to re-run the autoscaling, or use the scaling slider
tomwalters@0 63 to choose a suitable scale for the plot.</li>
tomwalters@0 64 <li>AIM-MAT plots are just MATLAB figures; they can be manipulated using the
tomwalters@0 65 MATLAB 7 plot tools, or command line functions.</li>
tomwalters@0 66 <li>AIM-MAT stores parameters for a processed file in a subdirectory of that
tomwalters@0 67 file's directory, named after the file without the extension. If you wish
tomwalters@0 68 AIM-MAT to start afresh on working on a file, delete this subdirectory.</li>
tomwalters@0 69 </ul>
tomwalters@0 70 </body>
tomwalters@0 71 </html>