previous next Up Title Contents

PulseTrain:


File name
StPulseTrain.[ch]


Description
This module generates a pulse strain stimulus.


Example parameter file format
360		Pulse rate (s).
0.1e-3		Pulse duration (s).
8.0		Stimulus signal amplitude (arbitary units).
20.0e-3		Stimulus signal duration (s).
0.02e-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_PulseTrain(...) Process Routine

Syntax
BOOLN GenerateSignal_PulseTrain(EarObjectPtr data);


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

The SetAmplitude_PulseTrain(...) Routine

Syntax
BOOLN SetAmplitude_PulseTrain(double theAmplitude);


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

The SetDuration_PulseTrain(...) Routine

Syntax
BOOLN SetDuration_PulseTrain(double theDuration);


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

The SetPars_PulseTrain(...) Routine

Syntax
BOOLN SetPars_PulseTrain(double pulseRate, double pulseDuration, double amplitude, double duration, double samplingInterval);


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

The SetPulseDuration_PulseTrain(...) Routine

Syntax
BOOLN SetPulseDuration_PulseTrain(double thePulseDuration);


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

The SetPulseRate_PulseTrain(...) Routine

Syntax
BOOLN SetPulseRate_PulseTrain(double thePulseRate);


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

The SetSamplingInterval_PulseTrain(...) Routine

Syntax
BOOLN SetSamplingInterval_PulseTrain(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/PulseTr1.par	PulseTrain	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 generation.
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 [136] A stimulus generated by the PulseTrain module.


previous next Up Title Contents