MNELIB::MNECTFCompData Class Reference

Represents a single CTF compensation data element. More...

#include <mne_ctf_comp_data.h>

Public Types
typedef QSharedPointer< MNECTFCompData >	SPtr
typedef QSharedPointer< const MNECTFCompData >	ConstSPtr

Public Member Functions
	MNECTFCompData ()
	MNECTFCompData (const MNECTFCompData &comp)
	~MNECTFCompData ()
int	calibrate (const QList< FIFFLIB::FiffChInfo > &chs, int nch, int do_it)

Public Attributes
int	kind
int	mne_kind
int	calibrated
std::unique_ptr< MNENamedMatrix >	data
std::unique_ptr< FIFFLIB::FiffSparseMatrix >	presel
std::unique_ptr< FIFFLIB::FiffSparseMatrix >	postsel
Eigen::VectorXf	presel_data
Eigen::VectorXf	comp_data
Eigen::VectorXf	postsel_data

Detailed Description

Represents a single CTF compensation data element.

Holds the compensation matrix together with optional sparse pre-/post-selectors and intermediate computation buffers used by MNECTFCompDataSet::apply() and apply_transpose().

Definition at line 81 of file mne_ctf_comp_data.h.

Member Typedef Documentation

ConstSPtr

typedef QSharedPointer<const MNECTFCompData> MNELIB::MNECTFCompData::ConstSPtr

Const shared pointer type for MNECTFCompData.

Definition at line 85 of file mne_ctf_comp_data.h.

SPtr

typedef QSharedPointer<MNECTFCompData> MNELIB::MNECTFCompData::SPtr

Shared pointer type for MNECTFCompData.

Definition at line 84 of file mne_ctf_comp_data.h.

Constructor & Destructor Documentation

MNECTFCompData() [1/2]

MNECTFCompData::MNECTFCompData

(

)

Constructs an empty MNE CTF Compensation Data object.

Definition at line 86 of file mne_ctf_comp_data.cpp.

MNECTFCompData() [2/2]

MNECTFCompData::MNECTFCompData

(

const MNECTFCompData &

comp

)

Copy constructor.

Parameters

[in]

comp

The compensation data to copy.

Definition at line 95 of file mne_ctf_comp_data.cpp.

~MNECTFCompData()

MNECTFCompData::~MNECTFCompData

(

)

Destructor.

Definition at line 111 of file mne_ctf_comp_data.cpp.

Member Function Documentation

calibrate()

int MNECTFCompData::calibrate	(	const QList< FIFFLIB::FiffChInfo > &	chs,
		int	nch,
		int	do_it )

Apply or remove channel calibration to/from the compensation matrix by scaling each element by (row_cal / col_cal) or its inverse.

Parameters

[in]	chs	Channel information used for calibration factors.
[in]	nch	Number of channels.
[in]	do_it	If TRUE, apply calibration; if FALSE, remove it.

Returns

OK on success, FAIL if a channel is not found.

Definition at line 117 of file mne_ctf_comp_data.cpp.

Member Data Documentation

calibrated

int MNELIB::MNECTFCompData::calibrated

Whether the coefficients are already calibrated.

Definition at line 124 of file mne_ctf_comp_data.h.

comp_data

Eigen::VectorXf MNELIB::MNECTFCompData::comp_data

Intermediate buffer for compensation results.

Definition at line 129 of file mne_ctf_comp_data.h.

data

std::unique_ptr<MNENamedMatrix> MNELIB::MNECTFCompData::data

The compensation matrix.

Definition at line 125 of file mne_ctf_comp_data.h.

kind

int MNELIB::MNECTFCompData::kind

The CTF compensation kind constant.

Definition at line 122 of file mne_ctf_comp_data.h.

mne_kind

int MNELIB::MNECTFCompData::mne_kind

MNE-internal compensation kind.

Definition at line 123 of file mne_ctf_comp_data.h.

postsel

std::unique_ptr<FIFFLIB::FiffSparseMatrix> MNELIB::MNECTFCompData::postsel

Sparse selector applied after compensation.

Definition at line 127 of file mne_ctf_comp_data.h.

postsel_data

Eigen::VectorXf MNELIB::MNECTFCompData::postsel_data

Intermediate buffer for post-selection results.

Definition at line 130 of file mne_ctf_comp_data.h.

presel

std::unique_ptr<FIFFLIB::FiffSparseMatrix> MNELIB::MNECTFCompData::presel

Sparse selector applied before compensation.

Definition at line 126 of file mne_ctf_comp_data.h.

presel_data

Eigen::VectorXf MNELIB::MNECTFCompData::presel_data

Intermediate buffer for pre-selection results.

Definition at line 128 of file mne_ctf_comp_data.h.

---

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

• src/libraries/mne/mne_ctf_comp_data.h
• src/libraries/mne/mne_ctf_comp_data.cpp