mne.gui.coregistration() should accept instances in addition to filenames

Open
#10,209 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
api, desktop

Research direction

Start at mne.gui.coregistration() and trace how inst and trans are currently validated and loaded. Check the handling of Info, Epochs, Evoked, Raw, and Transform instances; done means these objects work alongside filenames without requiring temporary files.

Written by the indexing model from the issue text.

Description

API ENH VIZ

Currently, mne.gui.coregistration() expects the inst and trans parameters to be paths to files. This is inconsistent with how other bits of the API are are designed, and necessitates the creation of temporary files in certain workflows.

Instead, inst should accept Info, Epochs, Evoked, and Raw instances; and trans should accept Transform instances in addition to paths.

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from mne-tools/mne-python

All issues in mne-tools/mne-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.