OpenWalnut  1.3.1
Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Attributes | List of all members
WEEG2 Class Reference

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

#include <WEEG2.h>

+ Inheritance diagram for WEEG2:

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
 Gets the name of this prototype.
virtual const std::string getDescription () const
 Gets the description for this prototype.
- Public Member Functions inherited from WRecording
 WRecording ()
 Empty standard constructor for recordings.
- Public Member Functions inherited from WDataSet
 WDataSet ()
 This constructor should be used if a dataSet does not stem from a file.
virtual ~WDataSet ()
 Since WDataSet is a base class and thus should be polymorphic we add virtual destructor.
void setFilename (const std::string filename)
 Set the name of the file that this data set stems from.
std::string getFilename () const
 Get the name of the file that this data set stems from.
OW_API_DEPRECATED void setFileName (const std::string filename)
 Set the name of the file that this data set stems from.
OW_API_DEPRECATED std::string getFileName () const
 Get the name of the file that this data set stems from.
virtual bool isTexture () const
 Determines whether this dataset can be used as a texture.
virtual boost::shared_ptr
< WDataSetVector
isVectorDataSet ()
 Checks if this dataset is a vector dataset.
virtual osg::ref_ptr
< WDataTexture3D
getTexture () const
 Returns the texture- representation of the dataset.
boost::shared_ptr< WPropertiesgetProperties () const
 Return a pointer to the properties object of the dataset.
boost::shared_ptr< WPropertiesgetInformationProperties () const
 Return a pointer to the information properties object of the dataset.
- Public Member Functions inherited from WTransferable
 WTransferable ()
 Default constructor.
virtual ~WTransferable ()
 Destructor.
- Public Member Functions inherited from WPrototyped
 WPrototyped ()
 Default constructor.
virtual ~WPrototyped ()
 Destructor.
template<typename T >
bool isA ()
 Checks whether the actual prototype has the specified runtime type.

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 >()
 Prototype needed to allow the EEG dataset to be transferred.
- Static Protected Attributes inherited from WRecording
static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.
- Static Protected Attributes inherited from WDataSet
static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton.

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

Additional Inherited Members

- Static Public Attributes inherited from WRecording
static const unsigned int MAX_RECORDING_CHANNELS = 1024
 Maximum number of channels for a certain modality.
static const unsigned int MAX_RECORDING_SAMPLES = 4294967295U
 Maximum number of samples of a recording.
static const unsigned int MAX_RECORDING_SEGMENTS = 128
 Maximum number of segments of a recording.
static const unsigned int MAX_RECORDING_SAMPLING_FREQUENCY = 20000
 Maximum samplimg frequency of a recording.
- Protected Attributes inherited from WDataSet
boost::shared_ptr< WPropertiesm_properties
 The property object for the dataset.
boost::shared_ptr< WPropertiesm_infoProperties
 The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION".

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().

WEEG2::WEEG2 ( )

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

Gets the description for this prototype.

Returns
the description

Reimplemented from WRecording.

Definition at line 137 of file WEEG2.cpp.

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

Gets the name of this prototype.

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

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

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 120 of file WEEG2.h.

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

boost::shared_ptr< WPrototyped > WEEG2::m_prototype = boost::shared_ptr< WPrototyped >()
staticprotected

Prototype needed to allow the EEG dataset to be transferred.

Definition at line 113 of file WEEG2.h.

Referenced by getPrototype().

double WEEG2::m_samplingRate
private

sampling rate used by the recording

Definition at line 116 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 118 of file WEEG2.h.

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


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