Abstract class to load an EEG file and keep it open to support paging.
More...
#include <WPagerEEG.h>
Public Member Functions |
virtual | ~WPagerEEG () |
| Virtual destructor.
|
std::string | getFilename () const |
| Get the name of the loaded file.
|
OW_API_DEPRECATED std::string | getFileName () const |
| Get the name of the loaded file.
|
virtual std::size_t | getNumberOfSegments () const =0 |
| Get the number of segments this EEG consists of.
|
virtual std::size_t | getNumberOfChannels () const =0 |
| Get the number of channels this EEG has.
|
virtual std::size_t | getNumberOfSamples (std::size_t segmentID) const =0 |
| Get the number of samples of a given segment.
|
virtual boost::shared_ptr
< WEEGValueMatrix > | getValues (std::size_t segmentID, std::size_t start, std::size_t length) const =0 |
| Get the values of all channels for a given sample range.
|
virtual double | getSamplingRate () const =0 |
| Get the sampling rate used by the recording.
|
virtual std::string | getChannelUnit (std::size_t channelID) const =0 |
| Get the unit used by the recording of a given channel.
|
virtual std::string | getChannelLabel (std::size_t channelID) const =0 |
| Get the label of a given channel.
|
Protected Member Functions |
| WPagerEEG (std::string filename) |
| Constructor.
|
Private Attributes |
std::string | m_filename |
| name of the loaded file
|
Detailed Description
Abstract class to load an EEG file and keep it open to support paging.
Definition at line 41 of file WPagerEEG.h.
Constructor & Destructor Documentation
WPagerEEG::~WPagerEEG |
( |
| ) |
|
|
virtual |
WPagerEEG::WPagerEEG |
( |
std::string |
filename | ) |
|
|
explicitprotected |
Constructor.
- Parameters
-
filename | path and filename to the file to load |
Definition at line 46 of file WPagerEEG.cpp.
References m_filename.
Member Function Documentation
virtual std::string WPagerEEG::getChannelLabel |
( |
std::size_t |
channelID | ) |
const |
|
pure virtual |
Get the label of a given channel.
- Parameters
-
- Returns
- label as string
virtual std::string WPagerEEG::getChannelUnit |
( |
std::size_t |
channelID | ) |
const |
|
pure virtual |
Get the unit used by the recording of a given channel.
- Parameters
-
- Returns
- unit as string
std::string WPagerEEG::getFilename |
( |
| ) |
const |
std::string WPagerEEG::getFileName |
( |
| ) |
const |
virtual std::size_t WPagerEEG::getNumberOfChannels |
( |
| ) |
const |
|
pure virtual |
Get the number of channels this EEG has.
- Returns
- number of channels
virtual std::size_t WPagerEEG::getNumberOfSamples |
( |
std::size_t |
segmentID | ) |
const |
|
pure virtual |
Get the number of samples of a given segment.
- Parameters
-
segmentID | segment number being inspected |
- Returns
- number of samples
virtual std::size_t WPagerEEG::getNumberOfSegments |
( |
| ) |
const |
|
pure virtual |
Get the number of segments this EEG consists of.
- Returns
- number of segments
virtual double WPagerEEG::getSamplingRate |
( |
| ) |
const |
|
pure virtual |
Get the sampling rate used by the recording.
- Returns
- sampling rate
virtual boost::shared_ptr< WEEGValueMatrix > WPagerEEG::getValues |
( |
std::size_t |
segmentID, |
|
|
std::size_t |
start, |
|
|
std::size_t |
length |
|
) |
| const |
|
pure virtual |
Get the values of all channels for a given sample range.
- Parameters
-
segmentID | segment number to read the values from |
start | start sample of the sample range |
length | length of the sample range |
- Returns
- matrix of values
Member Data Documentation
std::string WPagerEEG::m_filename |
|
private |
The documentation for this class was generated from the following files: