mne-tools / mne-tools/mne-python
Request for documentation of fig.mne.*
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
Several months ago under the discourse group I posted the question, Obtaining bad channels and annotations from command line without closing plot window.
@drammock suggested that if would like to see more documentation about fig.mne*, then perhaps I should open an issue on it and tag him.
The basic idea is that for gui development with mne, it's useful (at least it has been for me) to retrieve bad channels, annotations, etc. while the plot window is open. For example,
bads = fig.mne.info['bads']
annotations = fig.mne.inst.annotations
retrieves the currently marked bad channels and annotations.
A listing of other attributes of fig.mne would be helpful. For example, how can I retrieve the locations of vertical guides created by left-clicking on the plot background?
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 from the fig = raw.plot() example in the issue and inspect the plotting API that exposes fig.mne, including info and inst. Document the available fig.mne attributes and clarify whether vertical-guide locations can be retrieved. Done means the relevant attributes and retrieval method are described for GUI users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data-visualization, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100