UTILSLIB::FineCalibration Class Reference

Fine calibration data for SSS. More...

#include <fine_calibration.h>

Public Member Functions
	FineCalibration ()=default
bool	write (const QString &sPath) const
	Write fine calibration to a .dat file.
const QList< FineCalEntry > &	entries () const
	Get the calibration entries.
int	size () const
	Get the number of entries.
bool	isEmpty () const
	Check if empty.
bool	findEntry (int chNumber, FineCalEntry &entry) const
	Find entry by channel number.
void	addEntry (const FineCalEntry &entry)
	Add an entry.
Eigen::VectorXd	gainVector () const
	Magnetometer calibration factors.
Eigen::MatrixXd	imbalanceMatrix () const
	Gradiometer imbalance terms.

Static Public Member Functions
static FineCalibration	read (const QString &sPath)
	Read a fine calibration file (.dat format).

Detailed Description

Fine calibration data for SSS.

A fine calibration file (.dat) has one line per MEG sensor, as read and written by mne.preprocessing.read_fine_calibration / write_fine_calibration: channel_number position(3) x_axis(3) y_axis(3) z_axis(3) imbalance(1 or 3)

Definition at line 70 of file fine_calibration.h.

Constructor & Destructor Documentation

FineCalibration()

UTILSLIB::FineCalibration::FineCalibration ( )

default

Member Function Documentation

addEntry()

void UTILSLIB::FineCalibration::addEntry ( const FineCalEntry & entry )

inline

Add an entry.

Parameters

[in]

entry

Calibration entry appended to the end of the list.

Definition at line 148 of file fine_calibration.h.

entries()

const QList< FineCalEntry > & UTILSLIB::FineCalibration::entries ( ) const

inline

Get the calibration entries.

Returns

Const reference to the list of per-channel calibration entries.

Definition at line 104 of file fine_calibration.h.

findEntry()

bool FineCalibration::findEntry	(	int	chNumber,
		FineCalEntry &	entry ) const

Find entry by channel number.

Parameters

[in]	chNumber	Channel number to find.
[out]	entry	Found entry (if any).

Returns

true if found.

Definition at line 116 of file fine_calibration.cpp.

gainVector()

VectorXd FineCalibration::gainVector

(

)

const

Magnetometer calibration factors.

Returns

One factor per entry: the single calibration term of a magnetometer (channel number ending in 1), 1.0 for gradiometers.

Definition at line 129 of file fine_calibration.cpp.

imbalanceMatrix()

MatrixXd FineCalibration::imbalanceMatrix

(

)

const

Gradiometer imbalance terms.

Returns

Matrix (n_entries × 3): the one or three imbalance terms of each gradiometer, zero-padded; zero rows for magnetometers.

Definition at line 142 of file fine_calibration.cpp.

isEmpty()

bool UTILSLIB::FineCalibration::isEmpty ( ) const

inline

Check if empty.

Returns

True if no calibration entries are stored.

Definition at line 126 of file fine_calibration.h.

read()

FineCalibration FineCalibration::read ( const QString & sPath )

static

Read a fine calibration file (.dat format).

Each line has 14 or 16 whitespace-separated columns (see the class description); lines starting with '#' are comments and malformed lines are skipped.

Parameters

[in]

sPath

Path to .dat file.

Returns

FineCalibration with loaded entries.

Definition at line 39 of file fine_calibration.cpp.

size()

int UTILSLIB::FineCalibration::size ( ) const

inline

Get the number of entries.

Returns

Number of calibration entries (one per MEG channel).

Definition at line 115 of file fine_calibration.h.

write()

bool FineCalibration::write

(

const QString &

sPath

)

const

Write fine calibration to a .dat file.

Parameters

[in]

sPath

Output file path.

Returns

true if successful.

Definition at line 86 of file fine_calibration.cpp.

---

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

• src/libraries/dsp/fine_calibration.h
• src/libraries/dsp/fine_calibration.cpp