previous next Up Title Contents

Analysis_ISIH:


File name
AnInterSIH.[ch]


Description
his routine generates an inter-spike interval histogram from the EarObject's input signal. It counts all spike events over the specified eventthreshold. The order parameter defines how many spikes beyond the originating spike should be included in the analysis.


Example parameter file format
-1	Order of spike interactions (1 = 1st, 2 = 2nd, -1 = unlimited).
0.0	Event threshold (arbitrary units).
-1	Max. interval for inter-spike interval histogram (s).



Test program directory
Tests/Analysis

Generic Module Routines

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

The Calc_Analysis_ISIH(...) Process Routine

Syntax
BOOLN Calc_Analysis_ISIH(EarObjectPtr data);


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

The SetEventThreshold_Analysis_ISIH(...) Routine

Syntax
BOOLN SetEventThreshold_Analysis_ISIH(double theEventThreshold);


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

The SetMaxInterval_Analysis_ISIH(...) Routine

Syntax
BOOLN SetMaxInterval_Analysis_ISIH(double theMaxInterval);


Special Values
A negative value assumes the range extends to the end of the signal.


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

The SetOrder_Analysis_ISIH(...) Routine

Syntax
BOOLN SetOrder_Analysis_ISIH(double theOrder);


Special Values
A negative value assumes the order is "infinite".


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

The SetPars_Analysis_ISIH(...) Routine

Syntax
BOOLN SetPars_Analysis_ISIH(int order, double eventThreshold, double maxInterval);


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

Example: Tests/Analysis/InterSpikeIntHist.c

Parameter file: InterSpikeIntHist.par:
#
# Main Parameter file
#

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

# Module specifications.

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

IntrSIH1.par	Inter-spike histogram parameter file.

# Miscellaneous parameters

2		No. of repeated runs.
1.0e-3	Bin width for binning process (s).
Output

Figure [45] Output for ISIH test, using a pulse train. This diagram shows the results after two runs.

Figure [46] Output for ISIH test, using a pulse train. This diagram shows the results after two runs, but with the module being reset each time.

Comments:

Both figure [45]and figure [46] show the result of running the inter-spike interval histogram (ISIH) twice, using a pulse train as input. However, figure [46] shows the result of reseting the module each run. This ensures that the reseting facility for the module works correctly.


previous next Up Title Contents