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

'mode' for mne.sensitivity_map not explained #12979

Open
olafhauk opened this issue Nov 21, 2024 · 1 comment
Open

'mode' for mne.sensitivity_map not explained #12979

olafhauk opened this issue Nov 21, 2024 · 1 comment
Labels
Milestone

Comments

@olafhauk
Copy link
Contributor

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.

@olafhauk olafhauk added the DOC label Nov 21, 2024
@larsoner
Copy link
Member

@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

@larsoner larsoner added this to the 1.9 milestone Nov 22, 2024
@larsoner larsoner modified the milestones: 1.9, 1.10 Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants