#include "Constants.h"

Defines
#define	ERR_NULL_OBJECT -5
Functions
void *	CreateScaledCorrelationComputerBB (int piScaleWindow, int piCorrelationWindow, int piTrialLength, int &piIsError)
	Creates an object that computes scaled correlation on a pair of binary - binary signals.
void	FreeScaledCorrelationComputerBB (void *pvObject)
	Destructor for scaled correlation objects on binary-binary pairs; always call this to cleanup your data space.
void	ComputeScaledCorrelationBB (void pvObject, int piaTimeStampsA, int piNrTimeStampsInA, int *piaTimeStampsB, int piNrTimeStampsInB, int pbUseFisherZTransform)
	Compute the scaled correlation of two vectors of time stamps.
void	ComputeWindowedScaledCorrelationPerTrialBB (void pvObject, int piaTimeStampsA, int piNrTimeStampsInA, int *piaTimeStampsB, int piNrTimeStampsInB, int piFromOffsetInTrial, int piToOffsetInTrial, int pbUseFisherZTransform)
	Compute the scaled correlation of two vectors of time stamps, on a partial window of the trial; ONLY ACCEPTS ONE TRIAL!!!
float *	GetScaledCrossCorrelogramBB (void *pvObject)
	Returns the buffer with the computed scaled-cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!
float *	GetFiCoefficientSumsBB (void *pvObject)
	Returns the sum of valid Fi coefficients of correlation for each bin of the correlogram.
int *	GetFiCoefficientCountsBB (void *pvObject)
	Returns how many Fi coefficients of correlation have been averaged for each bin of the scaled cross correlogram.
int *	GetDistributionOfCorrelationCoefficientsBB (void *pvObject, int &piNumberOfBins, float &pfBinSize)
	Returns the distribution of coefficients of correlation.
int	ScaledCorrelationModifyScaleWindowBB (void *pvObject, int piNewScale)
	Changes the scale window for the scaled correlation;.
int	ScaledCorrelationModifyCorrelationWindowBB (void *pvObject, int piNewCorrelationWindow)
	Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.
int	ScaledCorrelationModifyTrialLengthBB (void *pvObject, int piNewTrialLength)
	Set the length of the trial in original sampling units.
int	ScaledCorrelationModifyAllParametersBB (void *pvObject, int piNewScale, int piNewCorrelationWindow, int piNewTrialLength)
	Sets all parameters at once.
int	ScaledCorrelationGetScaleWindowBB (void *pvObject)
	Get the size of the current scale window.
int	ScaledCorrelationGetCorrelationWindowBB (void *pvObject)
	Get the size of the correlation window.
int	ScaledCorrelationGetTrialLengthBB (void *pvObject)
	Get the trial length in original sampling units.
int	GetDistributionOfCorrelationCoefficientsBinNrBB (void *pvObject)
	Get the number of bins of the distribution of coefficients of correlation.
float	GetDistributionOfCorrelationCoefficientsBinSizeBB (void *pvObject)
	Get the size of a bin of the distribution of coefficients of correlation.
void *	CreateScaledCorrelationComputerCC (int piScaleWindow, int piCorrelationWindow, int piTrialLength, int &piIsError)
	Creates an object that computes scaled correlation on a pair of continuous - continuous signals.
void	FreeScaledCorrelationComputerCC (void *pvObject)
	Destructor for scaled correlation objects on continuous-continuous input pairs; always call this to cleanup your data space.
void	ComputeScaledCorrelationCC (void pvObject, float pfaSamplesA, int piNrSamplesInA, float *pfaSamplesB, int piNrSamplesInB, int pbUseFisherZTransform)
	Compute the scaled correlation of two digitized continuous signals.
void	ComputeWindowedScaledCorrelationPerTrialCC (void pvObject, float pfaSamplesA, int piNrSamplesInA, float *pfaSamplesB, int piNrSamplesInB, int piFromOffsetInTrial, int piToOffsetInTrial, int pbUseFisherZTransform)
	Compute the scaled correlation of two digitized continuous signals, on a partial window of the trial; ONLY ACCEPTS ONE TRIAL!!!
float *	GetScaledCrossCorrelogramCC (void *pvObject)
	Returns the buffer with the computed scaled correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!
float *	GetPearsonCoefficientSumsCC (void *pvObject)
	Returns the sum of valid Pearson coefficients of correlation for each bin of the correlogram.
int *	GetPearsonCoefficientCountsCC (void *pvObject)
int *	GetDistributionOfCorrelationCoefficientsCC (void *pvObject, int &piNumberOfBins, float &pfBinSize)
	Returns the distribution of coefficients of correlation.
int	ScaledCorrelationModifyScaleWindowCC (void *pvObject, int piNewScale)
	Changes the scale segment size for the scaled correlation.
int	ScaledCorrelationModifyCorrelationWindowCC (void *pvObject, int piNewCorrelationWindow)
	Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.
int	ScaledCorrelationModifyTrialLengthCC (void *pvObject, int piNewTrialLength)
	Set the length of the trial in original sampling units.
int	ScaledCorrelationModifyAllParametersCC (void *pvObject, int piNewScale, int piNewCorrelationWindow, int piNewTrialLength)
	Sets all parameters at once.
int	ScaledCorrelationGetScaleWindowCC (void *pvObject)
	Get the size of the current scale window.
int	ScaledCorrelationGetCorrelationWindowCC (void *pvObject)
	Get the size of the correlation window.
int	ScaledCorrelationGetTrialLengthCC (void *pvObject)
	Get the trial length in original sampling units.
int	GetDistributionOfCorrelationCoefficientsBinNrCC (void *pvObject)
	Get the number of bins of the distribution of coefficients of correlation.
float	GetDistributionOfCorrelationCoefficientsBinSizeCC (void *pvObject)
	Get the size of a bin of the distribution of coefficients of correlation.
void *	CreateScaledCorrelationComputerBC (int piScaleWindow, int piCorrelationWindow, int piTrialLength, int &piIsError)
	Creates an object that computes scaled correlation on a pair of binary - continuous signals.
void	FreeScaledCorrelationComputerBC (void *pvObject)
	Destructor for scaled correlation objects on binary-continuous input pairs; always call this to cleanup your data space.
void	ComputeScaledCorrelationBC (void pvObject, int piaTimeStampsA, int piNrTimeStampsInA, float *pfaSamplesB, int piNrSamplesInB, int pbUseFisherZTransform)
	Compute the scaled correlation of one binary signal with one continuos signal.
float *	GetScaledCrossCorrelogramBC (void *pvObject)
	Returns the buffer with the computed scaled correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!
float *	GetPBsCoefficientSumsBC (void *pvObject)
	Returns the sum of valid Point Biserial coefficients of correlation for each bin of the correlogram.
int *	GetPBsCoefficientCountsBC (void *pvObject)
	Returns how many Point Biserial coefficients of correlation have been averaged for each bin of the scaled cross correlogram.
int *	GetDistributionOfCorrelationCoefficientsBC (void *pvObject, int &piNumberOfBins, float &pfBinSize)
	Returns the distribution of coefficients of correlation.
int	ScaledCorrelationModifyScaleWindowBC (void *pvObject, int piNewScale)
	Changes the scale window for the scaled correlation.
int	ScaledCorrelationModifyCorrelationWindowBC (void *pvObject, int piNewCorrelationWindow)
	Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter;.
int	ScaledCorrelationModifyTrialLengthBC (void *pvObject, int piNewTrialLength)
	Set the length of the trial in original sampling units.
int	ScaledCorrelationModifyAllParametersBC (void *pvObject, int piNewScale, int piNewCorrelationWindow, int piNewTrialLength)
	Sets all parameters at once.
int	ScaledCorrelationGetScaleWindowBC (void *pvObject)
	Get the size of the current scale window.
int	ScaledCorrelationGetCorrelationWindowBC (void *pvObject)
	Get the size of the correlation window.
int	ScaledCorrelationGetTrialLengthBC (void *pvObject)
	Get the trial length in original sampling units.
int	GetDistributionOfCorrelationCoefficientsBinNrBC (void *pvObject)
	Get the number of bins of the distribution of coefficients of correlation.
float	GetDistributionOfCorrelationCoefficientsBinSizeBC (void *pvObject)
	Get the size of a bin of the distribution of coefficients of correlation.
void *	CreateCrossCorrelationComputerBB (int piCorrelationWindow, int piTrialLength, int &piIsError)
	Creates an object that computes cross-correlation on a pair of binary - binary signals.
void	FreeCrossCorrelationComputerBB (void *pvObject)
	Destructor for cross-correlation objects on binary-binary input pairs; always call this to cleanup your data space.
void	ComputeCrossCorrelationBB (void pvObject, int piaTimeStampsA, int piNrTimeStampsInA, int *piaTimeStampsB, int piNrTimeStampsInB, int pbNormalizeCorrelogram)
	Compute the cross-correlation of two vectors of time stamps.
void	ComputeWindowedCrossCorrelationPerTrialBB (void pvObject, int piaTimeStampsA, int piNrTimeStampsInA, int *piaTimeStampsB, int piNrTimeStampsInB, int piFromOffsetInTrial, int piToOffsetInTrial, int pbNormalizeCorrelogram)
	Compute the cross-correlation of two vectors of time stamps, on a partial window of the trial. ONLY ACCEPTS ONE TRIAL!!!
float *	GetCrossCorrelogramBB (void *pvObject)
	Returns the buffer with the computed cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!
int	CrossCorrelationModifyCorrelationWindowBB (void *pvObject, int piNewCorrelationWindow)
	Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.
int	CrossCorrelationModifyTrialLengthBB (void *pvObject, int piNewTrialLength)
	Set the length of the trial in original sampling units.
int	CrossCorrelationModifyAllParametersBB (void *pvObject, int piNewCorrelationWindow, int piNewTrialLength)
	Sets all parameters at once.
int	CrossCorrelationGetCorrelationWindowBB (void *pvObject)
	Get the size of the correlation window.
int	CrossCorrelationGetTrialLengthBB (void *pvObject)
	Get the trial length in original sampling units.
void *	CreateCrossCorrelationComputerCC (int piCorrelationWindow, int piTrialLength, int &piIsError)
	Creates an object that computes cross-correlation on a pair of continuous - continuous signals.
void	FreeCrossCorrelationComputerCC (void *pvObject)
	Destructor for cross-correlation objects on continuous-continuous input pairs; always call this to cleanup your data space.
void	ComputeCrossCorrelationCC (void pvObject, float pfaSamplesA, int piNrSamplesInA, float *pfaSamplesB, int piNrSamplesInB, int piNormalizationFlag)
	Compute the cross-correlation of two vectors of samples.
void	ComputeWindowedCrossCorrelationPerTrialCC (void pvObject, float pfaSamplesA, int piNrSamplesInA, float *pfaSamplesB, int piNrSamplesInB, int piFromOffsetInTrial, int piToOffsetInTrial, int piNormalizationFlag)
	Compute the cross-correlation of two digitized continuous signals, on a partial window of the trial.
float *	GetCrossCorrelogramCC (void *pvObject)
	Returns the buffer with the computed cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!
int	CrossCorrelationModifyCorrelationWindowCC (void *pvObject, int piNewCorrelationWindow)
	Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.
int	CrossCorrelationModifyTrialLengthCC (void *pvObject, int piNewTrialLength)
	Set the length of the trial in original sampling units.
int	CrossCorrelationModifyAllParametersCC (void *pvObject, int piNewCorrelationWindow, int piNewTrialLength)
	Sets all parameters at once.
int	CrossCorrelationGetCorrelationWindowCC (void *pvObject)
	Get the size of the correlation window.
int	CrossCorrelationGetTrialLengthCC (void *pvObject)
	Get the trial length in original sampling units.
void *	CreateCrossCorrelationComputerBC (int piCorrelationWindow, int piTrialLength, int &piIsError)
	Creates an object that computes cross-correlation on a pair of binary - continuous signals.
void	FreeCrossCorrelationComputerBC (void *pvObject)
	Destructor for cross-correlation objects on binary-continuous input pairs; always call this to cleanup your data space.
void	ComputeCrossCorrelationBC (void pvObject, int piaTimeStampsA, int piNrTimeStampsInA, float *pfaSamplesB, int piNrSamplesInB, int pbNormalizeCorrelogram)
	Compute the cross-correlation of one binary signal with one continuos signal.
float *	GetCrossCorrelogramBC (void *pvObject)
	Returns the buffer with the computed cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!
int	CrossCorrelationModifyCorrelationWindowBC (void *pvObject, int piNewCorrelationWindow)
	Set the size of the correlation window; for example for a window of -100..+100 pass 100 as a parameter.
int	CrossCorrelationModifyTrialLengthBC (void *pvObject, int piNewTrialLength)
	Set the length of the trial in original sampling units.
int	CrossCorrelationModifyAllParametersBC (void *pvObject, int piNewCorrelationWindow, int piNewTrialLength)
	Sets all parameters at once.
int	CrossCorrelationGetCorrelationWindowBC (void *pvObject)
	Get the size of the correlation window.
int	CrossCorrelationGetTrialLengthBC (void *pvObject)
	Get the trial length in original sampling units.

Define Documentation

#define ERR_NULL_OBJECT -5

Function Documentation

void ComputeCrossCorrelationBB	(	void *	pvObject,
		int *	piaTimeStampsA,
		int	piNrTimeStampsInA,
		int *	piaTimeStampsB,
		int	piNrTimeStampsInB,
		int	pbNormalizeCorrelogram
	)

Compute the cross-correlation of two vectors of time stamps.

Parameters:

pvObject	- Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function
piaTimeStampsA	- The vector holding the time stamps of the first binary variable
piNrTimeStampsInA	- Number of time stamps in the first vector
piaTimeStampsB	- The vector holding the time stamps of the second binary variable
piNrTimeStampsInB	- Number of time stamps in the second vector
pbNormalizeCorrelogram	- Set to 1 to normalize the correlogram; normalization is made by dividing the correlogram to the number of time stamps in the first buffer (rate-normalized correlogram)

void ComputeCrossCorrelationBC	(	void *	pvObject,
		int *	piaTimeStampsA,
		int	piNrTimeStampsInA,
		float *	pfaSamplesB,
		int	piNrSamplesInB,
		int	pbNormalizeCorrelogram
	)

Compute the cross-correlation of one binary signal with one continuos signal.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function
piaTimeStampsA	- The vector holding the time stamps of the binary variable
piNrTimeStampsInA	- Number of time stamps in the first vector
pfaSamplesB	- The vector holding samples of the continuous signal
piNrSamplesInB	- Number of samples in the second vector
pbNormalizeCorrelogram	- Set to 1 to normalize the correlogram; ; normalization is made by dividing to the number of time stamps used to compute the correlogram

Warning:: The sampling frequency of the continuous and binary signals has to be the same! Also the trial lengths have to match!
The time stamps of the binary signal must match the samples of the continuous signal, i.e. the first sample of the continuous signal corresponds to time stamp 0.

void ComputeCrossCorrelationCC	(	void *	pvObject,
		float *	pfaSamplesA,
		int	piNrSamplesInA,
		float *	pfaSamplesB,
		int	piNrSamplesInB,
		int	piNormalizationFlag
	)

Compute the cross-correlation of two vectors of samples.

If the number of samples passed is larger than the size of one trial, then the signals are divided into trials and the results are eventually averaged over trials

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function
pfaSamplesA	- The vector holding the samples of the first signal
piNrSamplesInA	- Number of samples in the first vector
pfaSamplesB	- The vector holding the samples of the second signal
piNrSamplesInB	- Number of samples in the second vector
piNormalizationFlag	- Flag that decides how to normalize the correlogram: 0 - unnormalized, biased; 1 - normalized, biased; 2 - unnormalized, unbiased; 3 - normalized, unbiased; normalization removes the dependency on the length of the signals and gives values in cross-product units of the continuous variables; unbias removes the dependency on the finite length of signal windows

void ComputeScaledCorrelationBB	(	void *	pvObject,
		int *	piaTimeStampsA,
		int	piNrTimeStampsInA,
		int *	piaTimeStampsB,
		int	piNrTimeStampsInB,
		int	pbUseFisherZTransform
	)

Compute the scaled correlation of two vectors of time stamps.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piaTimeStampsA	- The vector holding the time stamps of the first binary variable
piNrTimeStampsInA	- Number of time stamps in the first vector
piaTimeStampsB	- The vector holding the time stamps of the second binary variable
piNrTimeStampsInB	- Number of time stamps in the second vector
pbUseFisherZTransform	- Set to 1 to use the Fisher Z transform to average the coefficients of correlation; set to 0 for normal computation;

void ComputeScaledCorrelationBC	(	void *	pvObject,
		int *	piaTimeStampsA,
		int	piNrTimeStampsInA,
		float *	pfaSamplesB,
		int	piNrSamplesInB,
		int	pbUseFisherZTransform
	)

Compute the scaled correlation of one binary signal with one continuos signal.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function
piaTimeStampsA	- The vector holding the time stamps of the binary variable
piNrTimeStampsInA	- Number of time stamps in the first vector
pfaSamplesB	- The vector holding samples of the continuous signal
piNrSamplesInB	- Number of samples in the second vector
pbUseFisherZTransform	- Set to 1 to use the Fisher Z transform to average the coefficients of correlation; set to 0 for normal computation;

Warning:: The sampling frequency of the continuous and binary signals has to be the same! Also the trial lengths have to match!
The time stamps of the binary signal must match the samples of the continuous signal, i.e. the first sample of the continuous signal corresponds to time stamp 0.

void ComputeScaledCorrelationCC	(	void *	pvObject,
		float *	pfaSamplesA,
		int	piNrSamplesInA,
		float *	pfaSamplesB,
		int	piNrSamplesInB,
		int	pbUseFisherZTransform
	)

Compute the scaled correlation of two digitized continuous signals.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
pfaSamplesA	- The vector holding the first signal's input samples
piNrSamplesInA	- Number of samples in the first vector
pfaSamplesB	- The vector holding the second signal's input samples
piNrSamplesInB	- Number of samples in the second vector
pbUseFisherZTransform	- Set to 1 to use the Fisher Z transform to average the coefficients of correlation; set to 0 for normal computation;

void ComputeWindowedCrossCorrelationPerTrialBB	(	void *	pvObject,
		int *	piaTimeStampsA,
		int	piNrTimeStampsInA,
		int *	piaTimeStampsB,
		int	piNrTimeStampsInB,
		int	piFromOffsetInTrial,
		int	piToOffsetInTrial,
		int	pbNormalizeCorrelogram
	)

Compute the cross-correlation of two vectors of time stamps, on a partial window of the trial. ONLY ACCEPTS ONE TRIAL!!!

Parameters:

pvObject	- Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function
piaTimeStampsA	- The vector holding the time stamps of the first binary variable
piNrTimeStampsInA	- Number of time stamps in the first vector
piaTimeStampsB	- The vector holding the time stamps of the second binary variable
piNrTimeStampsInB	- Number of time stamps in the second vector
piFromOffsetInTrial	- The start offset in the trial where the desired window starts (time stamp)
piToOffsetInTrial	- The end offset in the trial where the desired window stops (time stamp)
pbNormalizeCorrelogram	- Set to 1 to normalize the correlogram

void ComputeWindowedCrossCorrelationPerTrialCC	(	void *	pvObject,
		float *	pfaSamplesA,
		int	piNrSamplesInA,
		float *	pfaSamplesB,
		int	piNrSamplesInB,
		int	piFromOffsetInTrial,
		int	piToOffsetInTrial,
		int	piNormalizationFlag
	)

Compute the cross-correlation of two digitized continuous signals, on a partial window of the trial.

Warning:: ONLY ACCEPTS ONE TRIAL so do not pass signals longer than the size of a single trial! Subsequent trials will be discarded.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function
pfaSamplesA	- The vector holding the samples of the first signal
piNrSamplesInA	- Number of samples in the first vector
pfaSamplesB	- The vector holding the samples of the second signal
piNrSamplesInB	- Number of samples in the second vector
piFromOffsetInTrial	- The start offset in the trial where the desired window starts
piToOffsetInTrial	- The end offset in the trial where the desired window stops
piNormalizationFlag	- Flag that decides how to normalize the correlogram: 0 - unnormalized, biased; 1 - normalized, biased; 2 - unnormalized, unbiased; 3 - normalized, unbiased; normalization removes the dependency on the length of the signals and gives values in cross-product units of the continuous variables; unbias removes the dependency on the finite length of signal windows

void ComputeWindowedScaledCorrelationPerTrialBB	(	void *	pvObject,
		int *	piaTimeStampsA,
		int	piNrTimeStampsInA,
		int *	piaTimeStampsB,
		int	piNrTimeStampsInB,
		int	piFromOffsetInTrial,
		int	piToOffsetInTrial,
		int	pbUseFisherZTransform
	)

Compute the scaled correlation of two vectors of time stamps, on a partial window of the trial; ONLY ACCEPTS ONE TRIAL!!!

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piaTimeStampsA	- The vector holding the time stamps of the first binary variable
piNrTimeStampsInA	- Number of time stamps in the first vector
piaTimeStampsB	- The vector holding the time stamps of the second binary variable
piNrTimeStampsInB	- Number of time stamps in the second vector
piFromOffsetInTrial	- The start offset in the trial where the desired window starts
piToOffsetInTrial	- The end offset in the trial where the desired window stops
pbUseFisherZTransform	- Set to 1 to use the Fisher Z transform to average the coefficients of correlation; set to 0 for normal computation

void ComputeWindowedScaledCorrelationPerTrialCC	(	void *	pvObject,
		float *	pfaSamplesA,
		int	piNrSamplesInA,
		float *	pfaSamplesB,
		int	piNrSamplesInB,
		int	piFromOffsetInTrial,
		int	piToOffsetInTrial,
		int	pbUseFisherZTransform
	)

Compute the scaled correlation of two digitized continuous signals, on a partial window of the trial; ONLY ACCEPTS ONE TRIAL!!!

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
pfaSamplesA	- The vector holding the first signal's input samples
piNrSamplesInA	- Number of samples in the first vector
pfaSamplesB	- The vector holding the second signal's input samples
piNrSamplesInB	- Number of samples in the second vector
piFromOffsetInTrial	- The start offset in the trial where the desired window starts
piToOffsetInTrial	- The end offset in the trial where the desired window stops
pbUseFisherZTransform	- Set to 1 to use the Fisher Z transform to average the coefficients of correlation; set to 0 for normal computation;

void* CreateCrossCorrelationComputerBB	(	int	piCorrelationWindow,
		int	piTrialLength,
		int &	piIsError
	)

Creates an object that computes cross-correlation on a pair of binary - binary signals.

Parameters:

piCorrelationWindow	- The size of the cross-correlation window (eg. 80 for a cross-correlation with laggs from -80 to +80); use the same units as the sampling of your samples
piTrialLength	- The size of the trial in units of your samples
piIsError	- A return parameter, set to 0 on success. It is set to -1 by the constructor if there is a mismatch of window sizes and the GetCrossCorrelogramBB() function will return NULL

Returns:: An untyped pointer to the created object!

void* CreateCrossCorrelationComputerBC	(	int	piCorrelationWindow,
		int	piTrialLength,
		int &	piIsError
	)

Creates an object that computes cross-correlation on a pair of binary - continuous signals.

Parameters:

piCorrelationWindow	- The size of the cross-correlation window (eg. 80 for a cross-correlation with lags of -80..+80); use the same units as the sampling units
piTrialLength	- The size of the trial in original sampling units
piIsError	- A return parameter, set to 0 on success. It is set to -1 by the constructor if there is a mismatch of window sizes and the GetCrossCorrelogram() function will return NULL

Warning:: The sampling frequency of the continuous and binary signals has to be the same! Also the trial lengths have to match!

Returns:: An untyped pointer to the created object.

void* CreateCrossCorrelationComputerCC	(	int	piCorrelationWindow,
		int	piTrialLength,
		int &	piIsError
	)

Creates an object that computes cross-correlation on a pair of continuous - continuous signals.

Parameters:

piCorrelationWindow	- The size of the cross-correlation window (eg. 80 for a cross-correlation with laggs from -80 to +80); use the same units as the sampling of your samples
piTrialLength	- The size of the trial in units of your samples
piIsError	- A return parameter, set to 0 on success. It is set to -1 by the constructor if there is a mismatch of window sizes and the GetCrossCorrelogram() function will return NULL

Returns:: An untyped pointer to the created object.

void* CreateScaledCorrelationComputerBB	(	int	piScaleWindow,
		int	piCorrelationWindow,
		int	piTrialLength,
		int &	piIsError
	)

Creates an object that computes scaled correlation on a pair of binary - binary signals.

Parameters:

piScaleWindow	- The scale on which you compute the scaled correlation; use the same units as the sampling unit of your time stamps
piCorrelationWindow	- The size of the cross correlation window (eg. 80 for a cross correlation with lags of -80..+80); use the same units as the sampling of your time stamps
piTrialLength	- The size of the trial in units of your time stamps
piIsError	- A return parameter, set to 0 on success. It is set to -1 by the constructor if there is a mismatch of window sizes and the GetScaledCorrelogram() function will return NULL

Returns:: An untyped pointer to the created object

void* CreateScaledCorrelationComputerBC	(	int	piScaleWindow,
		int	piCorrelationWindow,
		int	piTrialLength,
		int &	piIsError
	)

Creates an object that computes scaled correlation on a pair of binary - continuous signals.

Parameters:

piScaleWindow	- The scale on which you compute the scaled correlation; use the same units as the sampling unit of your time stamps
piCorrelationWindow	- The size of the cross-correlation window (eg. 80 for a cross-correlation with lags of -80..+80); use again the same units as the sampling of your time stamps
piTrialLength	- The size of the trial in original sampling units
piIsError	- A return parameter, set to 0 on success. It is set to -1 by the constructor if there is a mismatch of window sizes and the GetScaledCorrelogram() function will return NULL

Warning:: The sampling frequency of the continuous and binary signals has to be the same! Also the trial lengths have to match!

Returns:: An untyped pointer to the created object!

void* CreateScaledCorrelationComputerCC	(	int	piScaleWindow,
		int	piCorrelationWindow,
		int	piTrialLength,
		int &	piIsError
	)

Creates an object that computes scaled correlation on a pair of continuous - continuous signals.

Parameters:

piScaleWindow	- The scale on which you compute the scaled correlation; use the same units as the sampling unit of your signals
piCorrelationWindow	- The size of the cross correlation window (eg. 80 for a cross correlation with lags of -80..+80); use again the same units as the sampling of your signals
piTrialLength	- The size of the trial in sampling units of your signals
piIsError	- A return parameter, set to 0 on success. It is set to -1 by the constructor if there is a mismatch of window sizes and the GetScaledCorrelogram() function will return NULL

Returns:: An untyped pointer to the created object

int CrossCorrelationGetCorrelationWindowBB ( void * pvObject )

Get the size of the correlation window.

Parameters:

pvObject - Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function

Returns:: The size of the correlation window

int CrossCorrelationGetCorrelationWindowBC ( void * pvObject )

Get the size of the correlation window.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function

Returns:: The size of the correlation window

int CrossCorrelationGetCorrelationWindowCC ( void * pvObject )

Get the size of the correlation window.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function

Returns:: The size of the correlation window

int CrossCorrelationGetTrialLengthBB ( void * pvObject )

Get the trial length in original sampling units.

Parameters:

pvObject - Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function

Returns:: The length of the trial in sampling units

int CrossCorrelationGetTrialLengthBC ( void * pvObject )

Get the trial length in original sampling units.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function

Returns:: The length of the trial in sampling units

int CrossCorrelationGetTrialLengthCC ( void * pvObject )

Get the trial length in original sampling units.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function

Returns:: The trial length in sampling units

int CrossCorrelationModifyAllParametersBB	(	void *	pvObject,
		int	piNewCorrelationWindow,
		int	piNewTrialLength
	)

Sets all parameters at once.

Parameters:

pvObject	- Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function
piNewCorrelationWindow	- The new correlation window
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success, -1 if the new correlation window is too small; -2 if the trial length is smaller than the correlation window

int CrossCorrelationModifyAllParametersBC	(	void *	pvObject,
		int	piNewCorrelationWindow,
		int	piNewTrialLength
	)

Sets all parameters at once.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function
piNewCorrelationWindow	- The new correlation window
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success, -1 if the new correlation window is too small; -2 if the trial length is smaller than the correlation window

int CrossCorrelationModifyAllParametersCC	(	void *	pvObject,
		int	piNewCorrelationWindow,
		int	piNewTrialLength
	)

Sets all parameters at once.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function
piNewCorrelationWindow	- The new correlation window
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success, -1 if the new correlation window is too small; -2 if the trial length is smaller than the correlation window

int CrossCorrelationModifyCorrelationWindowBB	(	void *	pvObject,
		int	piNewCorrelationWindow
	)

Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.

Parameters:

pvObject	- Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function
piNewCorrelationWindow	- The new correlation window

Returns:: Returns 0 on success, -1 if the window is too small; -2 if the window is larger than the length of the trial

int CrossCorrelationModifyCorrelationWindowBC	(	void *	pvObject,
		int	piNewCorrelationWindow
	)

Set the size of the correlation window; for example for a window of -100..+100 pass 100 as a parameter.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function
piNewCorrelationWindow	- Specifies the new correlation window

Returns:: Returns 0 on success, -1 if the window is too small; -2 if the window is larger than the length of the trial;

int CrossCorrelationModifyCorrelationWindowCC	(	void *	pvObject,
		int	piNewCorrelationWindow
	)

Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function
piNewCorrelationWindow	- Specifies the new correlation window

Returns:: Returns 0 on success, -1 if the window is too small; -2 if the window is larger than the length of the trial;

int CrossCorrelationModifyTrialLengthBB	(	void *	pvObject,
		int	piNewTrialLength
	)

Set the length of the trial in original sampling units.

Parameters:

pvObject	- Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success and -1 if the trial length is smaller than the correlation window

int CrossCorrelationModifyTrialLengthBC	(	void *	pvObject,
		int	piNewTrialLength
	)

Set the length of the trial in original sampling units.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success and -1 if the trial length is smaller than the correlation window

int CrossCorrelationModifyTrialLengthCC	(	void *	pvObject,
		int	piNewTrialLength
	)

Set the length of the trial in original sampling units.

Parameters:

pvObject	- Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success and -1 if the trial length is smaller than the correlation window

void FreeCrossCorrelationComputerBB ( void * pvObject )

Destructor for cross-correlation objects on binary-binary input pairs; always call this to cleanup your data space.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBB function

void FreeCrossCorrelationComputerBC ( void * pvObject )

Destructor for cross-correlation objects on binary-continuous input pairs; always call this to cleanup your data space.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function

void FreeCrossCorrelationComputerCC ( void * pvObject )

Destructor for cross-correlation objects on continuous-continuous input pairs; always call this to cleanup your data space.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function

void FreeScaledCorrelationComputerBB ( void * pvObject )

Destructor for scaled correlation objects on binary-binary pairs; always call this to cleanup your data space.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

void FreeScaledCorrelationComputerBC ( void * pvObject )

Destructor for scaled correlation objects on binary-continuous input pairs; always call this to cleanup your data space.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

void FreeScaledCorrelationComputerCC ( void * pvObject )

Destructor for scaled correlation objects on continuous-continuous input pairs; always call this to cleanup your data space.

Parameters:

pvObject - pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

float* GetCrossCorrelogramBB ( void * pvObject )

Returns the buffer with the computed cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!

The size of the cross correlogram buffer is (2*iCorrelationWindow+1), and element with lag 0 is at position iCorrelationWindow.

Parameters:

pvObject - Pointer to the object that computes the cross correlation; please instantiate first using the CreateCrossCorrelationComputerBB function

Returns:: Returns a pointer to the internal cross-correlation buffer. Do not write into the buffer!
The buffer is filled with NAN (Not A Number) = -100000000.0 if one of the input buffers was empty and thus the correlation was not defined; please check in your code for this!!!!

float* GetCrossCorrelogramBC ( void * pvObject )

Returns the buffer with the computed cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!

The size of the cross correlogram buffer is (2*iCorrelationWindow+1), and element with lag 0 is at position iCorrelationWindow.

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerBC function

Returns:: Returns a pointer to the internal cross-correlation buffer. Do not write into the buffer!
The buffer is filled with NAN (Not A Number) = -100000000.0 if one of the input buffers was empty and thus the correlation was not defined; please check in your code for this!!!!

float* GetCrossCorrelogramCC ( void * pvObject )

Returns the buffer with the computed cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!

The size of the cross-correlogram buffer is (2*iCorrelationWindow+1), and element with lag 0 is at position iCorrelationWindow;

Parameters:

pvObject - Pointer to the object that computes the cross-correlation; please instantiate first using the CreateCrossCorrelationComputerCC function

Returns:: Returns a pointer to the internal cross-correlation buffer. Do not write into the buffer!
The buffer is filled with NAN (Not A Number) = -100000000.0 if one of the input buffers was empty and thus the correlation was not defined; please check in your code for this!!!!

int* GetDistributionOfCorrelationCoefficientsBB	(	void *	pvObject,
		int &	piNumberOfBins,
		float &	pfBinSize
	)

Returns the distribution of coefficients of correlation.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piNumberOfBins	- The number of bins in the distribution (return parameter)
pfBinSize	- The number of bins in the distribution (return)

Returns:: - A pointer to the internal buffer that holds the distribution of correlation coefficients; - The number of bins in the distribution (piNumberOfBins); this is equal to the size of the buffer; - The size of one bin of the distribution (pfBinSize); the size of the bin is in sampling units of the original signals

int* GetDistributionOfCorrelationCoefficientsBC	(	void *	pvObject,
		int &	piNumberOfBins,
		float &	pfBinSize
	)

Returns the distribution of coefficients of correlation.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function
piNumberOfBins	- The number of bins in the distribution (output parameter)
pfBinSize	- The size of one bin of the distribution (output parameter)

Returns:: A pointer to the internal buffer that holds the distribution of correlation coefficients; The number of bins in the distribution (piNumberOfBins); this is equal to the size of the buffer; The size of one bin of the distribution (pfBinSize); the size of the bin is in sampling units of the original signals

int GetDistributionOfCorrelationCoefficientsBinNrBB ( void * pvObject )

Get the number of bins of the distribution of coefficients of correlation.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: Returns the number of bins used to compute the distribution of correlation coefficients; the value equals the size of the internal buffer that stores the distribution of correlation coefficients (see also function: GetDistributionOfCorrelationCoefficientsBB)

int GetDistributionOfCorrelationCoefficientsBinNrBC ( void * pvObject )

Get the number of bins of the distribution of coefficients of correlation.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: Returns the number of bins used to compute the distribution of correlation coefficients; the value equals the size of the internal buffer that stores the distribution of correlation coefficients (see also function: GetDistributionOfCorrelationCoefficients)

int GetDistributionOfCorrelationCoefficientsBinNrCC ( void * pvObject )

Get the number of bins of the distribution of coefficients of correlation.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: Returns the number of bins used to compute the distribution of correlation coefficients; the value equals the size of the internal buffer that stores the distribution of correlation coefficients (see also function: GetDistributionOfCorrelationCoefficientsCC)

float GetDistributionOfCorrelationCoefficientsBinSizeBB ( void * pvObject )

Get the size of a bin of the distribution of coefficients of correlation.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: Returns the size of the bins used to compute the distribution of correlation coefficients (see also function: GetDistributionOfCorrelationCoefficientsBB)

float GetDistributionOfCorrelationCoefficientsBinSizeBC ( void * pvObject )

Get the size of a bin of the distribution of coefficients of correlation.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: Returns the size of the bins used to compute the distribution of correlation coefficients (see also function: GetDistributionOfCorrelationCoefficients)

float GetDistributionOfCorrelationCoefficientsBinSizeCC ( void * pvObject )

Get the size of a bin of the distribution of coefficients of correlation.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: Returns the size of the bins used to compute the distribution of correlation coefficients (see also function: GetDistributionOfCorrelationCoefficientsCC)

int* GetDistributionOfCorrelationCoefficientsCC	(	void *	pvObject,
		int &	piNumberOfBins,
		float &	pfBinSize
	)

Returns the distribution of coefficients of correlation.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
piNumberOfBins	- The number of bins in the distribution (output parameter)
pfBinSize	- The size of one bin of the distribution (output parameter)

Returns:: A pointer to the internal buffer that holds the distribution of correlation coefficients; The number of bins in the distribution (piNumberOfBins); this is equal to the size of the buffer; The size of one bin of the distribution (pfBinSize); the size of the bin is in sampling units of the original signals

int* GetFiCoefficientCountsBB ( void * pvObject )

Returns how many Fi coefficients of correlation have been averaged for each bin of the scaled cross correlogram.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: A pointer to the internal buffer containing the counts of "Fi" correlation coefficients averaged for each bin. The size of the buffer is (2*iCorrelationWindow+1), and the count of valid Fi coefficients, that were averaged to compute the scaled cross correlogram at lag 0, is at position iCorrelationWindow

float* GetFiCoefficientSumsBB ( void * pvObject )

Returns the sum of valid Fi coefficients of correlation for each bin of the correlogram.

The size of the buffer is (2*iCorrelationWindow+1), and the sum of coefficients for lag 0 is at position iCorrelationWindow. Use this function to get the sum of all valid coefficients that were used to compute the average correlation coefficient for each bin of the ScaledCrossCorrelogram: ScaledCrossCorrelogram[i] = FiCoefficientSums[i] / FiCoefficientCounts[i].

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: A pointer to a buffer holding the sum of correlation coefficients for each bin (without dividing them to the counts; the scaled correlogram = the sum of coefficients / the count of coefficients).

Warning:: If no valid coefficient was found for a given bin, the buffer containes a value of NAN at that position. Please check for this in the code!

int* GetPBsCoefficientCountsBC ( void * pvObject )

Returns how many Point Biserial coefficients of correlation have been averaged for each bin of the scaled cross correlogram.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: A pointer to the internal buffer containing the counts of Point Biserial correlation coefficients averaged for each bin. The size of the buffer is (2*iCorrelationWindow+1), and the count of valid Point Biserial coefficients, that were averaged to compute the scaled correlogram at lag 0, is at position iCorrelationWindow

float* GetPBsCoefficientSumsBC ( void * pvObject )

Returns the sum of valid Point Biserial coefficients of correlation for each bin of the correlogram.

The size of the buffer is (2*iCorrelationWindow+1), and the sum of coefficients for lag 0 is at position iCorrelationWindow. Use this function to get the sum of all valid coefficients that were used to compute the average correlation coefficient for each bin of the ScaledCrossCorrelogram: ScaledCrossCorrelogram[i] = PBsCoefficientSums[i] / PBsCoefficientCounts[i].

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: A pointer to a buffer holding the sum of correlation coefficients for each bin (without dividing them to the counts; the scaled correlogram = the sum of coefficients / the count of coefficients).

Warning:: If no valid coefficient was found for a given bin, the buffer containes a value of NAN at that position. Please check for this in the code!

int* GetPearsonCoefficientCountsCC ( void * pvObject )

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: A pointer to the internal buffer containing the counts of correlation coefficients averaged for each bin. The size of the buffer is (2*iCorrelationWindow+1), and the count of coefficients that were averaged for lag 0 is at position iCorrelationWindow.

float* GetPearsonCoefficientSumsCC ( void * pvObject )

Returns the sum of valid Pearson coefficients of correlation for each bin of the correlogram.

The size of the buffer is (2*iCorrelationWindow+1), and the sum of coefficients for lag 0 is at position iCorrelationWindow. Use this function to get the sum of all valid coefficients that were used to compute the average correlation coefficient for each bin of the ScaledCrossCorrelogram: ScaledCrossCorrelogram[i] = PearsonCoefficientSums[i] / PearsonCoefficientCounts[i].

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: A pointer to a buffer holding the sum of correlation coefficients for each bin (without dividing them to the counts; the scaled correlogram = the sum of coefficients / the count of coefficients).

Warning:: If no valid coefficient was found for a given bin, the buffer containes a value of NAN at that position. Please check for this in the code!

float* GetScaledCrossCorrelogramBB ( void * pvObject )

Returns the buffer with the computed scaled-cross-correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!

The size of the scaled correlogram buffer is (2*iCorrelationWindow+1), and element with lag 0 is at position iCorrelationWindow;

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: Returns a pointer to the internal scaled correlation buffer. Do not write into the buffer!
The buffer has a NotANumber (NAN = -100000000.0) value for bins where correlation could not be defined because of lack of variance in the input vectors

float* GetScaledCrossCorrelogramBC ( void * pvObject )

Returns the buffer with the computed scaled correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!

The size of the scaled correlogram buffer is (2*iCorrelationWindow+1), and element with lag 0 is at position iCorrelationWindow;

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: Returns a pointer to the internal scaled correlation buffer. Do not write into the buffer!
The buffer has a NotANumber (NAN = -100000000.0) value for bins where correlation could not be defined because of lack of variance in the original signals.

float* GetScaledCrossCorrelogramCC ( void * pvObject )

Returns the buffer with the computed scaled correlogram; returns NULL if there was an error; please check the buffer for NULL before using it!!

The size of the scaled correlogram buffer is (2*iCorrelationWindow+1), and element with lag 0 is at position iCorrelationWindow;

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: Returns a pointer to the internal scaled correlation buffer. Do not write into the buffer!
The buffer has a NotANumber (NAN = -100000000.0) value for bins where correlation could not be defined because of lack of variance in the input signals

int ScaledCorrelationGetCorrelationWindowBB ( void * pvObject )

Get the size of the correlation window.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: Returns the size of the correlation window

int ScaledCorrelationGetCorrelationWindowBC ( void * pvObject )

Get the size of the correlation window.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: Returns the size of the correlation window

int ScaledCorrelationGetCorrelationWindowCC ( void * pvObject )

Get the size of the correlation window.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: Returns the size of the correlation window

int ScaledCorrelationGetScaleWindowBB ( void * pvObject )

Get the size of the current scale window.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: Returns the size of the scale segment window

int ScaledCorrelationGetScaleWindowBC ( void * pvObject )

Get the size of the current scale window.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: Returns the size of the scale segment window

int ScaledCorrelationGetScaleWindowCC ( void * pvObject )

Get the size of the current scale window.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: Returns the size of the scale segment window

int ScaledCorrelationGetTrialLengthBB ( void * pvObject )

Get the trial length in original sampling units.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function

Returns:: Returns the length of the trial in original sampling units

int ScaledCorrelationGetTrialLengthBC ( void * pvObject )

Get the trial length in original sampling units.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function

Returns:: Returns the length of the trial in original sampling units

int ScaledCorrelationGetTrialLengthCC ( void * pvObject )

Get the trial length in original sampling units.

Parameters:

pvObject - Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function

Returns:: Returns the length of the trial in original sampling units

int ScaledCorrelationModifyAllParametersBB	(	void *	pvObject,
		int	piNewScale,
		int	piNewCorrelationWindow,
		int	piNewTrialLength
	)

Sets all parameters at once.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piNewScale	- The new size of the scale segment
piNewCorrelationWindow	- The new size of the correlation window
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success, -1 if the new scale window is too small; -2 if the new correlation window is too small; -3 if the new scale window is larger than the trial size; -4 if the trial length is smaller than the correlation window

int ScaledCorrelationModifyAllParametersBC	(	void *	pvObject,
		int	piNewScale,
		int	piNewCorrelationWindow,
		int	piNewTrialLength
	)

Sets all parameters at once.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function
piNewScale	- The new size of the scale segment
piNewCorrelationWindow	- The new size of the correlation window
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success, -1 if the new scale window is too small; -2 if the new correlation window is too small; -3 if the new scale window is larger than the trial size; -4 if the trial length is smaller than the correlation window

int ScaledCorrelationModifyAllParametersCC	(	void *	pvObject,
		int	piNewScale,
		int	piNewCorrelationWindow,
		int	piNewTrialLength
	)

Sets all parameters at once.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
piNewScale	- The new size of the scale segment
piNewCorrelationWindow	- The new size of the correlation window
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success, -1 if the new scale window is too small; -2 if the new correlation window is too small; -3 if the new scale window is larger than the trial size; -4 if the trial length is smaller than the correlation window

int ScaledCorrelationModifyCorrelationWindowBB	(	void *	pvObject,
		int	piNewCorrelationWindow
	)

Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piNewCorrelationWindow	- The new size of the correlation window

Returns:: Returns 0 on success, -1 if the window is too small; -2 if the window is larger than the length of the trial

int ScaledCorrelationModifyCorrelationWindowBC	(	void *	pvObject,
		int	piNewCorrelationWindow
	)

Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter;.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function
piNewCorrelationWindow	- The new size of the correlation window

Returns:: Returns 0 on success, -1 if the window is too small; -2 if the window is larger than the length of the trial

int ScaledCorrelationModifyCorrelationWindowCC	(	void *	pvObject,
		int	piNewCorrelationWindow
	)

Set the size of the correlation window; the parameter specifies the correlation window; for example for a window of -100..+100 pass 100 as a parameter.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
piNewCorrelationWindow	- The new size of the correlation window

Returns:: Returns 0 on success, -1 if the window is too small; -2 if the window is larger than the length of the trial

int ScaledCorrelationModifyScaleWindowBB	(	void *	pvObject,
		int	piNewScale
	)

Changes the scale window for the scaled correlation;.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piNewScale	- The new size of the scale segment

Returns:: Returns 0 on success, -1 if the scale window is too small; -2 if the new scale window is larger than the trial size

int ScaledCorrelationModifyScaleWindowBC	(	void *	pvObject,
		int	piNewScale
	)

Changes the scale window for the scaled correlation.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function
piNewScale	- The new size of the scale segment

Returns:: Returns 0 on success, -1 if the scale window is too small; -2 if the new scale window is larger than the trial size

int ScaledCorrelationModifyScaleWindowCC	(	void *	pvObject,
		int	piNewScale
	)

Changes the scale segment size for the scaled correlation.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
piNewScale	- The new size of the scale segment

Returns:: Returns 0 on success, -1 if the scale window is too small; -2 if the new scale window is larger than the trial size

int ScaledCorrelationModifyTrialLengthBB	(	void *	pvObject,
		int	piNewTrialLength
	)

Set the length of the trial in original sampling units.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBB function
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success and -1 if the trial length is smaller than the scale window; -2 if the trial length is smaller than the correlation window

int ScaledCorrelationModifyTrialLengthBC	(	void *	pvObject,
		int	piNewTrialLength
	)

Set the length of the trial in original sampling units.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerBC function
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success and -1 if the trial length is smaller than the scale window; -2 if the trial length is smaller than the correlation window

int ScaledCorrelationModifyTrialLengthCC	(	void *	pvObject,
		int	piNewTrialLength
	)

Set the length of the trial in original sampling units.

Parameters:

pvObject	- Pointer to the object that computes the scaled correlation; please instantiate first using the CreateScaledCorrelationComputerCC function
piNewTrialLength	- The new length of the trial

Returns:: Returns 0 on success and -1 if the trial length is smaller than the scale window; -2 if the trial length is smaller than the correlation window

Defines

Functions

Define Documentation

Function Documentation