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

evoked data set More...

#include <fiff_evoked_set.h>

Public Types

typedef QSharedPointer< FiffEvokedSetSPtr
 
typedef QSharedPointer< const FiffEvokedSetConstSPtr
 

Public Member Functions

 FiffEvokedSet ()
 
 FiffEvokedSet (QIODevice &p_IODevice)
 
 FiffEvokedSet (const FiffEvokedSet &p_FiffEvokedSet)
 
 ~FiffEvokedSet ()
 
void clear ()
 
FiffEvokedSet pick_channels (const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
 
bool compensate_to (FiffEvokedSet &p_FiffEvokedSet, fiff_int_t to) const
 
bool find_evoked (const FiffEvokedSet &p_FiffEvokedSet) const
 

Static Public Member Functions

static bool read (QIODevice &p_IODevice, FiffEvokedSet &p_FiffEvokedSet, QPair< QVariant, QVariant > baseline=defaultVariantPair, bool proj=true)
 

Public Attributes

FiffInfo info
 
QList< FiffEvokedevoked
 

Detailed Description

evoked data set

Fiff evoked data set

Definition at line 91 of file fiff_evoked_set.h.

Member Typedef Documentation

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

Const shared pointer type for FiffEvokedSet.

Definition at line 96 of file fiff_evoked_set.h.

Shared pointer type for FiffEvokedSet.

Definition at line 95 of file fiff_evoked_set.h.

Constructor & Destructor Documentation

FiffEvokedSet::FiffEvokedSet ( )

Constructs a fiff evoked data set.

Definition at line 68 of file fiff_evoked_set.cpp.

FiffEvokedSet::FiffEvokedSet ( QIODevice &  p_IODevice)

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

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

Definition at line 76 of file fiff_evoked_set.cpp.

FiffEvokedSet::FiffEvokedSet ( const FiffEvokedSet p_FiffEvokedSet)

Copy constructor.

Parameters
[in]p_FiffEvokedSetFiff evoked data set which should be copied

Definition at line 88 of file fiff_evoked_set.cpp.

FiffEvokedSet::~FiffEvokedSet ( )

Destroys the fiff evoked data set.

Definition at line 98 of file fiff_evoked_set.cpp.

Member Function Documentation

void FiffEvokedSet::clear ( )

Initializes fiff evoked data set.

Definition at line 106 of file fiff_evoked_set.cpp.

bool FiffEvokedSet::compensate_to ( FiffEvokedSet p_FiffEvokedSet,
fiff_int_t  to 
) const

mne_compensate_to

MNE toolbox root function ### Implementation of the mne_compensate_to function

Apply compensation to the data as desired

Parameters
[in]todesired compensation in the output
[in,out]p_FiffEvokedEvoked set to compensate
Returns
true if succeeded, false otherwise

Definition at line 166 of file fiff_evoked_set.cpp.

bool FiffEvokedSet::find_evoked ( const FiffEvokedSet p_FiffEvokedSet) const

fiff_find_evoked

MNE toolbox root function

Find evoked data sets

Parameters
[out]p_FiffEvokedSetThe read evoked data set
Returns
true when any set was found, false otherwise

Definition at line 193 of file fiff_evoked_set.cpp.

FiffEvokedSet FiffEvokedSet::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 set

Definition at line 115 of file fiff_evoked_set.cpp.

bool FiffEvokedSet::read ( QIODevice &  p_IODevice,
FiffEvokedSet p_FiffEvokedSet,
QPair< QVariant, QVariant >  baseline = defaultVariantPair,
bool  proj = true 
)
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_FiffEvokedSetThe read evoked data set
[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)
Returns
true when successful, false otherwise

Definition at line 212 of file fiff_evoked_set.cpp.

Member Data Documentation

QList<FiffEvoked> FIFFLIB::FiffEvokedSet::evoked

List of Fiff Evoked Data

Definition at line 201 of file fiff_evoked_set.h.

FiffInfo FIFFLIB::FiffEvokedSet::info

FIFF measurement information

Definition at line 200 of file fiff_evoked_set.h.


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