diff --git a/mne/proj.py b/mne/proj.py index 72a027061dc..94f5b34943a 100644 --- a/mne/proj.py +++ b/mne/proj.py @@ -393,11 +393,21 @@ def sensitivity_map( List of projection vectors. ch_type : ``'grad'`` | ``'mag'`` | ``'eeg'`` The type of sensors to use. - mode : str - The type of sensitivity map computed. See manual. Should be ``'free'``, - ``'fixed'``, ``'ratio'``, ``'radiality'``, ``'angle'``, - ``'remaining'``, or ``'dampening'`` corresponding to the argument - ``--map 1, 2, 3, 4, 5, 6, 7`` of the command ``mne_sensitivity_map``. + mode : ``'free'`` | ``'fixed'`` | ``'ratio'`` | ``'radiality'`` | ``'angle'`` | ``'remaining'`` | ``'dampening'`` + + Which sensitivity quantity to compute: + + - 'free' : Maximum obtainable signal over all source orientations. + - 'fixed' : Signal from sources constrained to be normal to the + cortical surface. + - 'ratio' : Ratio of 'fixed' sensitivity to the 'free' + (maximum-over-orientations) sensitivity. + - 'radiality' : Ratio of signal from sources normal to the cortex + to the maximum signal among all orientations. + - 'angle' : Subspace angle with the noise subspace. + - 'remaining' : Fraction of signal remaining after the projection + (e.g., after SSS/SSP). + - 'dampening' : Fraction of signal dampening due to the projection. exclude : list of str | str List of channels to exclude. If empty do not exclude any (default). If ``'bads'``, exclude channels in ``fwd['info']['bads']``. @@ -413,7 +423,7 @@ def sensitivity_map( ----- When mode is ``'fixed'`` or ``'free'``, the sensitivity map is normalized by its maximum value. - """ + """ # noqa: E501 # check strings _check_option("ch_type", ch_type, ["eeg", "grad", "mag"]) _check_option(