previous next Up Title Contents

PureTone_FM: Frequency Modulated Pure Tone


File name
StFMTone.[ch]


Description
This program generates a frequeny modulated (FM) pure tone.


Example parameter file format
500.0		Stimulus frequency (Hz).
50.0		Stimulus signal intensity (dB SPL).
0		Stimulus phase (degrees).
80		Modulation depth (%).
200		Modulation frequency (Hz).
0		Modulation phase (degrees).
20.0e-3		Stimulus signal duration (seconds).
0.05e-3		Stimulus sampling interval, dt (seconds).



Test program directory
Tests/Combinations

Generic Module Routines

This module has the standard Generic Module Routines (see 0 Basic Module Routines used in Generic Programming).

The GenerateSignal_PureTone_FM(...) Process Routine

Syntax
BOOLN GenerateSignal_PureTone_FM(EarObjectPtr data);


Returns
TRUE if the process is successful, otherwise it returns FALSE.

The SetModulationDepth_PureTone_FM(...) Routine

Syntax
BOOLN SetModulationDepth_PureTone_FM(double theModulationDepth);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetDuration_PureTone_FM(...) Routine

Syntax
BOOLN SetDuration_PureTone_FM(double theDuration);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetModulationFrequency_PureTone_FM(...) Routine

Syntax
BOOLN SetModulationFrequency_PureTone_FM(double theModulationFrequency);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetFrequency_PureTone_FM(...) Routine

Syntax
BOOLN SetFrequency_PureTone_FM(double theFrequency);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetIntensity_PureTone_FM(...) Routine

Syntax
BOOLN SetIntensity_PureTone_FM(double theIntensity);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetPars_PureTone_FM(...) Routine

Syntax
BOOLN SetPars_PureTone_FM(double frequency, double intensity, double duration, double samplingInterval, double phase, double modulationDepth, double modulationFrequency, double modulationPhase);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetModulationPhase_PureTone_FM(...) Routine

Syntax
BOOLN SetModulationPhase_PureTone_FM(double thePhaseFM);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetPhase_PureTone_FM(...) Routine

Syntax
BOOLN SetPhase_PureTone_FM(double thePhase);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

The SetSamplingInterval_PureTone_FM(...) Routine

Syntax
BOOLN SetSamplingInterval_PureTone_FM(double theSamplingInterval);


Returns
TRUE if the function is successful, otherwise it returns FALSE.

Example: Tests/Combinations/StimulusResp.c

Parameter file: StimulusResp.par:
#
# Main Parameter file
#

output.dat	Name of output file.

# Module specifications
#Par. file				Name			Description
#---------				-----			-------------
ParFiles/St/FMPTone1.par		PureTone_FM	Stimulus generation paradigm.
ParFiles/PE/PreEmph1.par	null			Outer-/middler-ear filter model.
ParFiles/BM/GammaT5k.par	null			Basilar membrane filter model.
ParFiles/IHC/CarneyRP1.par	null			IHC receptor potential model.
ParFiles/IHC/Meddis86.par	null			Inner hair cell (IHC) model.
ParFiles/AN/BinomSG1.par	null			Auditory nerve spike gen.
ParFiles/NC/Dendrite3.par	null			Dendritic filtering.
ParFiles/NC/MG92Stellate.par	null			Neural cell model.

# Miscellaneous parameters

2.5e-3	Ramp up rise time for signal (s).
Output

Figure [142] A stimulus generated by the PureTone_FM module.


previous next Up Title Contents