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

evoked data More...

#include <fiff_evoked.h>

Public Types

typedef QSharedPointer< FiffEvokedSPtr
 
typedef QSharedPointer< const FiffEvokedConstSPtr
 

Public Member Functions

 FiffEvoked ()
 
 FiffEvoked (QIODevice &p_IODevice, QVariant setno=0, QPair< QVariant, QVariant > baseline=defaultVariantPair, bool proj=true, fiff_int_t p_aspect_kind=FIFFV_ASPECT_AVERAGE)
 
 FiffEvoked (const FiffEvoked &p_FiffEvoked)
 
 ~FiffEvoked ()
 
QStringList ch_names ()
 
void clear ()
 
QString aspectKindToString () const
 
bool isEmpty ()
 
FiffEvoked pick_channels (const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
 
void setInfo (FiffInfo &p_info, bool proj=true)
 

Static Public Member Functions

static bool read (QIODevice &p_IODevice, FiffEvoked &p_FiffEvoked, QVariant setno=0, QPair< QVariant, QVariant > baseline=defaultVariantPair, bool proj=true, fiff_int_t p_aspect_kind=FIFFV_ASPECT_AVERAGE)
 

Public Attributes

FiffInfo info
 
fiff_int_t nave
 
fiff_int_t aspect_kind
 
fiff_int_t first
 
fiff_int_t last
 
QString comment
 
RowVectorXf times
 
MatrixXd data
 
MatrixXd proj
 

Detailed Description

evoked data

NEW PYTHON LIKE Fiff evoked

Definition at line 91 of file fiff_evoked.h.

Member Typedef Documentation

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

Const shared pointer type for FiffEvoked.

Definition at line 95 of file fiff_evoked.h.

typedef QSharedPointer<FiffEvoked> FIFFLIB::FiffEvoked::SPtr

Shared pointer type for FiffEvoked.

Definition at line 94 of file fiff_evoked.h.

Constructor & Destructor Documentation

FiffEvoked::FiffEvoked ( )

Constructs a fiff evoked data.

Definition at line 62 of file fiff_evoked.cpp.

FiffEvoked::FiffEvoked ( QIODevice &  p_IODevice,
QVariant  setno = 0,
QPair< QVariant, QVariant >  baseline = defaultVariantPair,
bool  proj = true,
fiff_int_t  p_aspect_kind = FIFFV_ASPECT_AVERAGE 
)

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

Parameters
[in]p_IODeviceIO device to read from the evoked data set.
[in]setnoThe set to pick. Dataset ID number (int) or comment/name (str). Optional if there isonly one data set in file.
[in]baselineThe time interval to apply rescaling / baseline correction. If None do not apply it. If baseline is (a, b) the interval is between "a (s)" and "b (s)". If a is None the beginning of the data is used and if b is None then b is set to the end of the interval. If baseline is equal ot (None, None) all the time interval is used. If None, no correction is applied.
[in]projApply SSP projection vectors (optional, default = true)
[in]p_aspect_kindEither "FIFFV_ASPECT_AVERAGE" or "FIFFV_ASPECT_STD_ERR". The type of data to read. Only used if "setno" is a str.

Definition at line 74 of file fiff_evoked.cpp.

FiffEvoked::FiffEvoked ( const FiffEvoked p_FiffEvoked)

Copy constructor.

Parameters
[in]p_FiffEvokedFiff evoked data which should be copied

Definition at line 86 of file fiff_evoked.cpp.

FiffEvoked::~FiffEvoked ( )

Destroys the FiffEvoked.

Definition at line 103 of file fiff_evoked.cpp.

Member Function Documentation

QString FIFFLIB::FiffEvoked::aspectKindToString ( ) const
inline

Provides the python Evoked string formatted aspect_kind, which is stored in kind: "average" <-> FIFFV_ASPECT_AVERAGE, "standard_error" <-> FIFFV_ASPECT_STD_ERR or "unknown"

Returns
string formatted aspect_kind

Definition at line 235 of file fiff_evoked.h.

QStringList FIFFLIB::FiffEvoked::ch_names ( )
inline

Returns list of channel names stored in fiff info -> this is to stay consistent with python

Definition at line 227 of file fiff_evoked.h.

void FiffEvoked::clear ( )

Initializes fiff evoked data.

Definition at line 111 of file fiff_evoked.cpp.

bool FIFFLIB::FiffEvoked::isEmpty ( )
inline

Returns whether FiffEvoked is empty.

Returns
true if is empty, false otherwise

Definition at line 248 of file fiff_evoked.h.

FiffEvoked FiffEvoked::pick_channels ( const QStringList &  include = defaultQStringList,
const QStringList &  exclude = defaultQStringList 
) const

fiff_pick_channels_evoked

MNE toolbox root function

Pick desired channels from evoked-response data

Parameters
[in]include- Channels to include (if empty, include all available)
[in]exclude- Channels to exclude (if empty, do not exclude any)
Returns
the desired fiff evoked data

Definition at line 127 of file fiff_evoked.cpp.

bool FiffEvoked::read ( QIODevice &  p_IODevice,
FiffEvoked p_FiffEvoked,
QVariant  setno = 0,
QPair< QVariant, QVariant >  baseline = defaultVariantPair,
bool  proj = true,
fiff_int_t  p_aspect_kind = FIFFV_ASPECT_AVERAGE 
)
static

fiff_read_evoked

MNE toolbox root function

Wrapper for the FiffEvokedDataSet::read_evoked static function

Read one evoked data set

Parameters
[in]p_IODeviceAn fiff IO device like a fiff QFile or QTCPSocket
[out]p_FiffEvokedThe read evoked data
[in]setnothe set to pick. Dataset ID number (int) or comment/name (str). Optional if there isonly one data set in file.
[in]baselineThe time interval to apply rescaling / baseline correction. If None do not apply it. If baseline is (a, b) the interval is between "a (s)" and "b (s)". If a is None the beginning of the data is used and if b is None then b is set to the end of the interval. If baseline is equal ot (None, None) all the time interval is used. If None, no correction is applied.
[in]projApply SSP projection vectors (optional, default = true)
[in]p_aspect_kindEither "FIFFV_ASPECT_AVERAGE" or "FIFFV_ASPECT_STD_ERR". The type of data to read. Only used if "setno" is a str.
Returns
true if successful, false otherwise

Definition at line 164 of file fiff_evoked.cpp.

void FiffEvoked::setInfo ( FiffInfo p_info,
bool  proj = true 
)

Set a new fiff measurement info

Parameters
[in]p_infoInfo to set
[in]projApply SSP projection vectors (optional, default = true)

Definition at line 494 of file fiff_evoked.cpp.

Member Data Documentation

fiff_int_t FIFFLIB::FiffEvoked::aspect_kind

Aspect identifier, either FIFFV_ASPECT_AVERAGE or FIFFV_ASPECT_STD_ERR.

Definition at line 212 of file fiff_evoked.h.

QString FIFFLIB::FiffEvoked::comment

Comment on dataset. Can be the condition.

Definition at line 215 of file fiff_evoked.h.

MatrixXd FIFFLIB::FiffEvoked::data

2D array of shape [n_channels x n_times]; Evoked response.

Definition at line 217 of file fiff_evoked.h.

fiff_int_t FIFFLIB::FiffEvoked::first

First time sample.

Definition at line 213 of file fiff_evoked.h.

FiffInfo FIFFLIB::FiffEvoked::info

Measurement info.

Definition at line 210 of file fiff_evoked.h.

fiff_int_t FIFFLIB::FiffEvoked::last

Last time sample.

Definition at line 214 of file fiff_evoked.h.

fiff_int_t FIFFLIB::FiffEvoked::nave

Number of averaged epochs.

Definition at line 211 of file fiff_evoked.h.

MatrixXd FIFFLIB::FiffEvoked::proj

SSP projection

Definition at line 218 of file fiff_evoked.h.

RowVectorXf FIFFLIB::FiffEvoked::times

Vector of time instants in seconds.

Definition at line 216 of file fiff_evoked.h.


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