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

#include <WEEG2.h>

Inheritance diagram for WEEG2:

Collaboration diagram for WEEG2:

Public Member Functions
	WEEG2 (std::shared_ptr< WPagerEEG > pager, std::shared_ptr< WEEGPositionsLibrary > positionsLibrary)
	Constructor. More...

	WEEG2 ()
	Constructor creating a quite unusable instance. More...

std::size_t	getNumberOfSegments () const
	Get the number of segments this EEG consists of. More...

std::size_t	getNumberOfChannels () const
	Get the number of channels this EEG has. More...

double	getSamplingRate () const
	Get the sampling rate used by the recording. More...

std::shared_ptr< WEEG2Segment >	getSegment (std::size_t segmentID) const
	Get one segment. More...

std::shared_ptr< WEEGChannelInfo >	getChannelInfo (std::size_t channelID) const
	Get one channel info object. More...

virtual const std::string	getName () const
	Return the name of the dataset. More...

virtual const std::string	getDescription () const
	Description of dataset. More...

Public Member Functions inherited from WRecording
	WRecording ()
	Empty standard constructor for recordings. More...

Public Member Functions inherited from WDataSet
	WDataSet ()
	This constructor should be used if a dataSet does not stem from a file. More...

virtual	~WDataSet ()
	Since WDataSet is a base class and thus should be polymorphic we add virtual destructor. More...

void	setFilename (const std::string filename)
	Set the name of the file that this data set stems from. More...

std::string	getFilename () const
	Get the name of the file that this data set stems from. More...

OW_API_DEPRECATED void	setFileName (const std::string filename)
	Set the name of the file that this data set stems from. More...

OW_API_DEPRECATED std::string	getFileName () const
	Get the name of the file that this data set stems from. More...

virtual bool	isTexture () const
	Determines whether this dataset can be used as a texture. More...

virtual std::shared_ptr< WDataSetVector >	isVectorDataSet ()
	Checks if this dataset is a vector dataset. More...

virtual osg::ref_ptr< WDataTexture3D >	getTexture () const
	Returns the texture- representation of the dataset. More...

std::shared_ptr< WProperties >	getProperties () const
	Return a pointer to the properties object of the dataset. More...

std::shared_ptr< WProperties >	getInformationProperties () const
	Return a pointer to the information properties object of the dataset. More...

Public Member Functions inherited from WTransferable
	WTransferable ()
	Default constructor. More...

virtual	~WTransferable ()
	Destructor. More...

Public Member Functions inherited from WPrototyped
	WPrototyped ()
	Default constructor. More...

virtual	~WPrototyped ()
	Destructor. More...

template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type. More...

Static Public Member Functions
static std::shared_ptr< WPrototyped >	getPrototype ()
	Get dataset prototype. More...

Static Public Member Functions inherited from WRecording
static std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Public Member Functions inherited from WDataSet
static std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Protected Attributes
static std::shared_ptr< WPrototyped >	m_prototype = std::shared_ptr< WPrototyped >()
	Prototype needed to allow the EEG dataset to be transferred. More...

Static Protected Attributes inherited from WRecording
static std::shared_ptr< WPrototyped >	m_prototype = std::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

Static Protected Attributes inherited from WDataSet
static std::shared_ptr< WPrototyped >	m_prototype = std::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

Private Attributes
double	m_samplingRate
	sampling rate used by the recording More...

std::vector< std::shared_ptr< WEEG2Segment > >	m_segments
	list of all segments this EEG consists of More...

std::vector< std::shared_ptr< WEEGChannelInfo > >	m_channelInfos
	list of the information about all channel infos this EEG has More...

Additional Inherited Members
Public Types inherited from WDataSet
typedef std::shared_ptr< WDataSet >	SPtr
	Shared pointer abbreviation to a instance of this class. More...

typedef std::shared_ptr< const WDataSet >	ConstSPtr
	Shared pointer abbreviation to a const instance of this class. More...

Static Public Attributes inherited from WRecording
static const unsigned int	MAX_RECORDING_CHANNELS = 1024
	Maximum number of channels for a certain modality. More...

static const unsigned int	MAX_RECORDING_SAMPLES = 4294967295U
	Maximum number of samples of a recording. More...

static const unsigned int	MAX_RECORDING_SEGMENTS = 128
	Maximum number of segments of a recording. More...

static const unsigned int	MAX_RECORDING_SAMPLING_FREQUENCY = 20000
	Maximum samplimg frequency of a recording. More...

Protected Attributes inherited from WDataSet
std::shared_ptr< WProperties >	m_properties
	The property object for the dataset. More...

std::shared_ptr< WProperties >	m_infoProperties
	The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More...

Detailed Description

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

Definition at line 46 of file WEEG2.h.

Constructor & Destructor Documentation

◆ WEEG2() [1/2]

WEEG2::WEEG2	(	std::shared_ptr< WPagerEEG >	pager,
		std::shared_ptr< WEEGPositionsLibrary >	positionsLibrary
	)

Constructor.

Parameters

pager	pager class which contains the data, read from a file on demand
positionsLibrary	class which contains the positions of the electrodes

Definition at line 43 of file WEEG2.cpp.

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

Here is the call graph for this function:

◆ WEEG2() [2/2]

WEEG2::WEEG2 ( )

Constructor creating a quite unusable instance.

Useful for prototype mechanism.

Definition at line 92 of file WEEG2.cpp.

Referenced by getPrototype().

Here is the caller graph for this function:

Member Function Documentation

◆ getChannelInfo()

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

Get one channel info object.

Parameters

channelID number of channel

Returns: object containing information about the channel

Definition at line 123 of file WEEG2.cpp.

References m_channelInfos.

◆ getDescription()

const std::string WEEG2::getDescription ( ) const

virtual

Description of dataset.

Returns: description of dataset

Reimplemented from WRecording.

Definition at line 140 of file WEEG2.cpp.

◆ getName()

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

virtual

Return the name of the dataset.

Returns: the name

Reimplemented from WRecording.

Definition at line 135 of file WEEG2.cpp.

◆ getNumberOfChannels()

std::size_t WEEG2::getNumberOfChannels ( ) const

Get the number of channels this EEG has.

Returns: number of channels

Definition at line 101 of file WEEG2.cpp.

References m_channelInfos.

◆ getNumberOfSegments()

std::size_t WEEG2::getNumberOfSegments ( ) const

Get the number of segments this EEG consists of.

Returns: number of segments

Definition at line 96 of file WEEG2.cpp.

References m_segments.

◆ getPrototype()

std::shared_ptr< WPrototyped > WEEG2::getPrototype ( )

static

Get dataset prototype.

Returns: the prototype

Definition at line 145 of file WEEG2.cpp.

References m_prototype, and WEEG2().

Here is the call graph for this function:

◆ getSamplingRate()

double WEEG2::getSamplingRate ( ) const

Get the sampling rate used by the recording.

Returns: sampling rate

Definition at line 106 of file WEEG2.cpp.

References m_samplingRate.

◆ getSegment()

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

Get one segment.

Parameters

segmentID number of segment

Returns: segment

Definition at line 111 of file WEEG2.cpp.

References m_segments.

Member Data Documentation

◆ m_channelInfos

std::vector< std::shared_ptr< WEEGChannelInfo > > WEEG2::m_channelInfos

private

list of the information about all channel infos this EEG has

Definition at line 134 of file WEEG2.h.

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

◆ m_prototype

std::shared_ptr< WPrototyped > WEEG2::m_prototype = std::shared_ptr< WPrototyped >()

staticprotected

Prototype needed to allow the EEG dataset to be transferred.

Definition at line 127 of file WEEG2.h.

Referenced by getPrototype().

◆ m_samplingRate

double WEEG2::m_samplingRate

private

sampling rate used by the recording

Definition at line 130 of file WEEG2.h.

Referenced by getSamplingRate(), and WEEG2().

◆ m_segments

std::vector< std::shared_ptr< WEEG2Segment > > WEEG2::m_segments

private

list of all segments this EEG consists of

Definition at line 132 of file WEEG2.h.

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

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

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WEEG2() [1/2]

◆ WEEG2() [2/2]

Member Function Documentation

◆ getChannelInfo()

◆ getDescription()

◆ getName()

◆ getNumberOfChannels()

◆ getNumberOfSegments()

◆ getPrototype()

◆ getSamplingRate()

◆ getSegment()

Member Data Documentation

◆ m_channelInfos

◆ m_prototype

◆ m_samplingRate

◆ m_segments