mne-tools / mne-tools/mne-python
ENH: Warn if distances are bad
Open
Nobody has claimed this yet.
EASY
ENH
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 1.6k
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 100
Description
After excluding outliers, we should warn somewhere if people's coregistration is bad. Candidate automatic computation places:
plot_alignmentmake_forward_solutionmne.Report
Bad criteria could be > 5 mm (?) for either:
- median distance
- "trimmed mean" distance, where instead of trimming upper and lower, we just trim upper (25%? 50%?)
This can be a thin wrapper around the function implemented in #6512.
cc @jhouck in case you have ideas
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
Review the function implemented in issue #6512 and compare the candidate entry points: plot_alignment, make_forward_solution, and mne.Report. Clarify the distance statistic and threshold with maintainers, then define where the warning belongs and how its behavior should be tested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100