TracesProvider Class Reference

Class providing the row recorded data (contained in a .dat or .eeg file). More...

#include <tracesprovider.h>

Inheritance diagram for TracesProvider:

[legend]Collaboration diagram for TracesProvider:

[legend]List of all members.

Signals
void	dataReady (Array< dataType > &data, QObject *initiator)
	Signals that the data have been retrieved.
void	dataReady (Array< dataType > &data, QObject *initiator)
	Signals that the data have been retrieved.
Public Member Functions
	TracesProvider (KURL fileUrl, int nbChannels, int resolution, double samplingRate, int offset)
	Constructor.
void	requestData (long startTime, long endTime, QObject *initiator, long startTimeInRecordingUnits)
	Triggers the retrieve of the traces included in the time rate given by startTime and endTime.
void	setNbChannels (int nb)
	Sets the number of channels corresponding to the file identified by fileUrl.
void	setResolution (int res)
	Sets the resolution used to record the data contained in the file identified by fileUrl.
void	setSamplingRate (double rate)
	Sets the sampling rate used to record the data contained in the file identified by fileUrl.
void	setOffset (int newOffset)
	Sets the offset to apply to the data contained in the file identified by fileUrl.
int	getNbChannels () const
	Returns the number of channels corresponding to the file identified by fileUrl.
int	getResolution () const
	Returns the resolution used to record the data contained in the file identified by fileUrl.
double	getSamplingRate () const
	Returns the sampling rate used to record the data contained in the file identified by fileUrl.
int	getOffset () const
	Returns the offset to apply to the data contained in the file identified by fileUrl.
long long	recordingLength () const
	Returns the total length of the document in miliseconds.
dataType	getNbSamples (long startTime, long endTime, long startTimeInRecordingUnits)
	Computes the number of samples between startTime and endTime.
long	getTotalNbSamples ()
	Returns the total number of samples in recorded contained in the file identified by fileUrl.
	TracesProvider (KURL fileUrl, int nbChannels, int resolution, double samplingRate, int offset)
	Constructor.
void	requestData (long startTime, long endTime, QObject *initiator, long startTimeInRecordingUnits)
	Triggers the retrieve of the traces included in the time rate given by startTime and endTime.
void	setNbChannels (int nb)
	Sets the number of channels corresponding to the file identified by fileUrl.
void	setResolution (int res)
	Sets the resolution used to record the data contained in the file identified by fileUrl.
void	setSamplingRate (double rate)
	Sets the sampling rate used to record the data contained in the file identified by fileUrl.
void	setOffset (int newOffset)
	Sets the offset to apply to the data contained in the file identified by fileUrl.
int	getNbChannels () const
	Returns the number of channels corresponding to the file identified by fileUrl.
int	getResolution () const
	Returns the resolution used to record the data contained in the file identified by fileUrl.
double	getSamplingRate () const
	Returns the sampling rate used to record the data contained in the file identified by fileUrl.
int	getOffset () const
	Returns the offset to apply to the data contained in the file identified by fileUrl.
long long	recordingLength () const
	Returns the total length of the document in miliseconds.
dataType	getNbSamples (long startTime, long endTime, long startTimeInRecordingUnits)
	Computes the number of samples between startTime and endTime.
long	getTotalNbSamples ()
	Returns the total number of samples in recorded contained in the file identified by fileUrl.

---

Detailed Description

Class providing the row recorded data (contained in a .dat or .eeg file).

Author:

Lynn Hazan

---

Constructor & Destructor Documentation

TracesProvider::TracesProvider	(	KURL	fileUrl,
		int	nbChannels,
		int	resolution,
		double	samplingRate,
		int	offset
	)

Constructor.

Parameters:

	fileUrl	the url of the file containing the data provided by this class.
	nbChannels	the number of channels.
	resolution	resolution of the acquisition system used to record the data contained in the file identified by fileUrl.
	samplingRate	sampling rate used to record the data contained in the file identified by fileUrl.
	offset	offset to apply to the data contained in the file identified by fileUrl.

TracesProvider::TracesProvider	(	KURL	fileUrl,
		int	nbChannels,
		int	resolution,
		double	samplingRate,
		int	offset
	)

Constructor.

Parameters:

	fileUrl	the url of the file containing the data provided by this class.
	nbChannels	the number of channels.
	resolution	resolution of the acquisition system used to record the data contained in the file identified by fileUrl.
	samplingRate	sampling rate used to record the data contained in the file identified by fileUrl.
	offset	offset to apply to the data contained in the file identified by fileUrl.

---

Member Function Documentation

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

Triggers the retrieve of the traces included in the time rate given by startTime and endTime.

Parameters:

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

Reimplemented from DataProvider.

void TracesProvider::setNbChannels

(

int

nb

)

[inline]

Sets the number of channels corresponding to the file identified by fileUrl.

Parameters:

nb

the number of channels.

void TracesProvider::setResolution

(

int

res

)

[inline]

Sets the resolution used to record the data contained in the file identified by fileUrl.

Parameters:

res

resolution.

void TracesProvider::setSamplingRate

(

double

rate

)

[inline]

Sets the sampling rate used to record the data contained in the file identified by fileUrl.

Parameters:

rate

the sampling rate.

void TracesProvider::setOffset

(

int

newOffset

)

[inline]

Sets the offset to apply to the data contained in the file identified by fileUrl.

Parameters:

newOffset

offset.

dataType TracesProvider::getNbSamples	(	long	startTime,
		long	endTime,
		long	startTimeInRecordingUnits
	)

Computes the number of samples between startTime and endTime.

Parameters:

	startTime	begining of the time frame from which the data have been retrieved, given in milisecond.
	endTime	end of the time frame from which to retrieve the data, given in milisecond.

Returns:

number of samples in the given time frame.

Parameters:

startTimeInRecordingUnits

begining of the time frame from which the data have been retrieved, given in recording units.

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

Signals that the data have been retrieved.

Parameters:

	data	array of data (number of channels X number of samples).
	initiator	instance requesting the data.

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

Triggers the retrieve of the traces included in the time rate given by startTime and endTime.

Parameters:

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

Reimplemented from DataProvider.

void TracesProvider::setNbChannels

(

int

nb

)

[inline]

Sets the number of channels corresponding to the file identified by fileUrl.

Parameters:

nb

the number of channels.

void TracesProvider::setResolution

(

int

res

)

[inline]

Sets the resolution used to record the data contained in the file identified by fileUrl.

Parameters:

res

resolution.

void TracesProvider::setSamplingRate

(

double

rate

)

[inline]

Sets the sampling rate used to record the data contained in the file identified by fileUrl.

Parameters:

rate

the sampling rate.

void TracesProvider::setOffset

(

int

newOffset

)

[inline]

Sets the offset to apply to the data contained in the file identified by fileUrl.

Parameters:

newOffset

offset.

dataType TracesProvider::getNbSamples	(	long	startTime,
		long	endTime,
		long	startTimeInRecordingUnits
	)

Computes the number of samples between startTime and endTime.

Parameters:

	startTime	begining of the time frame from which the data have been retrieved, given in milisecond.
	endTime	end of the time frame from which to retrieve the data, given in milisecond.

Returns:

number of samples in the given time frame.

Parameters:

startTimeInRecordingUnits

begining of the time frame from which the data have been retrieved, given in recording units.

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

Signals that the data have been retrieved.

Parameters:

	data	array of data (number of channels X number of samples).
	initiator	instance requesting the data.

---

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

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

---