OpenWalnut  1.4.0
Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Attributes
WEEG Class Reference

Contains EEG recording data. More...

#include <WEEG.h>

+ Inheritance diagram for WEEG:

List of all members.

Public Member Functions

 WEEG (const WEEGSegmentArray &data, const WEEGElectrodeLibrary &electrodeLib, const WEEGChannelLabels &channelLabels)
 Constructs a WEEG object from the give infos.
 WEEG ()
 Constructor creating a quite unusable instance.
const double & operator() (size_t segment, size_t signal, size_t sample) const
 Access operator for single samples.
size_t getNumberOfSamples (size_t segmentId) const
 Returns number of samples of a given segment.
size_t getNumberOfChannels () const
 Return the number of channels this EEG has.
size_t getNumberOfSegments () const
 Return the number of segments this EEG consists of.
std::string getChannelLabel (size_t channelId) const
 Return the label of a certain channel.
WPosition getChannelPosition (size_t channelId) const
 Return the position of the sensor for a certain channel.
virtual bool isTexture () const
 Determines whether this dataset can be used as a texture.
virtual const std::string getName () const
 Gets the name of this prototype.
virtual const std::string getDescription () const
 Gets the description for this prototype.

Static Public Member Functions

static boost::shared_ptr
< WPrototyped
getPrototype ()
 Returns a prototype instantiated with the true type of the deriving class.

Static Protected Attributes

static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.

Private Attributes

double m_samplingRate
 We have only on sampling rate for all channels.
std::map< std::string, size_tm_electrodeDescriptions
 Description of electrodes.
WEEGElectrodeLibrary m_electrodeLibrary
 Information about the electrodes.
WEEGSegmentArray m_segments
 Contains the EEG data as an arry of segements of data which consist of an array of electrodes which again consist of an array of samples over time.
WEEGChannelLabels m_channelLabels
 Label for each channel.
std::vector< bool > m_channelEnabled
 Is the channel enabled?

Detailed Description

Contains EEG recording data.

Definition at line 70 of file WEEG.h.


Constructor & Destructor Documentation

WEEG::WEEG ( const WEEGSegmentArray &  data,
const WEEGElectrodeLibrary &  electrodeLib,
const WEEGChannelLabels &  channelLabels 
) [explicit]

Constructs a WEEG object from the give infos.

Parameters:
dataArray of segments
electrodeLibInformation about the electrodes
channelLabelsThe names of the channels.

Definition at line 34 of file WEEG.cpp.

References m_channelLabels, m_electrodeLibrary, m_segments, WRecording::MAX_RECORDING_CHANNELS, WRecording::MAX_RECORDING_SAMPLES, and WRecording::MAX_RECORDING_SEGMENTS.

Constructor creating a quite unusable instance.

Useful for prototype mechanism.

Definition at line 56 of file WEEG.cpp.

Referenced by getPrototype().


Member Function Documentation

std::string WEEG::getChannelLabel ( size_t  channelId) const [inline]

Return the label of a certain channel.

Parameters:
channelIdid of channel beeing inspected.
Returns:
Name of channel with channelId

Definition at line 217 of file WEEG.h.

References m_channelLabels.

WPosition WEEG::getChannelPosition ( size_t  channelId) const [inline]

Return the position of the sensor for a certain channel.

Parameters:
channelIdid of channel beeing inspected.
Returns:
Position of sensor of channel channelId

Definition at line 223 of file WEEG.h.

References m_electrodeLibrary.

const std::string WEEG::getDescription ( ) const [virtual]

Gets the description for this prototype.

Returns:
the description

Reimplemented from WRecording.

Definition at line 72 of file WEEG.cpp.

const std::string WEEG::getName ( ) const [virtual]

Gets the name of this prototype.

Returns:
the name.

Reimplemented from WRecording.

Definition at line 67 of file WEEG.cpp.

size_t WEEG::getNumberOfChannels ( ) const [inline]

Return the number of channels this EEG has.

Returns:
Number of channels.

Definition at line 207 of file WEEG.h.

References m_segments.

size_t WEEG::getNumberOfSamples ( size_t  segmentId) const [inline]

Returns number of samples of a given segment.

Parameters:
segmentIdid of segment beeing inspected.
Returns:
Number of samples of segment with segmentId.

Definition at line 202 of file WEEG.h.

References m_segments.

size_t WEEG::getNumberOfSegments ( ) const [inline]

Return the number of segments this EEG consists of.

Returns:
Number of segments.

Definition at line 212 of file WEEG.h.

References m_segments.

boost::shared_ptr< WPrototyped > WEEG::getPrototype ( ) [static]

Returns a prototype instantiated with the true type of the deriving class.

Returns:
the prototype.

Reimplemented from WRecording.

Definition at line 77 of file WEEG.cpp.

References m_prototype, and WEEG().

bool WEEG::isTexture ( ) const [virtual]

Determines whether this dataset can be used as a texture.

Returns:
true if usable as texture.

Reimplemented from WDataSet.

Definition at line 62 of file WEEG.cpp.

const double & WEEG::operator() ( size_t  segment,
size_t  signal,
size_t  sample 
) const [inline]

Access operator for single samples.

Parameters:
segmentid of segment to access
signalid of signal to access
sampleid of sample to access
Returns:
The data sample at the given location

Definition at line 197 of file WEEG.h.

References m_segments.


Member Data Documentation

std::vector< bool > WEEG::m_channelEnabled [private]

Is the channel enabled?

Definition at line 194 of file WEEG.h.

WEEGChannelLabels WEEG::m_channelLabels [private]

Label for each channel.

Definition at line 189 of file WEEG.h.

Referenced by getChannelLabel(), and WEEG().

std::map< std::string, size_t > WEEG::m_electrodeDescriptions [private]

Description of electrodes.

Definition at line 172 of file WEEG.h.

WEEGElectrodeLibrary WEEG::m_electrodeLibrary [private]

Information about the electrodes.

Definition at line 177 of file WEEG.h.

Referenced by getChannelPosition(), and WEEG().

boost::shared_ptr< WPrototyped > WEEG::m_prototype = boost::shared_ptr< WPrototyped >() [static, protected]

The prototype as singleton.

Reimplemented from WRecording.

Definition at line 162 of file WEEG.h.

Referenced by getPrototype().

double WEEG::m_samplingRate [private]

We have only on sampling rate for all channels.

Definition at line 168 of file WEEG.h.

WEEGSegmentArray WEEG::m_segments [private]

Contains the EEG data as an arry of segements of data which consist of an array of electrodes which again consist of an array of samples over time.

Definition at line 184 of file WEEG.h.

Referenced by getNumberOfChannels(), getNumberOfSamples(), getNumberOfSegments(), operator()(), and WEEG().


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