OpenWalnut  1.2.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Attributes | List of all members
WEEG Class Reference

Contains EEG recording data. More...

#include <WEEG.h>

+ Inheritance diagram for WEEG:

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.
- 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.
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 >()
 The prototype as singleton.
- 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
 We have only on sampling rate for all channels.
std::map< std::string, size_t > m_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?

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

Contains EEG recording data.

Definition at line 68 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.

WEEG::WEEG ( )

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 218 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 224 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 208 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 203 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 213 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 198 of file WEEG.h.

References m_segments.

Member Data Documentation

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

Is the channel enabled?

Definition at line 195 of file WEEG.h.

WEEGChannelLabels WEEG::m_channelLabels
private

Label for each channel.

Definition at line 190 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 173 of file WEEG.h.

WEEGElectrodeLibrary WEEG::m_electrodeLibrary
private

Information about the electrodes.

Definition at line 178 of file WEEG.h.

Referenced by getChannelPosition(), and WEEG().

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

The prototype as singleton.

Definition at line 163 of file WEEG.h.

Referenced by getPrototype().

double WEEG::m_samplingRate
private

We have only on sampling rate for all channels.

Definition at line 169 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 185 of file WEEG.h.

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


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