mne-tools / mne-tools/mne-python
Evoked.plot_field() should default to calculating the surface maps on-the-fly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Currently, Evoked.plot_field() has a required paramter, surf_maps, which need to be constructed by calling make_field_map().
I don't like this two-step approach; can we make it such that surf_maps can become optional (default to None), and if it's not provided, we call make_field_map() automatically? We'd need to add a few additional parameters then, too, but we don't need to expose everything make_field_map() can do – adding trans, subject, subjects_dir, and picking some sane defaults for the rest should be sufficient.
WDYT?
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 Evoked.plot_field() and make_field_map() entry points named in the issue, and inspect how surf_maps is currently required and constructed. Determine the supported parameters and sane defaults for on-the-fly map creation; done means surf_maps can be omitted while existing explicit surf_maps usage continues to work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100