This documentation is for development version 0.18.dev0.

mne.sensitivity_map

mne.sensitivity_map(fwd, projs=None, ch_type='grad', mode='fixed', exclude=[], verbose=None)[source]

Compute sensitivity map.

Such maps are used to know how much sources are visible by a type of sensor, and how much projections shadow some sources.

Parameters:
fwd : Forward

The forward operator.

projs : list

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 and 7 of the command mne_sensitivity_map.

exclude : list of string | str

List of channels to exclude. If empty do not exclude any (default). If ‘bads’, exclude channels in fwd[‘info’][‘bads’].

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Returns:
stc : SourceEstimate | VolSourceEstimate

The sensitivity map as a SourceEstimate or VolSourceEstimate instance for visualization.