previous next Up Title Contents

UtCFList Module


The CFList Data Structure

[11][2]

The Valid CFList Modes

Mode
Description
ERB
A range of centre frequencies, equally spaced on an ERB scale is required (using the Glasberg and Moore Equation, Glasberg and Moore (1990)): the lowest frequency, the highest frequency and the ERB density must be specified.


LINEAR
A range of centre frequencies, equally spaced on a linear scale: the lowest frequency, the highest frequency and the number of centre frequencies must be specified.


LOG
A range of centre frequencies, equally spaced on a logarithmic scale: the lowest frequency, the highest frequency and the number of centre frequencies must be specified.


SINGLE
A single centre frequency is required, hence only one frequency (Hz) must be specified.


USER
A list of centre frequencies can be input: the number of frequencies followed by the list of frequencies is required.

The CheckInit_CFList(...) Routine

Syntax
BOOLN CheckInit_CFList(CFList *theCFList, char *callingFunction);


Description
This routine checks whether or not theCFList has been initialised.


Returns
TRUE if this function succeeeds, otherwise it returns FALSE.


Example(s)
CheckPars_CFList(...) routine.

The CheckPars_CFList(...) Routine

Syntax
BOOLN CheckPars_CFList(CFList *theCFList);


Description
This routine checks that the necessary parameters for theCFList have been correctly initialised.


Returns
TRUE if this function succeeeds, otherwise it returns FALSE.


Example(s)
CheckPars_BasilarM_GammaT(...) routine.

The GenerateERB_CFList(...) Routine

Syntax
CFList *GenerateERB_CFList(double minCF, double maxCF, double ERBDensity);


Description
This function generates the centre frequency list from the frequency range, minCF - maxCF and ERBdensity.


Returns
a pointer to the CFList data structure or NULL if it fails.


Example(s)
ReadPars_BasilarM_GammaT(...) routine.

The Init_CFList(...) Routine

Syntax
CFList *Init_CFList(char *callingFunctionName);


Description
This function allocates memory for a centre frequency data structure. The *callingFunctionName passed is used for debugging purposes.


Returns
a pointer to the CFList data structure or NULL if it fails.


Example(s)
SetCentreFreq_BasilarM_GammaT(...) routine.

[11] Refer to table for fuller description of the CFList modes.


previous next Up Title Contents