EventData Class Reference

Class representing the data of an event file for a given starting time and timeframe. More...

#include <eventdata.h>

Collaboration diagram for EventData:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 EventData (Array< int > d, Array< dataType > t, bool status)
 Constructor.
EventDataoperator= (const EventData &source)
void setStatus (bool status)
void setData (Array< dataType > &t, Array< int > &d)
bool status ()
 Returns the true if the data are available, false otherwise.
Array< int > & getIds ()
 Returns an Array containing the events ids.
Array< dataType > & getTimes ()
 Returns an Array containing the time indexes of the events relative to the current starting time.
void computePositions (double samplingRate, double positionSamplingRate, long startTime)
 
Parameters:
samplingRate sampling rate of the current open data file in Hz.

Array< dataType > & getPositions ()
 Returns an Array containing the positions indexes computed for the events.
 EventData (Array< int > d, Array< dataType > t, bool status)
 Constructor.
EventDataoperator= (const EventData &source)
void setStatus (bool status)
void setData (Array< dataType > &t, Array< int > &d)
bool status ()
 Returns the true if the data are available, false otherwise.
Array< int > & getIds ()
 Returns an Array containing the events ids.
Array< dataType > & getTimes ()
 Returns an Array containing the time indexes of the events relative to the current starting time.
void computePositions (double samplingRate, double positionSamplingRate, long startTime)
 
Parameters:
samplingRate sampling rate of the current open data file in Hz.

Array< dataType > & getPositions ()
 Returns an Array containing the positions indexes computed for the events.

Detailed Description

Class representing the data of an event file for a given starting time and timeframe.

Author:
Lynn Hazan


Constructor & Destructor Documentation

EventData::EventData ( Array< int >  d,
Array< dataType >  t,
bool  status 
) [inline]

Constructor.

Parameters:
d Array containing the events ids.
t Array containing the time indexes of the events relative to the current starting time. The indexes are computed using the currently open data file sampling rate.
status status of the data, true if the data are available, false otherwise.

EventData::EventData ( Array< int >  d,
Array< dataType >  t,
bool  status 
) [inline]

Constructor.

Parameters:
d Array containing the events ids.
t Array containing the time indexes of the events relative to the current starting time. The indexes are computed using the currently open data file sampling rate.
status status of the data, true if the data are available, false otherwise.


Member Function Documentation

Array<dataType>& EventData::getTimes (  )  [inline]

Returns an Array containing the time indexes of the events relative to the current starting time.

The indexes are computed using the currently open data file sampling rate.

void EventData::computePositions ( double  samplingRate,
double  positionSamplingRate,
long  startTime 
)

Parameters:
samplingRate sampling rate of the current open data file in Hz.

Parameters:
positionSamplingRate sampling rate of the position file in Hz.
startTime current start time of the time window in milisecond.

Array<dataType>& EventData::getPositions (  )  [inline]

Returns an Array containing the positions indexes computed for the events.

The positions indexes are computed using the position file sampling rate.

Array<dataType>& EventData::getTimes (  )  [inline]

Returns an Array containing the time indexes of the events relative to the current starting time.

The indexes are computed using the currently open data file sampling rate.

void EventData::computePositions ( double  samplingRate,
double  positionSamplingRate,
long  startTime 
)

Parameters:
samplingRate sampling rate of the current open data file in Hz.

Parameters:
positionSamplingRate sampling rate of the position file in Hz.
startTime current start time of the time window in milisecond.

Array<dataType>& EventData::getPositions (  )  [inline]

Returns an Array containing the positions indexes computed for the events.

The positions indexes are computed using the position file sampling rate.


The documentation for this class was generated from the following files:
Generated on Mon Sep 17 20:47:32 2007 for NeuroScope by  doxygen 1.5.1