drift correction using dredge_lfp in Spikeinterface version 0.103.0

[cfshang-maker]

Hi guys,

I am raising an issue about using DREdge lfp method for drift correction of Neuropixels recording. With version 0.103.0, I failed to import estimate_motion and related from spikeinterface.preprocessing, as suggested in the online Tutorial. I went through the folders and found a motion.py in the folder //spikeinterface/preprocessing and some motion-related files in the folder //spikeinterface/sortingcomponents/. It seems only DREdge_ap was included in the compute_motion of the former. Maybe I could turn to spikeinterface.sortingcomponents.motion. Is it true?
If this is the case, the next question follows. The methods employed in the motion_estimation of spikeinterface.sortingcomponents include dredge_ap and dredge_lf, but only the former was shown with demo. Besides, a dredge.py was found in /***/spikeinterface/sortingcomponents/motion/ and includes dredge_lfp.

[chrishalcrow]

Hi @cfshang-maker . It looks like our documentation is out of date. You should run

from spikeinterface.sortingcomponents.motion import estimate_motion

to access estimate_motion. I'll update the docs now. If you find estimate_motion in the API (https://spikeinterface.readthedocs.io/en/stable/api.html#spikeinterface.sortingcomponents.motion.estimate_motion), you'll see that the options are ‘decentralized’, ‘iterative_template’, ‘dredge_lfp’, ‘dredge_ap’ and ‘medicine’.

Thanks for pointing out the problem :)

[cfshang-maker]

Hi @chrishalcrow
Many thanks for your prompt reply. I am enjoying it.
BEST,
Chun-feng