ENH: TSPCA or regress_artifact

[larsoner]

We currently don't offer any (?) reference-sensor-based preprocessing. meegkit has TSPCA for this. I haven't used it much but some collaborators with a KIT system have had good results. Any objection to me adding it as a step?

As part of this, I'd need to find a dataset that has reference sensors... not sure if we have any so far.

[hoechenberger]

I'm not familiar with this method, but I don't have any objections to adding it!

[agramfort]

I would contribute this then to mne and not add an extra dependency here

[larsoner]

We had some discussion of doing that in https://github.com/mne-tools/mne-python/issues/7170#issuecomment-571505186 and after some additional discussion in https://github.com/mne-tools/mne-python/pull/9302#issuecomment-1289240892 about mne-incubator vs meegkit nothing came of it.

What's the issue with making meegkit an optional dependency if you use only tsPCA for example? It seems like we should leverage existing implementations when possible. And if/when we eventually move tsPCA somewhere else, then we update the dependency. Or are you worried it's not fully vetted/tested etc.?

[agramfort]

hum... deps are ok https://github.com/nbara/python-meegkit/blob/master/requirements.txt but my reflex is "if this is really useful" we should offer this with mne (make it work smoothy with Epochs/Raw, different sensor types etc.)

Message ID: @.***>

[larsoner]

Okay it looks like for at least one dataset mne.preprocessing.regress_artifact provides very similar (identical to a quick eye check) performance on one dataset.

WDYT about adding a regress_artifact = dict(picks=None, picks_artifact=None) for example? For my dataset that would be dict(picks="meg", picks_artifact=["MISC 001", "MISC 002", "MISC 003"]) for example. I think it would be flexible enough to allow regressing other artifacts people have recorded, too (e.g., EOG if they want rather than using SSP).

[agramfort]

you need adding an option to support mne.preprocessing.regress_artifact here?

[larsoner]

Yeah that's what I'm thinking