FIFFLIB::FiffCtfComp Class Reference

One CTF software-gradient compensation matrix: grade kind, calibration flag and the gradiometer × reference named matrix. More...

#include <fiff_ctf_comp.h>

Public Types
using	SPtr = QSharedPointer<FiffCtfComp>
using	ConstSPtr = QSharedPointer<const FiffCtfComp>
using	UPtr = std::unique_ptr<FiffCtfComp>
using	ConstUPtr = std::unique_ptr<const FiffCtfComp>

Public Member Functions
	FiffCtfComp ()
	FiffCtfComp (const FiffCtfComp &p_FiffCtfComp)
FiffCtfComp &	operator= (const FiffCtfComp &other)=default
	~FiffCtfComp ()
void	clear ()
bool	calibrate (const QList< FiffChInfo > &chs)

Public Attributes
fiff_int_t	ctfkind
fiff_int_t	kind
bool	save_calibrated
Eigen::MatrixXd	rowcals
Eigen::MatrixXd	colcals
FiffNamedMatrix::SDPtr	data

Detailed Description

One CTF software-gradient compensation matrix: grade kind, calibration flag and the gradiometer × reference named matrix.

A list of FiffCtfComp lives inside FiffInfo and lets raw / evoked data be moved between compensation grades by chaining the appropriate matrices. The save_calibrated flag controls whether the matrix was stored already-calibrated (and therefore must not be re-multiplied by the channel cals on apply).

Definition at line 76 of file fiff_ctf_comp.h.

Member Typedef Documentation

ConstSPtr

using FIFFLIB::FiffCtfComp::ConstSPtr = QSharedPointer<const FiffCtfComp>

Const shared pointer type for FiffCtfComp.

Definition at line 80 of file fiff_ctf_comp.h.

ConstUPtr

using FIFFLIB::FiffCtfComp::ConstUPtr = std::unique_ptr<const FiffCtfComp>

Const unique pointer type for FiffCtfComp.

Definition at line 82 of file fiff_ctf_comp.h.

SPtr

using FIFFLIB::FiffCtfComp::SPtr = QSharedPointer<FiffCtfComp>

Shared pointer type for FiffCtfComp.

Definition at line 79 of file fiff_ctf_comp.h.

UPtr

using FIFFLIB::FiffCtfComp::UPtr = std::unique_ptr<FiffCtfComp>

Unique pointer type for FiffCtfComp.

Definition at line 81 of file fiff_ctf_comp.h.

Constructor & Destructor Documentation

FiffCtfComp() [1/2]

FiffCtfComp::FiffCtfComp

(

)

Constructs the CTF software compensation data

Definition at line 35 of file fiff_ctf_comp.cpp.

FiffCtfComp() [2/2]

FiffCtfComp::FiffCtfComp

(

const FiffCtfComp &

p_FiffCtfComp

)

Copy constructor.

Parameters

[in]

p_FiffCtfComp

CTF software compensation data which should be copied.

Definition at line 45 of file fiff_ctf_comp.cpp.

~FiffCtfComp()

FiffCtfComp::~FiffCtfComp

(

)

Destroys the CTF software compensation data.

Definition at line 57 of file fiff_ctf_comp.cpp.

Member Function Documentation

calibrate()

bool FiffCtfComp::calibrate

(

const QList< FiffChInfo > &

chs

)

Brings a compensator stored uncalibrated into calibrated units, as mne _read_ctf_comp does: each matrix element is scaled by its row channel's range * cal and divided by its column channel's. The factors are kept in rowcals and colcals so that write_ctf_comp can undo them. A compensator saved calibrated is left as it is.

Parameters

[in]

chs

The channels the compensator refers to by name.

Returns

false if a row or column channel is missing from, or ambiguous in, chs.

Definition at line 97 of file fiff_ctf_comp.cpp.

clear()

void FiffCtfComp::clear

(

)

Initializes the CTF software compensation data.

Definition at line 63 of file fiff_ctf_comp.cpp.

operator=()

FiffCtfComp & FIFFLIB::FiffCtfComp::operator= ( const FiffCtfComp & other )

default

Copy assignment. Every member has value semantics, so the compiler-generated member-wise assignment is correct. It is declared explicitly because declaring a copy constructor and/or a destructor deprecates the implicitly generated one.

Parameters

[in]

other

Object to assign from.

Returns

reference to this object.

Member Data Documentation

colcals

Eigen::MatrixXd FIFFLIB::FiffCtfComp::colcals

Column calibrations.

Definition at line 141 of file fiff_ctf_comp.h.

ctfkind

fiff_int_t FIFFLIB::FiffCtfComp::ctfkind

CTF kind.

Definition at line 137 of file fiff_ctf_comp.h.

data

FiffNamedMatrix::SDPtr FIFFLIB::FiffCtfComp::data

Compensation data.

Definition at line 142 of file fiff_ctf_comp.h.

kind

fiff_int_t FIFFLIB::FiffCtfComp::kind

Fiff kind -> fiff_constants.h.

Definition at line 138 of file fiff_ctf_comp.h.

rowcals

Eigen::MatrixXd FIFFLIB::FiffCtfComp::rowcals

Row calibrations.

Definition at line 140 of file fiff_ctf_comp.h.

save_calibrated

bool FIFFLIB::FiffCtfComp::save_calibrated

If data should be saved calibrated.

Definition at line 139 of file fiff_ctf_comp.h.

---

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

• src/libraries/fiff/fiff_ctf_comp.h
• src/libraries/fiff/fiff_ctf_comp.cpp