v2.0.0
Loading...
Searching...
No Matches
UTILSLIB::SSSParams Struct Reference

Implements Signal Space Separation (SSS) and temporal SSS (tSSS) for MEG data. More...

#include <sss.h>

Public Attributes

int iOrderIn = 8
int iOrderOut = 3
Eigen::Vector3d origin {0.0, 0.0, 0.04}
double dRegIn = 1e-5

Detailed Description

Implements Signal Space Separation (SSS) and temporal SSS (tSSS) for MEG data.

Quick-start example:

// Build the SSS basis once from sensor geometry
p.iOrderIn = 8; // Standard internal order
p.iOrderOut = 3; // Standard external order
p.origin = Eigen::Vector3d(0,0,0.04); // 4 cm above head origin
SSS::Basis basis = SSS::computeBasis(fiffInfo, p);
// Apply SSS (suppress environmental noise)
Eigen::MatrixXd cleanData = SSS::apply(rawMegData, basis);
// Apply tSSS (additionally suppress near-field artefacts)
Eigen::MatrixXd tSssData = SSS::applyTemporal(rawMegData, basis);
Eigen::Vector3d origin
Definition sss.h:106
SSSParams Params
Definition sss.h:113
static Basis computeBasis(const FIFFLIB::FiffInfo &fiffInfo, const Params &params=Params())
Definition sss.cpp:301
static Eigen::MatrixXd apply(const Eigen::MatrixXd &matData, const Basis &basis)
Definition sss.cpp:424
static Eigen::MatrixXd applyTemporal(const Eigen::MatrixXd &matData, const Basis &basis, int iBufferLength=10000, double dCorrLimit=0.98)
Definition sss.cpp:452
Precomputed SSS basis and projectors for a given sensor array.
Definition sss.h:122

Configuration parameters for SSS/tSSS (defined outside class to work around a Clang default-argument/nested-struct limitation).

Definition at line 102 of file sss.h.

Member Data Documentation

◆ dRegIn

double UTILSLIB::SSSParams::dRegIn = 1e-5

Tikhonov regularisation for the combined-basis pseudoinverse.

Definition at line 107 of file sss.h.

◆ iOrderIn

int UTILSLIB::SSSParams::iOrderIn = 8

Internal spherical-harmonic expansion order (default 8). N_in = iOrderIn*(iOrderIn+2) = 80.

Definition at line 104 of file sss.h.

◆ iOrderOut

int UTILSLIB::SSSParams::iOrderOut = 3

External spherical-harmonic expansion order (default 3). N_out = iOrderOut*(iOrderOut+2) = 15.

Definition at line 105 of file sss.h.

◆ origin

Eigen::Vector3d UTILSLIB::SSSParams::origin {0.0, 0.0, 0.04}

Expansion origin in metres, head-coordinate frame (default: 4 cm superior to head origin).

Definition at line 106 of file sss.h.


The documentation for this struct was generated from the following file: