Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Registration documentation is not aligned with default settings in the code. #774

Closed
danielsf opened this issue Nov 12, 2021 · 1 comment

Comments

@danielsf
Copy link

This paragraph in the documentation

We first perform rigid registration (assuming that the whole image
shifts by some (dy,dx)), and then optionally after that we perform
non-rigid registration (assuming that subsegments of the image shift by
separate amounts). To turn on non-rigid registration, set
``ops['nonrigid']=True``. We will outline the parameters of each
registration step below.

seems to imply that nonrigid registration is turned off by default. Consulting the code

https://github.com/MouseLand/suite2p/blob/main/suite2p/run_s2p.py#L89-L93

that is not the case. Nonrigid registration is turned on by default. This caused some confusion for us over the last few months. Can you please update the documentation to reflect what the code does?

@chriski777
Copy link
Collaborator

Hey @danielsf, sorry about that! This has been addressed in #869 and should accurately reflect the default settings once it's merged!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants