mne-tools / mne-tools/mne-python
Get more outputs from rap_music
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
rap_music function currently returns list of dipole objects and residuals. Dipole object only contains the information about dipole position and orientation in euclidean coords. It's not however possible to know to which source from the source space this dipole corresponds, its hemisphere and what is its leadfield.
It would be useful to have a possibility to get the source index and corresponding topography as an output of rap_music:
dipoles, idx, hemi, lf = rap_music(evoked, fwd, noise_cov, n_dipoles=3,
return_source_idx=True,
return_leadfields=True)
By the way, the source index is printed in logs in current implementation:
source 1 found: p = 14659
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the rap_music entry point and inspect how dipoles, residuals, and the logged source index are currently produced. Trace the source-space and leadfield data used during fitting. Done means the requested source index, hemisphere, and leadfield outputs are available alongside the existing results without losing current behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100