ClustersProvider Class Reference

Class storing and providing the cluster information. More...

#include <clustersprovider.h>

Inheritance diagram for ClustersProvider:

[legend]Collaboration diagram for ClustersProvider:

[legend]List of all members.

Public Types
enum	loadReturnMessage {   OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3, COUNT_ERROR = 4,   INCORRECT_CONTENT = 5, OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3,   COUNT_ERROR = 4, INCORRECT_CONTENT = 5 }
	Information retun after a call to openFile/saveDocument/createFeatureFile.
enum	loadReturnMessage {   OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3, COUNT_ERROR = 4,   INCORRECT_CONTENT = 5, OK = 0, OPEN_ERROR = 1, MISSING_FILE = 3,   COUNT_ERROR = 4, INCORRECT_CONTENT = 5 }
	Information retun after a call to openFile/saveDocument/createFeatureFile.
Signals
void	dataReady (Array< dataType > &data, QObject *initiator, QString providerName)
	Signals that the data have been retrieved.
void	nextClusterDataReady (Array< dataType > &data, QObject *initiator, QString providerName, long startingTime, long startingTimeInRecordingUnits)
	Signals that the data for the next cluster have been retrieved.
void	previousClusterDataReady (Array< dataType > &data, QObject *initiator, QString providerName, long startingTime, long startingTimeInRecordingUnits)
	Signals that the data for the previous cluster have been retrieved.
void	dataReady (Array< dataType > &data, QObject *initiator, QString providerName)
	Signals that the data have been retrieved.
void	nextClusterDataReady (Array< dataType > &data, QObject *initiator, QString providerName, long startingTime, long startingTimeInRecordingUnits)
	Signals that the data for the next cluster have been retrieved.
void	previousClusterDataReady (Array< dataType > &data, QObject *initiator, QString providerName, long startingTime, long startingTimeInRecordingUnits)
	Signals that the data for the previous cluster have been retrieved.
Public Member Functions
	ClustersProvider (KURL fileUrl, double samplingRate, double currentSamplingRate, dataType fileMaxTime, int position=25)
	Constructor.
void	requestData (long startTime, long endTime, QObject *initiator, long startTimeInRecordingUnits)
	Triggers the retrieve of the cluster information included in the time interval given by startTime and endTime.
void	requestNextClusterData (long startTime, long timeFrame, QValueList< int > selectedIds, QObject *initiator, long startTimeInRecordingUnits)
	Looks up for the first of the clusters included in the list selectedIds existing after the time startTime.
void	requestPreviousClusterData (long startTime, long timeFrame, QValueList< int > selectedIds, QObject *initiator, long startTimeInRecordingUnits)
	Looks up for the first of the clusters included in the list selectedIds existing before the time endTime.
int	loadData ()
	Loads the cluster ids and the corresponding spike time.
QValueList< int >	clusterIdList () const
	Returns list of cluster Ids.
QString	getName () const
	Returns the name of the provider which is the cluster file number.
void	setClusterPosition (int position)
	Sets the position where the clusters are display when browsing.
void	updateSamplingRate (double rate)
	Updates the sampling rate for the current document.
void	updateAcquisitionSystemSamplingRate (double rate, double currentSamplingRate)
	Updates the acquisition system sampling rate.
	ClustersProvider (KURL fileUrl, double samplingRate, double currentSamplingRate, dataType fileMaxTime, int position=25)
	Constructor.
void	requestData (long startTime, long endTime, QObject *initiator, long startTimeInRecordingUnits)
	Triggers the retrieve of the cluster information included in the time interval given by startTime and endTime.
void	requestNextClusterData (long startTime, long timeFrame, QValueList< int > selectedIds, QObject *initiator, long startTimeInRecordingUnits)
	Looks up for the first of the clusters included in the list selectedIds existing after the time startTime.
void	requestPreviousClusterData (long startTime, long timeFrame, QValueList< int > selectedIds, QObject *initiator, long startTimeInRecordingUnits)
	Looks up for the first of the clusters included in the list selectedIds existing before the time endTime.
int	loadData ()
	Loads the cluster ids and the corresponding spike time.
QValueList< int >	clusterIdList () const
	Returns list of cluster Ids.
QString	getName () const
	Returns the name of the provider which is the cluster file number.
void	setClusterPosition (int position)
	Sets the position where the clusters are display when browsing.
void	updateSamplingRate (double rate)
	Updates the sampling rate for the current document.
void	updateAcquisitionSystemSamplingRate (double rate, double currentSamplingRate)
	Updates the acquisition system sampling rate.

---

Detailed Description

Class storing and providing the cluster information.

Author:

Lynn Hazan

---

Constructor & Destructor Documentation

ClustersProvider::ClustersProvider	(	KURL	fileUrl,
		double	samplingRate,
		double	currentSamplingRate,
		dataType	fileMaxTime,
		int	position = 25
	)

Constructor.

Parameters:

	fileUrl	the url of the cluster file containing the cluster ids.
	samplingRate	sampling rate used to record the data (of the acquisition system).
	currentSamplingRate	sampling rate of the current file.
	fileMaxTime	maximum time of the current file in recording units.
	position	represents the percentage from the begining of the window where the clusters are display when browsing.

ClustersProvider::ClustersProvider	(	KURL	fileUrl,
		double	samplingRate,
		double	currentSamplingRate,
		dataType	fileMaxTime,
		int	position = 25
	)

Constructor.

Parameters:

	fileUrl	the url of the cluster file containing the cluster ids.
	samplingRate	sampling rate used to record the data (of the acquisition system).
	currentSamplingRate	sampling rate of the current file.
	fileMaxTime	maximum time of the current file in recording units.
	position	represents the percentage from the begining of the window where the clusters are display when browsing.

---

Member Function Documentation

void ClustersProvider::requestData	(	long	startTime,
		long	endTime,
		QObject *	initiator,
		long	startTimeInRecordingUnits
	)			[virtual]

Triggers the retrieve of the cluster information included in the time interval given by startTime and endTime.

Parameters:

	startTime	begining of the time interval from which to retrieve the data in miliseconds.
	endTime	end of the time interval from which to retrieve the data.
	initiator	instance requesting the data.
	startTimeInRecordingUnits	begining of the time interval from which to retrieve the data in recording units.

Reimplemented from DataProvider.

void ClustersProvider::requestNextClusterData	(	long	startTime,
		long	timeFrame,
		QValueList< int >	selectedIds,
		QObject *	initiator,
		long	startTimeInRecordingUnits
	)

Looks up for the first of the clusters included in the list selectedIds existing after the time startTime.

All the clusters included in the time interval given by timeFrame are retrieved. The time interval start time is computed in order to have the first cluster found located at clusterPosition percentage of the time interval.

Parameters:

	startTime	starting time, in miliseconds, for the look up.
	timeFrame	time interval for which to retrieve the data.
	selectedIds	list of cluster ids to look up for.
	initiator	instance requesting the data.
	startTimeInRecordingUnits	starting time, in recording units, for the look up.

void ClustersProvider::requestPreviousClusterData	(	long	startTime,
		long	timeFrame,
		QValueList< int >	selectedIds,
		QObject *	initiator,
		long	startTimeInRecordingUnits
	)

Looks up for the first of the clusters included in the list selectedIds existing before the time endTime.

All the clusters included in the time interval given by timeFrame are retrieved. The time interval start time is computed in order to have the first cluster found located at clusterPosition percentage of the time interval.

Parameters:

	startTime	starting time, in miliseconds, for the look up.
	timeFrame	time interval for which to retrieve the data.
	selectedIds	list of cluster ids to look up for.
	initiator	instance requesting the data.
	startTimeInRecordingUnits	starting time, in recording units, for the look up.

int ClustersProvider::loadData

(

)

Loads the cluster ids and the corresponding spike time.

Returns:

an loadReturnMessage enum giving the load status

QValueList<int> ClustersProvider::clusterIdList

(

)

const [inline]

Returns list of cluster Ids.

Returns:

QString ClustersProvider::getName

(

)

const [inline]

Returns the name of the provider which is the cluster file number.

Returns:

provider'name.

void ClustersProvider::setClusterPosition

(

int

position

)

[inline]

Sets the position where the clusters are display when browsing.

Parameters:

position

percentage from the begining of the window.

void ClustersProvider::updateSamplingRate

(

double

rate

)

[inline]

Updates the sampling rate for the current document.

Parameters:

rate

sampling rate.

void ClustersProvider::updateAcquisitionSystemSamplingRate	(	double	rate,
		double	currentSamplingRate
	)			[inline]

Updates the acquisition system sampling rate.

Parameters:

	rate	acquisition system sampling rate.
	currentSamplingRate	sampling rate for the current document.

void ClustersProvider::dataReady	(	Array< dataType > &	data,
		QObject *	initiator,
		QString	providerName
	)			[signal]

Signals that the data have been retrieved.

Parameters:

	data	2 line array containing the sample index of the peak index of each spike existing in the requested time frame with the corresponding cluster id. The first line contains the sample index and the second line the cluster id.
	initiator	instance requesting the data.
	providerName	name of the instance providing the data.

void ClustersProvider::nextClusterDataReady	(	Array< dataType > &	data,
		QObject *	initiator,
		QString	providerName,
		long	startingTime,
		long	startingTimeInRecordingUnits
	)			[signal]

Signals that the data for the next cluster have been retrieved.

Parameters:

	data	2 line array containing the sample index of the peak index of each spike existing in the requested time frame with the corresponding cluster id. The first line contains the sample index and the second line the cluster id.
	initiator	instance requesting the data.
	providerName	name of the instance providing the data.
	startingTime	time from which the data have been retrieved in miliseconds.
	startingTimeInRecordingUnits	time from which the data have been retrieved in recording units.

void ClustersProvider::previousClusterDataReady	(	Array< dataType > &	data,
		QObject *	initiator,
		QString	providerName,
		long	startingTime,
		long	startingTimeInRecordingUnits
	)			[signal]

Signals that the data for the previous cluster have been retrieved.

Parameters:

	data	2 line array containing the sample index of the peak index of each spike existing in the requested time frame with the corresponding cluster id. The first line contains the sample index and the second line the cluster id.
	initiator	instance requesting the data.
	providerName	name of the instance providing the data.
	startingTime	time from which the data have been retrieved.
	startingTimeInRecordingUnits	time from which the data have been retrieved in recording units.

void ClustersProvider::requestData	(	long	startTime,
		long	endTime,
		QObject *	initiator,
		long	startTimeInRecordingUnits
	)			[virtual]

Triggers the retrieve of the cluster information included in the time interval given by startTime and endTime.

Parameters:

	startTime	begining of the time interval from which to retrieve the data in miliseconds.
	endTime	end of the time interval from which to retrieve the data.
	initiator	instance requesting the data.
	startTimeInRecordingUnits	begining of the time interval from which to retrieve the data in recording units.

Reimplemented from DataProvider.

void ClustersProvider::requestNextClusterData	(	long	startTime,
		long	timeFrame,
		QValueList< int >	selectedIds,
		QObject *	initiator,
		long	startTimeInRecordingUnits
	)

Looks up for the first of the clusters included in the list selectedIds existing after the time startTime.

All the clusters included in the time interval given by timeFrame are retrieved. The time interval start time is computed in order to have the first cluster found located at clusterPosition percentage of the time interval.

Parameters:

	startTime	starting time, in miliseconds, for the look up.
	timeFrame	time interval for which to retrieve the data.
	selectedIds	list of cluster ids to look up for.
	initiator	instance requesting the data.
	startTimeInRecordingUnits	starting time, in recording units, for the look up.

void ClustersProvider::requestPreviousClusterData	(	long	startTime,
		long	timeFrame,
		QValueList< int >	selectedIds,
		QObject *	initiator,
		long	startTimeInRecordingUnits
	)

Looks up for the first of the clusters included in the list selectedIds existing before the time endTime.

All the clusters included in the time interval given by timeFrame are retrieved. The time interval start time is computed in order to have the first cluster found located at clusterPosition percentage of the time interval.

Parameters:

	startTime	starting time, in miliseconds, for the look up.
	timeFrame	time interval for which to retrieve the data.
	selectedIds	list of cluster ids to look up for.
	initiator	instance requesting the data.
	startTimeInRecordingUnits	starting time, in recording units, for the look up.

int ClustersProvider::loadData

(

)

Loads the cluster ids and the corresponding spike time.

Returns:

an loadReturnMessage enum giving the load status

QValueList<int> ClustersProvider::clusterIdList

(

)

const [inline]

Returns list of cluster Ids.

Returns:

QString ClustersProvider::getName

(

)

const [inline]

Returns the name of the provider which is the cluster file number.

Returns:

provider'name.

void ClustersProvider::setClusterPosition

(

int

position

)

[inline]

Sets the position where the clusters are display when browsing.

Parameters:

position

percentage from the begining of the window.

void ClustersProvider::updateSamplingRate

(

double

rate

)

[inline]

Updates the sampling rate for the current document.

Parameters:

rate

sampling rate.

void ClustersProvider::updateAcquisitionSystemSamplingRate	(	double	rate,
		double	currentSamplingRate
	)			[inline]

Updates the acquisition system sampling rate.

Parameters:

	rate	acquisition system sampling rate.
	currentSamplingRate	sampling rate for the current document.

void ClustersProvider::dataReady	(	Array< dataType > &	data,
		QObject *	initiator,
		QString	providerName
	)			[signal]

Signals that the data have been retrieved.

Parameters:

	data	2 line array containing the sample index of the peak index of each spike existing in the requested time frame with the corresponding cluster id. The first line contains the sample index and the second line the cluster id.
	initiator	instance requesting the data.
	providerName	name of the instance providing the data.

void ClustersProvider::nextClusterDataReady	(	Array< dataType > &	data,
		QObject *	initiator,
		QString	providerName,
		long	startingTime,
		long	startingTimeInRecordingUnits
	)			[signal]

Signals that the data for the next cluster have been retrieved.

Parameters:

	data	2 line array containing the sample index of the peak index of each spike existing in the requested time frame with the corresponding cluster id. The first line contains the sample index and the second line the cluster id.
	initiator	instance requesting the data.
	providerName	name of the instance providing the data.
	startingTime	time from which the data have been retrieved in miliseconds.
	startingTimeInRecordingUnits	time from which the data have been retrieved in recording units.

void ClustersProvider::previousClusterDataReady	(	Array< dataType > &	data,
		QObject *	initiator,
		QString	providerName,
		long	startingTime,
		long	startingTimeInRecordingUnits
	)			[signal]

Signals that the data for the previous cluster have been retrieved.

Parameters:

	data	2 line array containing the sample index of the peak index of each spike existing in the requested time frame with the corresponding cluster id. The first line contains the sample index and the second line the cluster id.
	initiator	instance requesting the data.
	providerName	name of the instance providing the data.
	startingTime	time from which the data have been retrieved.
	startingTimeInRecordingUnits	time from which the data have been retrieved in recording units.

---

The documentation for this class was generated from the following files:

• debug/src/clustersprovider.h
• src/clustersprovider.h
• debug/src/clustersprovider.cpp
• debug/src/clustersprovider.moc.cpp
• src/clustersprovider.cpp
• src/clustersprovider.moc.cpp

---