v2.0.0
Loading...
Searching...
No Matches
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
 Build gain correction diagonal matrix for MEG channels.
Eigen::MatrixXd imbalanceMatrix () const
 Build imbalance matrix.

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) contains one line per MEG sensor with: channel_number gain imbalance_x imbalance_y imbalance_z

Usage:

FineCalibration cal = FineCalibration::read("/path/to/sss_cal.dat");
cal.write("/path/to/output.dat");
bool write(const QString &sPath) const
Write fine calibration to a .dat file.
static FineCalibration read(const QString &sPath)
Read a fine calibration file (.dat format).

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.

Definition at line 132 of file fine_calibration.h.

◆ entries()

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

Get the calibration entries.

Definition at line 103 of file fine_calibration.h.

◆ findEntry()

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

Find entry by channel number.

Parameters
[in]chNumberChannel number to find.
[out]entryFound entry (if any).
Returns
true if found.

Definition at line 110 of file fine_calibration.cpp.

◆ gainVector()

VectorXd FineCalibration::gainVector ( ) const

Build gain correction diagonal matrix for MEG channels.

Returns a diagonal matrix where each diagonal element is the gain factor for the corresponding MEG channel (in the order of m_entries).

Returns
Diagonal gain matrix (n_entries × n_entries).

Definition at line 123 of file fine_calibration.cpp.

◆ imbalanceMatrix()

MatrixXd FineCalibration::imbalanceMatrix ( ) const

Build imbalance matrix.

Returns a matrix of cross-talk imbalance vectors (n_entries × 3).

Definition at line 134 of file fine_calibration.cpp.

◆ isEmpty()

bool UTILSLIB::FineCalibration::isEmpty ( ) const
inline

Check if empty.

Definition at line 115 of file fine_calibration.h.

◆ read()

FineCalibration FineCalibration::read ( const QString & sPath)
static

Read a fine calibration file (.dat format).

Expected format: whitespace-separated columns per line: channel_number gain imbalance_x imbalance_y imbalance_z Lines starting with '#' are comments.

Parameters
[in]sPathPath 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.

Definition at line 109 of file fine_calibration.h.

◆ write()

bool FineCalibration::write ( const QString & sPath) const

Write fine calibration to a .dat file.

Parameters
[in]sPathOutput file path.
Returns
true if successful.

Definition at line 84 of file fine_calibration.cpp.


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