previous next Up Title Contents

LUTEar Module


This module contains the common system routines (and macros).

The DB_SPL(...) Macro

Syntax
DB_SPL(RMS_AMPLITUDE)


Description
This macro converts the RMS_AMPLITUDE (uPa) into intensity, dB SPL.


Returns
intensity, dB SPL


Example(s)
CalcIntensities_GenAnalysis(...).

The MSEC(...) Macro

Syntax
MSEC(SECONDS)


Description
This macro converts SECONDS (s) to milliseconds (ms).


Returns
time (ms).


Example(s)
Tests/Stimuli/StimulusResp.c

The NotifyError(...) Routine

Syntax
void NotifyError(char *format, ...);


Description
This routine prints out an error message, preceded by a bell sound. It is used in the same way as the printf statement. It does not take any further action, as responses to errors differ: some errors are recoverable while others are fatal. It is up to the calling routine to decide the course of action that should be taken.


Returns
none.


Example(s)
Init_EarObject(...), and most routines.

The NotifyWarning(...) Routine

Syntax
void NotifyWarning(char *format, ...);


Description
This routine prints out a warning/diagnostic message. It is used in the same way as the printf statement. It does not take any further action.


Returns
none.


Example(s)
PrintPars_...(...), routines, etc.

The ReadParsFromFile(...) Routine

Syntax
void ReadParsFromFile(char *fileName);


Description
Only the prototype for this routine exists. The a custom version of the routine itself whould be written for each test program written using the CRL.


Returns
none.


Example(s)
Tests/Stimuli/StimulusResp.c

The RMS_AMP(...) Macro

Syntax
RMS_AMP(DBVALUE)


Description
This macro conerts the intensity, DBVALUE (dB SPL) to an RMS amplitude.


Returns
RMS Amplitude (uPa)


Example(s)
GenerateSignal_Click(...) routine

The SetErrorsFile(...) Routine

Syntax
BOOLN SetErrorsFile(char *fileName);


Description
This function sets the file to which errors should be sent. The default is the standard error, which can be reset by sending a null string as the function argument.


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


Example(s)

The SetSegmentedMode(...) Routine

Syntax
void SetSegmentedMode(BOOLN *setting);


Description
This routine turns the segment processing mode on or off: the argument should be set to "TRUE" or "FALSE" respectively.


Returns
none.


Example(s)
Tests/Segmented_Mode/SegModeResp.c

The SetWarningsFile(...) Routine

Syntax
BOOLN SetWarningsFile(char *fileName);


Description
This function sets the file to which warnings/diagnostics should be sent. The default is the standard error, which can be reset by sending a null string as the function argument.


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


Example(s)

The SQR(...) Macro

Syntax
SQR(X)


Description
This macro calculates square of X.


Returns
X * X..


Example(s)

The DEGREES_TO_RADS(...) Macro

Syntax
DEGREES_TO_RADS(DEGREES)


Description
This macro converts degrees to radians.


Returns
DEGREES / 57.29577951.


Example(s)


previous next Up Title Contents