# THE AUDITORY MODELING TOOLBOX

Applies to version: 0.9.7

Go to function

# AMTSTART - Start the Auditory Modeling Toolbox

## Usage

amtstart;
amtstart(flags);


## Description

amtstart starts the Auditory Modeling Toolbox. This command must be run before using any of the function in the AMT.

## Requirements

The AMT depends on the Linear Time Frequency Analysis Toolbox (LTFAT). Download LTFAT from <http://ltfat.sourceforge.net/> and unpack the downloaded file. In the AMT, there is a prepared directory thirdparty/ltfat where the LTFAT can be stored and automatically recognized by the AMT. Alternatively, save the LTFAT anywhere and add the main LTFAT path to the search path.

In order to run all the AMT functionality:

1. install the SOFA API version >= 1.0 from <http://sourceforge.net/projects/sofacoustics>. In the AMT, there is a prepared directory thirdparty/SOFA. Alternatively, save the SOFA API anywhere and add the path to the search path.
2. install SFS Toolbox version >= 1.0 from <https://github.com/sfstoolbox/sfs>. In the AMT, there is a prepared directory thirdparty/sfs. Alternatively, save the SOFA API anywhere and add the path to the search path.
3. install Python (version >= 2.6), and the packages numpy and scipi. On Linux, sudo apt-get install python-scipy python-numpy can be applied. On Windows, intall python from <https://www.python.org/>, add python.exe to path, and install the packages separately.
4. run amtmex to compile some models. You will need a compiler working in your Matlab/Octave environment (see help mex).
5. in the directory src/verhulst, run make (Linux) or make.bat (Windows). You will need gcc (see <https://gcc.gnu.org/>) installed and available at the command line.
6. have the Optimization Toolbox for Matlab installed.

## Supplementary files:

Most of the models require auxiliary data. The AMT will download these data on-demand. The download URL for the auxiliary data is given by amtauxdataurl. The target directory for the auxiliary data is given by amtauxdatapath. If you want to run the AMT offline, download the auxiliary data first.

Some of the models require HRTFs. The AMT will download the HRTFs on-demand. The download URL for the HRTFs is given by SOFAdbURL. The target directory for the HRTFs is given by SOFAdbPath. If you want to run the AMT offline, download the HRTFs first.

## Global flags:

AMT uses cache to store precalculated results because some of the AMT functions require large processing time. Depending on the machine and the model, it might take even days. The global cache mode is controlled on start-up of the AMT. To change the global cache mode choose a flags:

 'normal' Use cached package as far as possible. This is default. This is kind of demonstration mode and very convenient for fast access of results like plotting figures. This option, however, may by-pass the actual processing and thus does not always test the actual functionality of a model. If the cached package locally not available, downloaded from the internet. If remotely not available, enforce recalculation. 'cached' Enforce to use cached package. If the cached package is locally not available, it will be downloaded from the internet. If it is remotely not available, an error will be thrown. 'redo' Enforce the recalculation of the package. This option actually tests the calculations. 'localonly' Package will be recalculated when locally not available. Do not connect to the internet.

Many AMT functions support the cache mode as input flag in order to overwrite the global cache mode. See amtcache for more details.

The output of the messages to the command line can be controlled by one of the following flags:

 'verbose' All output will be displayed. This is default. 'documentation' starts the AMT in the documentation compiling mode. The output of calculation progress will be suppressed. 'silent' All output will be suppressed.