Refactor correct_motion into compute motion, then make interpolation

[chrishalcrow]

PR to re-factor the correct_motion function into two parts: compute_motion (which returns just a motion_info object) and interpolate_motion.

We expose the compute_motion function and edit the docs to use it. This encourages users to do the motion correction computation and check their results before interpolation (as Sam always tells us to do!). At the moment, to do this, the user has to do

_, motion, motion_info = si.correct_motion(recording=rec, preset="dredge_fast", output_motion=True, output_motion_info=True)

Then analyse the results. Now they can do

motion_info = si.compute_motion(recording=rec, preset="dredge_fast")

Which hopefully feels nicer.

Alessio also requested a raise_error argument, so that if the estimate_motion fails, the peaks and peak locations are still returned. Motion estimation often fails on e.g. a single shank-bank of a NP probe. But it can still be helpful to do a raster plot of the peaks. Hence this seems helpful. Note: it returns motion_info['motion'] = None at the moment.

I've done some little refactors, and updated some things to improve provenance. These are also in preparation for adding a new class ComputeMotionAndInterpolateRecording soon.

The correct_motion function should work exactly as before.

[chrishalcrow]

The previous code was poping some kwargs from the dict, which pop'd them out of the parameters dict, losing provenance. We now make a detect_kwargs_without_method so that we don't edit the detect_kwargs dict,

[chrishalcrow]

If raise_error is set to False and the estimate_motion function fails, the function still returns motion_info, just with motion = None.

[alejoe91]

This was my wish! Thank you! :)

[alejoe91]

I think that the save_motion_info / and load_motion_info should also be updated to handle motion=None. Maybe worth adding a test with a specified folder?

[chrishalcrow]

Done - now if motion = None, save_motion_info makes a folder with no motion subfolder. When load_motion_info finds this folder structure, it sets motion to None.

[alejoe91]

Just some tiny comments! Looks super :)

Have you tried medicine in the handle drift tutorial?

[alejoe91]

This was my wish! Thank you! :)

[chrishalcrow]

Hello, I'm trying medicine now - might be easier to leave it for another PR (I'll working more on this very soon!)