You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current documentation for the option 'mode' of mne.sensitivity_maps refers to a "manual" (presumbably the C-version of MNE), but there is no link (see below). I think the different choices should be explained in the documention of MNE-Python, without reference to a manual.
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.
The text was updated successfully, but these errors were encountered:
@olafhauk would you be up for taking the text from here and adding it?
$ mne_sensitivity_map --help
usage: mne_sensitivity_map [options]
Compute MEG and EEG sensitivity maps over the cortex.
--fwd name The input file.
--proj name Load a projection operator from this file
--eeg Include EEG instead of MEG.
--mag Include magnetometers instead of gradiometers.
--map number Select the quantity to compute:
1 : Maximum obtainable signal among all orientations
2 : Signal from sources normal to the cortex
3 : Ratio of signal from sources normal to the cortex and max
4 : Ratio of signal from sources normal to the cortex and max
5 : Subspace angle with the noise subspace
6 : Fraction of signal remaining after the projection
7 : Fraction of signal dampening due to the projection
Proposed documentation enhancement
The current documentation for the option 'mode' of mne.sensitivity_maps refers to a "manual" (presumbably the C-version of MNE), but there is no link (see below). I think the different choices should be explained in the documention of MNE-Python, without reference to a manual.
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.
The text was updated successfully, but these errors were encountered: