M/EEG signal decomposition using the Spatio-Spectral Decomposition (SSD).
SSD seeks to maximize the power at a frequency band of interest while simultaneously minimizing it at the flanking (surrounding) frequency bins (considered noise). It extremizes the covariance matrices associated with signal and noise [1].
SSD can either be used as a dimensionality reduction method or a ‘denoised’ low rank factorization method [2].
mne.Info
The mne.Info
object with information about the sensors and methods of measurement. Must match the input data.
dict
Filtering for the frequencies of interest.
dict
Filtering for the frequencies of non-interest.
float
| str
| None
(default)Which covariance estimator to use.
If not None (same as ‘empirical’), allow regularization for
covariance estimation. If float, shrinkage is used
(0 <= shrinkage <= 1). For str options, reg will be passed to
method to mne.compute_covariance()
.
int
| None
(default None
)The number of components to extract from the signal. If n_components is None, no dimensionality reduction is applied.
array
of int
| None
(default None
)The indices of good channels.
False
)If set to True, the components are sorted accordingly to the spectral ratio. See Eq. (24) in [1].
True
)If return_filtered is True, data is bandpassed and projected onto the SSD components.
int
(default None
)If sort_by_spectral_ratio is set to True, then the SSD sources will be
sorted accordingly to their spectral ratio which is calculated based on
mne.time_frequency.psd_array_welch()
function. The n_fft parameter
set the length of FFT used.
See mne.time_frequency.psd_array_welch()
for more information.
dict
| None
(default None
)As in mne.decoding.SPoC
The default is None.
None
| dict
| ‘info’ | ‘full’As in mne.decoding.SPoC
This controls the rank computation that can be read from the
measurement info or estimated from the data.
See Notes of mne.compute_rank()
for details.
We recommend to use ‘full’ when working with epoched data.
References
Methods
|
Remove selected components from the signal. |
|
Estimate the SSD decomposition on raw or epoched data. |
|
Fit to data, then transform it. |
|
Get parameters for this estimator. |
|
Get the spectal signal-to-noise ratio for each spatial filter. |
Not implemented yet. |
|
|
Set the parameters of this estimator. |
|
Estimate epochs sources given the SSD filters. |
Remove selected components from the signal.
This procedure will reconstruct M/EEG signals from which the dynamics described by the excluded components is subtracted (denoised by low-rank factorization). See [2] for more information.
Note
Unlike in other classes with an apply method, only NumPy arrays are supported (not instances of MNE objects).
The input data from which to estimate the SSD. Either 2D array obtained from continuous data or 3D array obtained from epoched data.
The processed data.
Estimate the SSD decomposition on raw or epoched data.
SSD
Returns the modified instance.
Examples using fit
:
Compute Spectro-Spatial Decomposition (SSD) spatial filters
Fit to data, then transform it.
Fits transformer to X
and y
with optional parameters
fit_params
, and returns a transformed version of X
.
Get the spectal signal-to-noise ratio for each spatial filter.
Spectral ratio measure for best n_components selection See [1], Eq. (24).
array
Data projected to SSD space.
References
Examples using get_spectral_ratio
:
Compute Spectro-Spatial Decomposition (SSD) spatial filters
Set the parameters of this estimator.
The method works on simple estimators as well as on nested objects
(such as pipelines). The latter have parameters of the form
<component>__<parameter>
so that it’s possible to update each
component of a nested object.
dict
Parameters.
The object.
Estimate epochs sources given the SSD filters.
The input data from which to estimate the SSD. Either 2D array obtained from continuous data or 3D array obtained from epoched data.
The processed data.
Examples using transform
:
Compute Spectro-Spatial Decomposition (SSD) spatial filters
mne.decoding.SSD
#Compute Spectro-Spatial Decomposition (SSD) spatial filters