Skip to content

Commit 7e357df

Browse files
1himandrammock
andauthored
Sensitivity map doc improved (#13578)
Co-authored-by: Daniel McCloy <dan@mccloy.info>
1 parent 7ee7155 commit 7e357df

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

mne/proj.py

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -393,11 +393,21 @@ def sensitivity_map(
393393
List of projection vectors.
394394
ch_type : ``'grad'`` | ``'mag'`` | ``'eeg'``
395395
The type of sensors to use.
396-
mode : str
397-
The type of sensitivity map computed. See manual. Should be ``'free'``,
398-
``'fixed'``, ``'ratio'``, ``'radiality'``, ``'angle'``,
399-
``'remaining'``, or ``'dampening'`` corresponding to the argument
400-
``--map 1, 2, 3, 4, 5, 6, 7`` of the command ``mne_sensitivity_map``.
396+
mode : ``'free'`` | ``'fixed'`` | ``'ratio'`` | ``'radiality'`` | ``'angle'`` | ``'remaining'`` | ``'dampening'``
397+
398+
Which sensitivity quantity to compute:
399+
400+
- 'free' : Maximum obtainable signal over all source orientations.
401+
- 'fixed' : Signal from sources constrained to be normal to the
402+
cortical surface.
403+
- 'ratio' : Ratio of 'fixed' sensitivity to the 'free'
404+
(maximum-over-orientations) sensitivity.
405+
- 'radiality' : Ratio of signal from sources normal to the cortex
406+
to the maximum signal among all orientations.
407+
- 'angle' : Subspace angle with the noise subspace.
408+
- 'remaining' : Fraction of signal remaining after the projection
409+
(e.g., after SSS/SSP).
410+
- 'dampening' : Fraction of signal dampening due to the projection.
401411
exclude : list of str | str
402412
List of channels to exclude. If empty do not exclude any (default).
403413
If ``'bads'``, exclude channels in ``fwd['info']['bads']``.
@@ -413,7 +423,7 @@ def sensitivity_map(
413423
-----
414424
When mode is ``'fixed'`` or ``'free'``, the sensitivity map is normalized
415425
by its maximum value.
416-
"""
426+
""" # noqa: E501
417427
# check strings
418428
_check_option("ch_type", ch_type, ["eeg", "grad", "mag"])
419429
_check_option(

0 commit comments

Comments
 (0)