previous next Up Title Contents

Utility_ShapePulse:


File name
UtShapePulse.[ch]


Description
This module turns a train of detected spikes into a pulse train with set magnitudes and durations.


Example parameter file format
0.0	Event threshold (units).
0.2e-3	Pulse duration (s).
3.8	Pulse magnitude (nA?).



Test program directory
Tests/Utilities

Generic Module Routines

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

The Process_Utility_ShapePulse(...) Process Routine

Syntax
BOOLN Process_Utility_ShapePulse(EarObjectPtr data);


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

The SetEventThreshold_Utility_ShapePulse(...) Routine

Syntax
BOOLN SetEventThreshold_Utility_ShapePulse(double theEventThreshold);


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

The SetPars_Utility_ShapePulse(...) Routine

Syntax
BOOLN SetPars_Utility_ShapePulse(double eventThreshold, double pulseDuration, double pulseMagnitude);


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

The SetPulseDuration_Utility_ShapePulse(...) Routine

Syntax
BOOLN SetPulseDuration_Utility_ShapePulse(double thePulseDuration);


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

The SetPulseMagnitude_Utility_ShapePulse(...) Routine

Syntax
BOOLN SetPulseMagnitude_Utility_ShapePulse(double thePulseMagnitude);


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

Example: Tests/Utilities/ShapePulse.c

Parameter file: ShapePulse.par:
#
# Main Parameter file
#

output1.dat	Name of output file.
output2.dat	Name of output file.

# Module specifications.

#Par. file		Name			Description
#---------		-----			-------------
PulseTr2.par		PulseTrain		Stimulus generation paradigm.

ShapePu1.par	Shape pulse utility module parameter file.

# Miscellaneous parameters

2		No. of repeated runs.
Output

Figure [162] This routine shows a pulse train stimulus processed using the "ShapePulse" utility. The process is repeated twice: once with the module accumulating the results, then once with the module process being reset just before each time it is called. The two runs are output to the files 'output1.dat' and 'output2.dat' respectively.


previous next Up Title Contents