MNE-CPP  beta 1.0
Public Types | Public Member Functions | Public Attributes | List of all members
FIFFLIB::FiffRawData Class Reference

FIFF raw measurement data. More...

#include <fiff_raw_data.h>

Public Types

typedef QSharedPointer< FiffRawDataSPtr
 
typedef QSharedPointer< const FiffRawDataConstSPtr
 

Public Member Functions

 FiffRawData ()
 
 FiffRawData (const FiffRawData &p_FiffRawData)
 
 FiffRawData (QIODevice &p_IODevice)
 
 ~FiffRawData ()
 
void clear ()
 
bool isEmpty () const
 
bool read_raw_segment (MatrixXd &data, MatrixXd &times, fiff_int_t from=-1, fiff_int_t to=-1, const RowVectorXi &sel=defaultRowVectorXi)
 
bool read_raw_segment (MatrixXd &data, MatrixXd &times, SparseMatrix< double > &multSegment, fiff_int_t from=-1, fiff_int_t to=-1, const RowVectorXi &sel=defaultRowVectorXi)
 
bool read_raw_segment_times (MatrixXd &data, MatrixXd &times, float from, float to, const RowVectorXi &sel=defaultRowVectorXi)
 

Public Attributes

FiffStream::SPtr file
 
FiffInfo info
 
fiff_int_t first_samp
 
fiff_int_t last_samp
 
RowVectorXd cals
 
QList< FiffRawDirrawdir
 
MatrixXd proj
 
FiffCtfComp comp
 

Detailed Description

FIFF raw measurement data.

Provides fiff raw measurement data, including I/O routines.

Definition at line 94 of file fiff_raw_data.h.

Member Typedef Documentation

typedef QSharedPointer<const FiffRawData> FIFFLIB::FiffRawData::ConstSPtr

Const shared pointer type for FiffRawData.

Definition at line 98 of file fiff_raw_data.h.

typedef QSharedPointer<FiffRawData> FIFFLIB::FiffRawData::SPtr

Shared pointer type for FiffRawData.

Definition at line 97 of file fiff_raw_data.h.

Constructor & Destructor Documentation

FiffRawData::FiffRawData ( )

Default constructor.

Definition at line 59 of file fiff_raw_data.cpp.

FiffRawData::FiffRawData ( const FiffRawData p_FiffRawData)

Copy constructor.

Parameters
[in]p_FiffRawDataFIFF raw measurement which should be copied

Definition at line 85 of file fiff_raw_data.cpp.

FiffRawData::FiffRawData ( QIODevice &  p_IODevice)

Constructs fiff raw data, by reading from a IO device.

Parameters
[in]p_IODeviceIO device to read the raw data from .

Definition at line 69 of file fiff_raw_data.cpp.

FiffRawData::~FiffRawData ( )

Destroys the FiffInfo.

Definition at line 101 of file fiff_raw_data.cpp.

Member Function Documentation

void FiffRawData::clear ( )

Initializes the fiff raw measurement data.

Definition at line 109 of file fiff_raw_data.cpp.

bool FIFFLIB::FiffRawData::isEmpty ( ) const
inline

True if fiff raw data are empty.

Returns
true if fiff raw data are empty

Definition at line 140 of file fiff_raw_data.h.

bool FiffRawData::read_raw_segment ( MatrixXd &  data,
MatrixXd &  times,
fiff_int_t  from = -1,
fiff_int_t  to = -1,
const RowVectorXi &  sel = defaultRowVectorXi 
)

MNE toolbox root function ###: Implementation of the fiff_read_raw_segment function

Read a specific raw data segment

Parameters
[out]datareturns the data matrix (channels x samples)
[out]timesreturns the time values corresponding to the samples
[in]fromfirst sample to include. If omitted, defaults to the first sample in data (optional)
[in]tolast sample to include. If omitted, defaults to the last sample in data (optional)
[in]selchannel selection vector (optional)
Returns
true if succeeded, false otherwise

Definition at line 123 of file fiff_raw_data.cpp.

bool FiffRawData::read_raw_segment ( MatrixXd &  data,
MatrixXd &  times,
SparseMatrix< double > &  multSegment,
fiff_int_t  from = -1,
fiff_int_t  to = -1,
const RowVectorXi &  sel = defaultRowVectorXi 
)

MNE toolbox root function ###: Implementation of the fiff_read_raw_segment function

Read a specific raw data segment

Parameters
[out]datareturns the data matrix (channels x samples)
[out]timesreturns the time values corresponding to the samples
[out]multSegmentused multiplication matrix (compensator,projection,calibration)
[in]fromfirst sample to include. If omitted, defaults to the first sample in data (optional)
[in]tolast sample to include. If omitted, defaults to the last sample in data (optional)
[in]selchannel selection vector (optional)
Returns
true if succeeded, false otherwise

Definition at line 441 of file fiff_raw_data.cpp.

bool FiffRawData::read_raw_segment_times ( MatrixXd &  data,
MatrixXd &  times,
float  from,
float  to,
const RowVectorXi &  sel = defaultRowVectorXi 
)

MNE toolbox root function ###: Implementation of the fiff_read_raw_segment function

Read a specific raw data segment

Parameters
[out]datareturns the data matrix (channels x samples)
[out]timesreturns the time values corresponding to the samples
[in]fromstarting time of the segment in seconds
[in]toend time of the segment in seconds
[in]seloptional channel selection vector
Returns
true if succeeded, false otherwise

Definition at line 763 of file fiff_raw_data.cpp.

Member Data Documentation

RowVectorXd FIFFLIB::FiffRawData::cals

Calibration matrix: ToDo Check if RowVectorXd is enough

Definition at line 199 of file fiff_raw_data.h.

FiffCtfComp FIFFLIB::FiffRawData::comp

Compensator.

Definition at line 202 of file fiff_raw_data.h.

FiffStream::SPtr FIFFLIB::FiffRawData::file

replaces fid

Definition at line 195 of file fiff_raw_data.h.

fiff_int_t FIFFLIB::FiffRawData::first_samp

Do we have a skip ToDo...

Definition at line 197 of file fiff_raw_data.h.

FiffInfo FIFFLIB::FiffRawData::info

Fiff measurement information

Definition at line 196 of file fiff_raw_data.h.

fiff_int_t FIFFLIB::FiffRawData::last_samp

Do we have a skip ToDo...

Definition at line 198 of file fiff_raw_data.h.

MatrixXd FIFFLIB::FiffRawData::proj

SSP operator to apply to the data.

Definition at line 201 of file fiff_raw_data.h.

QList<FiffRawDir> FIFFLIB::FiffRawData::rawdir

Special fiff diretory entry for raw data.

Definition at line 200 of file fiff_raw_data.h.


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