%%% readme.txt for zbcatmodel %%%

This is Version 1 of the public distribution of the code for the cat auditory
periphery model of:

    Zilany, M. S. A. and Bruce, I. C. (2006). "Modeling auditory-nerve responses
    for high sound pressure levels in the normal and impaired auditory
    periphery," to appear in Journal of the Acoustical Society of America.

Please cite this paper if you publish any research results obtained with this
code or any modified versions of this code. Note that this version of the code
has an "unpublished feature" of being able to model AN fibers with different
spontaneous rates (from 0 to 150 spikes/s) and the corresponding changes in the
threshold and the rate-level function. A spontaneous rate of 50 spikes/s
(before refractory effects) was used in the Zilany and Bruce paper.

The Matlab and C code included with this distribution is designed to be
compiled as a Matlab MEX file, i.e., the compiled model MEX function will run
as if it were a Matlab function.  The code can be compiled within Matlab using
the function:

    mexzbcatmodel_msc.m     if you are using a Microsoft C compiler on a
                            Win32 system;

    mexzbcatmodel_lcc.m     if you are using the lcc compiler supplied with
                            Matlab on a Win32 system; or

    mexzbcatmodel_unix.m    if you are using a compiler such as gcc on a Unix
                            system.

The reason for the difference is that Unix compilers typically include the
drand48() random number generator, which has the precision required for spike
generation in this model.  Microsoft C compilers and the lcc compiler do not
include drand48(), so I have made use of the Gnu Scientific Library (GSL;
http://www.gnu.org/software/gsl/) equivalent.  The required files from the GSL
are included with this distribution, as is a copy of the GNU General Public
License (gpl.txt), under which the GSL is released.

Once you have compiled the MEX file in Matlab, type:

    help zbcatmodel

for instructions on how to call the MEX function.

I have also include a sample Matlab script for setting up an acoustic stimulus
and the model parameters and running the model:

    testzbcatmodel.m

ACKNOWLEDGMENTS

Some of this code is based on code written by Xuedong (Frank) Zhang, Michael
Heinz, Ian Bruce and Laurel Carney for the model of:

    Zhang, X., Heinz, M. G., Bruce, I. C., and Carney, L. H. (2001). "A
    phenomenological model for the responses of auditory-nerve fibers: I.
    Nonlinear tuning with compression and suppression," J. Acoust. Soc. Am. 109,
    648–670,

and by Qing Tan and Laurel Carney for the model of:

    Tan, Q. and Carney, L. H. (2003). “A phenomenological model for the
    responses of auditory nerve fibers. II. Nonlinear tuning with a
    frequency glide,” J. Acoust. Soc. Am. 114, 2007–2020.

%%% © Ian C. Bruce (ibruce@ieee.org) and M. S. Arefeen Zilany, June 2006 %%%
