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

Class which contains EEG recording data, read from a WPagerEEG. More...

#include <WEEG2.h>

+ Inheritance diagram for WEEG2:

List of all members.

Public Member Functions

 WEEG2 (boost::shared_ptr< WPagerEEG > pager, boost::shared_ptr< WEEGPositionsLibrary > positionsLibrary)
 Constructor.
 WEEG2 ()
 Constructor creating a quite unusable instance.
std::size_t getNumberOfSegments () const
 Get the number of segments this EEG consists of.
std::size_t getNumberOfChannels () const
 Get the number of channels this EEG has.
double getSamplingRate () const
 Get the sampling rate used by the recording.
boost::shared_ptr< WEEG2SegmentgetSegment (std::size_t segmentID) const
 Get one segment.
boost::shared_ptr
< WEEGChannelInfo
getChannelInfo (std::size_t channelID) const
 Get one channel info object.
virtual const std::string getName () const
 Return the name of the dataset.
virtual const std::string getDescription () const
 Description of dataset.

Static Public Member Functions

static boost::shared_ptr
< WPrototyped
getPrototype ()
 Get dataset prototype.

Static Protected Attributes

static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 Prototype needed to allow the EEG dataset to be transferred.

Private Attributes

double m_samplingRate
 sampling rate used by the recording
std::vector< boost::shared_ptr
< WEEG2Segment > > 
m_segments
 list of all segments this EEG consists of
std::vector< boost::shared_ptr
< WEEGChannelInfo > > 
m_channelInfos
 list of the information about all channel infos this EEG has

Detailed Description

Class which contains EEG recording data, read from a WPagerEEG.

Definition at line 47 of file WEEG2.h.


Constructor & Destructor Documentation

WEEG2::WEEG2 ( boost::shared_ptr< WPagerEEG pager,
boost::shared_ptr< WEEGPositionsLibrary positionsLibrary 
)

Constructor.

Parameters:
pagerpager class which contains the data, read from a file on demand
positionsLibraryclass which contains the positions of the electrodes

Definition at line 44 of file WEEG2.cpp.

References m_channelInfos, m_samplingRate, m_segments, WRecording::MAX_RECORDING_CHANNELS, WRecording::MAX_RECORDING_SAMPLING_FREQUENCY, WRecording::MAX_RECORDING_SEGMENTS, and WDataSet::setFilename().

Constructor creating a quite unusable instance.

Useful for prototype mechanism.

Definition at line 89 of file WEEG2.cpp.

Referenced by getPrototype().


Member Function Documentation

boost::shared_ptr< WEEGChannelInfo > WEEG2::getChannelInfo ( std::size_t  channelID) const

Get one channel info object.

Parameters:
channelIDnumber of channel
Returns:
object containing information about the channel

Definition at line 120 of file WEEG2.cpp.

References m_channelInfos.

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

Description of dataset.

Returns:
description of dataset

Reimplemented from WRecording.

Definition at line 137 of file WEEG2.cpp.

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

Return the name of the dataset.

Returns:
the name

Reimplemented from WRecording.

Definition at line 132 of file WEEG2.cpp.

std::size_t WEEG2::getNumberOfChannels ( ) const

Get the number of channels this EEG has.

Returns:
number of channels

Definition at line 98 of file WEEG2.cpp.

References m_channelInfos.

std::size_t WEEG2::getNumberOfSegments ( ) const

Get the number of segments this EEG consists of.

Returns:
number of segments

Definition at line 93 of file WEEG2.cpp.

References m_segments.

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

Get dataset prototype.

Returns:
the prototype

Reimplemented from WRecording.

Definition at line 142 of file WEEG2.cpp.

References m_prototype, and WEEG2().

double WEEG2::getSamplingRate ( ) const

Get the sampling rate used by the recording.

Returns:
sampling rate

Definition at line 103 of file WEEG2.cpp.

References m_samplingRate.

boost::shared_ptr< WEEG2Segment > WEEG2::getSegment ( std::size_t  segmentID) const

Get one segment.

Parameters:
segmentIDnumber of segment
Returns:
segment

Definition at line 108 of file WEEG2.cpp.

References m_segments.


Member Data Documentation

std::vector< boost::shared_ptr< WEEGChannelInfo > > WEEG2::m_channelInfos [private]

list of the information about all channel infos this EEG has

Definition at line 135 of file WEEG2.h.

Referenced by getChannelInfo(), getNumberOfChannels(), and WEEG2().

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

Prototype needed to allow the EEG dataset to be transferred.

Reimplemented from WRecording.

Definition at line 128 of file WEEG2.h.

Referenced by getPrototype().

double WEEG2::m_samplingRate [private]

sampling rate used by the recording

Definition at line 131 of file WEEG2.h.

Referenced by getSamplingRate(), and WEEG2().

std::vector< boost::shared_ptr< WEEG2Segment > > WEEG2::m_segments [private]

list of all segments this EEG consists of

Definition at line 133 of file WEEG2.h.

Referenced by getNumberOfSegments(), getSegment(), and WEEG2().


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