Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MRG, DOC: Fix ICA docstring, add whitening #8227

Merged
merged 2 commits into from
Sep 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,17 @@ general neuroimaging concepts. If you think a term is missing, please consider
A coordinate frame affine transformation, usually between the Neuromag head
coordinate frame and the MRI Surface RAS coordinate frame used by Freesurfer.

whitening
A linear operation that transforms data with a known covariance
structure into "whitened data" which has a covariance structure that
is the identity matrix (i.e., it creates virtual channels that are
uncorrelated and have unit variance).

The term "whitening" comes from the fact that light with a flat
frequency spectrum in the visible range is white, whereas
non-uniform frequency spectra lead to perception of different colors
(e.g., "pink noise" has a ``1/f`` characteristic, which for visible
light would appear pink).

.. LINKS

Expand Down
2 changes: 1 addition & 1 deletion mne/preprocessing/ica.py
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ def fit(self, inst, picks=None, start=None, stop=None, decim=None,

Parameters
----------
inst : instance of Raw, Epochs or Evoked
inst : instance of Raw or Epochs
Raw measurements to be decomposed.
%(picks_good_data_noref)s
This selection remains throughout the initialized ICA solution.
Expand Down
3 changes: 2 additions & 1 deletion tutorials/evoked/plot_whitened.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Plotting whitened data
======================

This tutorial demonstrates how to plot whitened evoked data.
This tutorial demonstrates how to plot :term:`whitened <whitening>` evoked
data.

Data are whitened for many processes, including dipole fitting, source
localization and some decoding algorithms. Viewing whitened data thus gives
Expand Down