MNE-CPP  0.1.9
A Framework for Electrophysiology
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
FIFFLIB::FiffInfoBase Class Reference

light measurement info More...

#include <fiff_info_base.h>

Public Types

typedef QSharedPointer< FiffInfoBaseSPtr
 
typedef QSharedPointer< const FiffInfoBaseConstSPtr
 

Public Member Functions

 FiffInfoBase ()
 
 FiffInfoBase (const FiffInfoBase &p_FiffInfoBase)
 
virtual ~FiffInfoBase ()
 
void clear ()
 
QString channel_type (qint32 idx) const
 
bool isEmpty () const
 
FiffInfoBase pick_info (const Eigen::RowVectorXi *sel=Q_NULLPTR) const
 
Eigen::RowVectorXi pick_types (const QString meg, bool eeg=false, bool stim=false, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
 
Eigen::RowVectorXi pick_types (bool meg, bool eeg=false, bool stim=false, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
 
QStringList get_channel_types ()
 

Static Public Member Functions

static Eigen::RowVectorXi pick_channels (const QStringList &ch_names, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList)
 

Public Attributes

QString filename
 
QStringList bads
 
FiffId meas_id
 
fiff_int_t nchan
 
QList< FiffChInfochs
 
QStringList ch_names
 
FiffCoordTrans dev_head_t
 
FiffCoordTrans ctf_head_t
 

Friends

bool operator== (const FiffInfoBase &a, const FiffInfoBase &b)
 

Detailed Description

light measurement info

Light measurement info

Definition at line 74 of file fiff_info_base.h.

Inheritance diagram for FIFFLIB::FiffInfoBase:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FiffInfoBase.

Definition at line 79 of file fiff_info_base.h.

◆ SPtr

typedef QSharedPointer<FiffInfoBase> FIFFLIB::FiffInfoBase::SPtr

Shared pointer type for FiffInfoBase.

Definition at line 78 of file fiff_info_base.h.

Constructor & Destructor Documentation

◆ FiffInfoBase() [1/2]

FiffInfoBase::FiffInfoBase ( )

Constructors the light fiff measurement file information.

Definition at line 56 of file fiff_info_base.cpp.

◆ FiffInfoBase() [2/2]

FiffInfoBase::FiffInfoBase ( const FiffInfoBase p_FiffInfoBase)

Copy constructor.

Parameters
[in]p_FiffInfoBaselight FIFF measurement information which should be copied.

Definition at line 64 of file fiff_info_base.cpp.

◆ ~FiffInfoBase()

FiffInfoBase::~FiffInfoBase ( )
virtual

Destroys the light fiff measurement file information.

Definition at line 78 of file fiff_info_base.cpp.

Member Function Documentation

◆ channel_type()

QString FiffInfoBase::channel_type ( qint32  idx) const

Get channel type.

Parameters
[in]idxIndex of channel.
Returns
Type of channel ('grad', 'mag', 'eeg', 'stim', 'eog', 'emg', 'ecg').

Definition at line 84 of file fiff_info_base.cpp.

◆ clear()

void FiffInfoBase::clear ( )

Initializes light FIFF measurement information.

Definition at line 118 of file fiff_info_base.cpp.

◆ get_channel_types()

QStringList FiffInfoBase::get_channel_types ( )

Parses the channel info information and returns a string list of channel types.

Returns
The channel types present in this fiff info (grad,mag,eeg,ecg,emg,misc,stim).

Definition at line 247 of file fiff_info_base.cpp.

◆ isEmpty()

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

True if FIFF measurement file information is empty.

Returns
true if FIFF measurement file information is empty.

Definition at line 233 of file fiff_info_base.h.

◆ pick_channels()

RowVectorXi FiffInfoBase::pick_channels ( const QStringList &  ch_names,
const QStringList &  include = defaultQStringList,
const QStringList &  exclude = defaultQStringList 
)
static

fiff_pick_channels

MNE toolbox root function

Make a selector to pick desired channels from data

Parameters
[in]ch_names- The channel name list to consult.
[in]include- Channels to include (if empty, include all available).
[in]exclude- Channels to exclude (if empty, do not exclude any).
Returns
the selector matrix (row Vector).

Definition at line 198 of file fiff_info_base.cpp.

◆ pick_info()

FiffInfoBase FiffInfoBase::pick_info ( const Eigen::RowVectorXi *  sel = Q_NULLPTR) const

fiff_pick_info

MNE toolbox root function

Pick desired channels from measurement info

Parameters
[in]selList of channels to select.
Returns
Info modified according to sel.

Definition at line 224 of file fiff_info_base.cpp.

◆ pick_types() [1/2]

RowVectorXi FiffInfoBase::pick_types ( const QString  meg,
bool  eeg = false,
bool  stim = false,
const QStringList &  include = defaultQStringList,
const QStringList &  exclude = defaultQStringList 
) const

fiff_pick_types (highy diversity in meg picking)

MNE toolbox root function

Create a selector to pick desired channel types from data

Parameters
[in]megIt can be "all", to select all or it can be "mag" or "grad" to select only gradiometers or magnetometers.
[in]eegInclude EEG channels.
[in]stimInclude stimulus channels.
[in]includeAdditional channels to include (if empty, do not add any).
[in]excludeChannels to exclude (if empty, do not exclude any).
Returns
the selector matrix (row vector).

Definition at line 132 of file fiff_info_base.cpp.

◆ pick_types() [2/2]

RowVectorXi FiffInfoBase::pick_types ( bool  meg,
bool  eeg = false,
bool  stim = false,
const QStringList &  include = defaultQStringList,
const QStringList &  exclude = defaultQStringList 
) const

fiff_pick_types

MNE toolbox root function

Create a selector to pick desired channel types from data Use overloaded pick_types method to specify meg (grad, mag, ref_meg)type

Parameters
[in]megInclude MEG channels.
[in]eegInclude EEG channels.
[in]stimInclude stimulus channels.
[in]includeAdditional channels to include (if empty, do not add any).
[in]excludeChannels to exclude (if empty, do not exclude any).
Returns
the selector matrix (row vector).

Definition at line 188 of file fiff_info_base.cpp.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const FiffInfoBase a,
const FiffInfoBase b 
)
friend

Overloaded == operator to compare an object to this instance.

Parameters
[in]objectThe object which should be compared to.
Returns
true if equal, false otherwise.

Definition at line 240 of file fiff_info_base.h.

Member Data Documentation

◆ bads

QStringList FIFFLIB::FiffInfoBase::bads

List of bad channels.

Definition at line 220 of file fiff_info_base.h.

◆ ch_names

QStringList FIFFLIB::FiffInfoBase::ch_names

List of all channel names.

Definition at line 224 of file fiff_info_base.h.

◆ chs

QList<FiffChInfo> FIFFLIB::FiffInfoBase::chs

List of all channel info descriptors.

Definition at line 223 of file fiff_info_base.h.

◆ ctf_head_t

FiffCoordTrans FIFFLIB::FiffInfoBase::ctf_head_t

Coordinate transformation ToDo...

Definition at line 226 of file fiff_info_base.h.

◆ dev_head_t

FiffCoordTrans FIFFLIB::FiffInfoBase::dev_head_t

Coordinate transformation ToDo...

Definition at line 225 of file fiff_info_base.h.

◆ filename

QString FIFFLIB::FiffInfoBase::filename

Filename when the info is read of a fiff file.

Definition at line 219 of file fiff_info_base.h.

◆ meas_id

FiffId FIFFLIB::FiffInfoBase::meas_id

Measurement ID.

Definition at line 221 of file fiff_info_base.h.

◆ nchan

fiff_int_t FIFFLIB::FiffInfoBase::nchan

Number of channels.

Definition at line 222 of file fiff_info_base.h.


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