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

FIFF measurement file information. More...

#include <fiff_info.h>

Inheritance diagram for FIFFLIB::FiffInfo:
FIFFLIB::FiffInfoBase

Public Types

typedef QSharedPointer< FiffInfoSPtr
 
typedef QSharedPointer< const FiffInfoConstSPtr
 
- Public Types inherited from FIFFLIB::FiffInfoBase
typedef QSharedPointer< FiffInfoBaseSPtr
 
typedef QSharedPointer< const FiffInfoBaseConstSPtr
 

Public Member Functions

 FiffInfo ()
 
 FiffInfo (const FiffInfo &p_FiffInfo)
 
 ~FiffInfo ()
 
void clear ()
 
bool make_compensator (fiff_int_t from, fiff_int_t to, FiffCtfComp &ctf_comp, bool exclude_comp_chs=false) const
 
qint32 get_current_comp ()
 
qint32 make_projector (MatrixXd &proj) const
 
qint32 make_projector (MatrixXd &proj, const QStringList &p_chNames) const
 
FiffInfo pick_info (const RowVectorXi &sel=defaultVectorXi) const
 
void set_current_comp (fiff_int_t value)
 
void writeToStream (FiffStream *p_pStream)
 
- Public Member Functions inherited from FIFFLIB::FiffInfoBase
 FiffInfoBase ()
 
 FiffInfoBase (const FiffInfoBase &p_FiffInfoBase)
 
 ~FiffInfoBase ()
 
void clear ()
 
QString channel_type (qint32 idx) const
 
bool isEmpty () const
 
FiffInfoBase pick_info (const RowVectorXi *sel=NULL) const
 
RowVectorXi pick_types (const QString meg, bool eeg=false, bool stim=false, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
 
RowVectorXi pick_types (bool meg, bool eeg=false, bool stim=false, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList) const
 

Static Public Member Functions

static QList< FiffChInfoset_current_comp (QList< FiffChInfo > &chs, fiff_int_t value)
 
- Static Public Member Functions inherited from FIFFLIB::FiffInfoBase
static RowVectorXi pick_channels (const QStringList &ch_names, const QStringList &include=defaultQStringList, const QStringList &exclude=defaultQStringList)
 

Public Attributes

FiffId file_id
 
fiff_int_t meas_date [2]
 
float sfreq
 
float highpass
 
float lowpass
 
FiffCoordTrans dev_ctf_t
 
QList< FiffDigPointdig
 
FiffCoordTrans dig_trans
 
QList< FiffProjprojs
 
QList< FiffCtfCompcomps
 
QString acq_pars
 
QString acq_stim
 
- Public Attributes inherited from FIFFLIB::FiffInfoBase
QString filename
 
QStringList bads
 
FiffId meas_id
 
fiff_int_t nchan
 
QList< FiffChInfochs
 
QStringList ch_names
 
FiffCoordTrans dev_head_t
 
FiffCoordTrans ctf_head_t
 

Detailed Description

FIFF measurement file information.

Provides fiff measurement file information

Definition at line 96 of file fiff_info.h.

Member Typedef Documentation

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

Const shared pointer type for FiffInfo.

Definition at line 100 of file fiff_info.h.

typedef QSharedPointer<FiffInfo> FIFFLIB::FiffInfo::SPtr

Shared pointer type for FiffInfo.

Definition at line 99 of file fiff_info.h.

Constructor & Destructor Documentation

FiffInfo::FiffInfo ( )

Constructors the fiff measurement file information.

Definition at line 58 of file fiff_info.cpp.

FiffInfo::FiffInfo ( const FiffInfo p_FiffInfo)

Copy constructor.

Parameters
[in]p_FiffInfoFIFF measurement information which should be copied

Definition at line 72 of file fiff_info.cpp.

FiffInfo::~FiffInfo ( )

Destroys the fiff measurement file information.

Definition at line 100 of file fiff_info.cpp.

Member Function Documentation

void FiffInfo::clear ( )

Initializes FIFF measurement information.

Definition at line 108 of file fiff_info.cpp.

qint32 FiffInfo::get_current_comp ( )

mne_get_current_comp

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

Get the current compensation in effect in the data

Returns
the current compensation

Definition at line 128 of file fiff_info.cpp.

bool FiffInfo::make_compensator ( fiff_int_t  from,
fiff_int_t  to,
FiffCtfComp ctf_comp,
bool  exclude_comp_chs = false 
) const

mne_make_compensator

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

Create a compensation matrix to bring the data from one compensation state to another

Parameters
[in]fromcompensation in the input data
[in]todesired compensation in the output
[out]ctf_compCompensation Matrix
[in]exclude_comp_chsexclude compensation channels from the output (optional)
Returns
true if succeeded, false otherwise

Definition at line 151 of file fiff_info.cpp.

qint32 FIFFLIB::FiffInfo::make_projector ( MatrixXd &  proj) const
inline

mne_make_projector_info

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

Make a SSP operator using the meas info

Parameters
[out]projThe projection operator to apply to the data
Returns
nproj - How many items in the projector

Definition at line 277 of file fiff_info.h.

qint32 FIFFLIB::FiffInfo::make_projector ( MatrixXd &  proj,
const QStringList &  p_chNames 
) const
inline

mne_make_projector_info

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

Make a SSP operator using the meas info

Parameters
[out]projThe projection operator to apply to the data
[in]p_chNamesList of channels to include in the projection matrix
Returns
nproj - How many items in the projector

Definition at line 285 of file fiff_info.h.

FiffInfo FiffInfo::pick_info ( const RowVectorXi &  sel = defaultVectorXi) 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 300 of file fiff_info.cpp.

void FIFFLIB::FiffInfo::set_current_comp ( fiff_int_t  value)
inline

Set the current compensation value in the channel info structures

Parameters
[in]valuecompensation value

Definition at line 293 of file fiff_info.h.

QList< FiffChInfo > FiffInfo::set_current_comp ( QList< FiffChInfo > &  chs,
fiff_int_t  value 
)
static

mne_set_current_comp

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

Consider taking the member function of set_current_comp(fiff_int_t value), when compensation should be applied to the channels of FiffInfo

Set the current compensation value in the channel info structures

Parameters
[in]chsfiff channel info list
[in]valuecompensation value
Returns
the current compensation

Definition at line 325 of file fiff_info.cpp.

void FiffInfo::writeToStream ( FiffStream p_pStream)

Writes the fiff information to an I/O Device, e.g. fiff file

Parameters
[in]p_IODeviceIO device to write the fiff info to. Writes the fiff information to a FIF stream
[in]p_pStreamThe stream to write to.

Definition at line 349 of file fiff_info.cpp.

Member Data Documentation

QString FIFFLIB::FiffInfo::acq_pars

Acquisition information ToDo...

Definition at line 268 of file fiff_info.h.

QString FIFFLIB::FiffInfo::acq_stim

Acquisition information ToDo...

Definition at line 269 of file fiff_info.h.

QList<FiffCtfComp> FIFFLIB::FiffInfo::comps

List of available CTF software compensators.

Definition at line 267 of file fiff_info.h.

FiffCoordTrans FIFFLIB::FiffInfo::dev_ctf_t

Coordinate transformation ToDo...

Definition at line 263 of file fiff_info.h.

QList<FiffDigPoint> FIFFLIB::FiffInfo::dig

List of all digitization point descriptors.

Definition at line 264 of file fiff_info.h.

FiffCoordTrans FIFFLIB::FiffInfo::dig_trans

Coordinate transformation ToDo...

Definition at line 265 of file fiff_info.h.

FiffId FIFFLIB::FiffInfo::file_id

File ID.

Definition at line 258 of file fiff_info.h.

float FIFFLIB::FiffInfo::highpass

Highpass frequency.

Definition at line 261 of file fiff_info.h.

float FIFFLIB::FiffInfo::lowpass

Lowpass frequency.

Definition at line 262 of file fiff_info.h.

fiff_int_t FIFFLIB::FiffInfo::meas_date[2]

Measurement date.

Definition at line 259 of file fiff_info.h.

QList<FiffProj> FIFFLIB::FiffInfo::projs

List of available SSP projectors.

Definition at line 266 of file fiff_info.h.

float FIFFLIB::FiffInfo::sfreq

Sample frequency.

Definition at line 260 of file fiff_info.h.


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