MNE-CPP  0.1.9
A Framework for Electrophysiology
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>

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 (Eigen::MatrixXd &proj) const
 
qint32 make_projector (Eigen::MatrixXd &proj, const QStringList &p_chNames) const
 
FiffInfo pick_info (const Eigen::RowVectorXi &sel=defaultVectorXi) const
 
void set_current_comp (fiff_int_t value)
 
void writeToStream (FiffStream *p_pStream) const
 
void print () const
 
- Public Member Functions inherited from FIFFLIB::FiffInfoBase
 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 QList< FiffChInfoset_current_comp (QList< FiffChInfo > &listFiffChInfo, fiff_int_t value)
 
- Static Public Member Functions inherited from FIFFLIB::FiffInfoBase
static Eigen::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 linefreq
 
float highpass
 
float lowpass
 
int proj_id
 
QString proj_name
 
QString xplotter_layout
 
QString experimenter
 
QString description
 
QString utc_offset
 
fiff_int_t gantry_angle
 
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 84 of file fiff_info.h.

Inheritance diagram for FIFFLIB::FiffInfo:
Inheritance graph

Member Typedef Documentation

◆ ConstSPtr

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

Const shared pointer type for FiffInfo.

Definition at line 88 of file fiff_info.h.

◆ SPtr

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

Shared pointer type for FiffInfo.

Definition at line 87 of file fiff_info.h.

Constructor & Destructor Documentation

◆ FiffInfo() [1/2]

FiffInfo::FiffInfo ( )

Constructors the fiff measurement file information.

Definition at line 61 of file fiff_info.cpp.

◆ FiffInfo() [2/2]

FiffInfo::FiffInfo ( const FiffInfo p_FiffInfo)

Copy constructor.

Parameters
[in]p_FiffInfoFIFF measurement information which should be copied.

Definition at line 76 of file fiff_info.cpp.

◆ ~FiffInfo()

FiffInfo::~FiffInfo ( )

Destroys the fiff measurement file information.

Definition at line 104 of file fiff_info.cpp.

Member Function Documentation

◆ clear()

void FiffInfo::clear ( )

Initializes FIFF measurement information.

< UTC offset of related meas_date (sHH:MM).

Definition at line 110 of file fiff_info.cpp.

◆ get_current_comp()

qint32 FiffInfo::get_current_comp ( )

mne_get_current_comp

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

Get the current compensation in effect in the data

Returns
the current compensation.

Definition at line 137 of file fiff_info.cpp.

◆ make_compensator()

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 ### Definition 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 159 of file fiff_info.cpp.

◆ make_projector() [1/2]

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

mne_make_projector_info

MNE toolbox root function ### Definition 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 278 of file fiff_info.h.

◆ make_projector() [2/2]

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

mne_make_projector_info

MNE toolbox root function ### Definition 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.

◆ pick_info()

FiffInfo FiffInfo::pick_info ( const Eigen::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 310 of file fiff_info.cpp.

◆ print()

void FiffInfo::print ( ) const

Prints class contents.

Definition at line 484 of file fiff_info.cpp.

◆ set_current_comp() [1/2]

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 292 of file fiff_info.h.

◆ set_current_comp() [2/2]

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

mne_set_current_comp

MNE toolbox root function ### Definition 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 334 of file fiff_info.cpp.

◆ writeToStream()

void FiffInfo::writeToStream ( FiffStream p_pStream) const

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 357 of file fiff_info.cpp.

Member Data Documentation

◆ acq_pars

QString FIFFLIB::FiffInfo::acq_pars

Acquisition information ToDo...

Definition at line 270 of file fiff_info.h.

◆ acq_stim

QString FIFFLIB::FiffInfo::acq_stim

Acquisition information ToDo...

Definition at line 271 of file fiff_info.h.

◆ comps

QList<FiffCtfComp> FIFFLIB::FiffInfo::comps

List of available CTF software compensators.

Definition at line 269 of file fiff_info.h.

◆ description

QString FIFFLIB::FiffInfo::description

(Textual) Description of an object.

Definition at line 262 of file fiff_info.h.

◆ dev_ctf_t

FiffCoordTrans FIFFLIB::FiffInfo::dev_ctf_t

Coordinate transformation ToDo...

Definition at line 265 of file fiff_info.h.

◆ dig

QList<FiffDigPoint> FIFFLIB::FiffInfo::dig

List of all digitization point descriptors.

Definition at line 266 of file fiff_info.h.

◆ dig_trans

FiffCoordTrans FIFFLIB::FiffInfo::dig_trans

Coordinate transformation ToDo...

Definition at line 267 of file fiff_info.h.

◆ experimenter

QString FIFFLIB::FiffInfo::experimenter

Experimenter name.

Definition at line 261 of file fiff_info.h.

◆ file_id

FiffId FIFFLIB::FiffInfo::file_id

File ID.

Definition at line 252 of file fiff_info.h.

◆ gantry_angle

fiff_int_t FIFFLIB::FiffInfo::gantry_angle

Tilt angle of the dewar in degrees.

Definition at line 264 of file fiff_info.h.

◆ highpass

float FIFFLIB::FiffInfo::highpass

Highpass frequency.

Definition at line 256 of file fiff_info.h.

◆ linefreq

float FIFFLIB::FiffInfo::linefreq

Power line frequency.

Definition at line 255 of file fiff_info.h.

◆ lowpass

float FIFFLIB::FiffInfo::lowpass

Lowpass frequency.

Definition at line 257 of file fiff_info.h.

◆ meas_date

fiff_int_t FIFFLIB::FiffInfo::meas_date[2]

Measurement date. TODO: use fiffTime instead to be MNE-C consistent

Definition at line 253 of file fiff_info.h.

◆ proj_id

int FIFFLIB::FiffInfo::proj_id

Project ID.

Definition at line 258 of file fiff_info.h.

◆ proj_name

QString FIFFLIB::FiffInfo::proj_name

Project name.

Definition at line 259 of file fiff_info.h.

◆ projs

QList<FiffProj> FIFFLIB::FiffInfo::projs

List of available SSP projectors.

Definition at line 268 of file fiff_info.h.

◆ sfreq

float FIFFLIB::FiffInfo::sfreq

Sample frequency.

Definition at line 254 of file fiff_info.h.

◆ utc_offset

QString FIFFLIB::FiffInfo::utc_offset

UTC offset of related meas_date (sHH:MM).

Definition at line 263 of file fiff_info.h.

◆ xplotter_layout

QString FIFFLIB::FiffInfo::xplotter_layout

xplotter layout tag.

Definition at line 260 of file fiff_info.h.


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