Skip to content

DOC: Documentation for registration is out of date #1190

@mhturner

Description

@mhturner

Issue with current documentation:

I am interested in implementing the registration tools within suite2p in some larger python analysis pipelines and I came across this documentation for calling registration functions:

https://suite2p.readthedocs.io/en/latest/registration.html#

This documentation appears to be out of date, and refers to some methods that are no longer in the registration module, e.g. registration.prepare_masks and registration.phasecorr.

The command line tool works great but ideally I would like to be able to use these registration functions directly within python code to compute registered image series and return ndarrays. Scanning the current version of the registration module I am just having some trouble understanding how to use these updated functions to replicate what the documentation originally demonstrated.

Idea or request for content:

Can you provide updated example code to call these registration functions from within Python code?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions