previous next Up Title Contents

Analysis_SpikeRegularity:


File name
AnSpikeReg.[ch]


Description
This module carries out a spike regularity analysis, calculating the mean, standard deviation and measures for a spike train in the process EaObject's input signal. The results for each channel are stored in the first three samples of the output signal in the order - mean, standard deviation, covariance (coefficient of variance corrected for refractoriness, CV') (see [17.]).


Example parameter file format
10.0   	Event threshold (arbitrary units).
0.2e-3	Bin width for spike events (s).
0.0e-3	Time offset for start of analysis (s).
-1	Max. time range: -1 = end of signal (s).



Test program directory
Tests/Analysis

Generic Module Routines

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

The Calc_Analysis_SpikeRegularity(...) Process Routine

Syntax
BOOLN Calc_Analysis_SpikeRegularity(EarObjectPtr data);


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

The SetBinWidth_Analysis_SpikeRegularity(...) Routine

Syntax
BOOLN SetBinWidth_Analysis_SpikeRegularity(double theBinWidth);


Special Values
A negative bin width assumes a value the same as the input signal's sampling interval


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

The SetEventThreshold_Analysis_SpikeRegularity(...) Routine

Syntax
BOOLN SetEventThreshold_Analysis_SpikeRegularity(double theEventThreshold);


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

The SetPars_Analysis_SpikeRegularity(...) Routine

Syntax
BOOLN SetPars_Analysis_SpikeRegularity(double eventThreshold, double binWidth, double timeOffset, double timeRange);


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

The SetTimeOffset_Analysis_SpikeRegularity(...) Routine

Syntax
BOOLN SetTimeOffset_Analysis_SpikeRegularity(double theTimeOffset);


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

The SetTimeRange_Analysis_SpikeRegularity(...) Routine

Syntax
BOOLN SetTimeRange_Analysis_SpikeRegularity(double theTimeRange);


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.

Example: Tests/Analysis/SpikeRegularity.c

Parameter file: SpikeRegularity.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.

SpikeRg1.par	Inter-spike histogram parameter file.

# Miscellaneous parameters

100		No. of repeated runs.
Comments:

The results for this test are output in the form:

mean, standard deviation, corrected covariance.

Values of the refractoriness corrected covarience, CV' are only calculated for numbers of spike events greater than two.


previous next Up Title Contents