Skip to main content

napari plugin for Flow-Registration motion correction

Project description

PyPI - Version PyPI - Python Version PyPI - License PyPI - Downloads GitHub Actions

🚧 Under Development

This project is still in an alpha stage. Expect rapid changes, incomplete features, and possible breaking updates between releases.

  • The API may evolve as we stabilize core functionality.
  • Documentation and examples are incomplete.
  • Feedback and bug reports are especially valuable at this stage.

FlowReg logo napari-FlowReg

This repository contains the napari wrapper for the Flow-Registration toolbox, which is a toolbox for the compensation and stabilization of multichannel microscopy videos. The publication for this toolbox can be found here and the project website with video results here.

Related projects

Fig1

Installation via pip and conda

To install the plugin via conda, you can create a new environment and install napari along with the plugin:

conda create -n flowreg -c conda-forge python=3.12.0 napari

You can then install napari-flowreg via [pip]:

pip install napari[all] napari-flowreg

or from the directly from the GitHub repository:

pip install git+https://github.com/flowregsuite/napari-flowreg.git

Dataset

The dataset which we used for our evaluations is available as 2-Photon Movies with Motion Artifacts.

Citation

Details on the original method and video results can be found here.

If you use parts of this code or the plugin for your work, please cite

“Pyflowreg,” (in preparation), 2025.

and

P. Flotho, S. Nomura, B. Kuhn and D. J. Strauss, “Software for Non-Parametric Image Registration of 2-Photon Imaging Data,” J Biophotonics, 2022. doi:https://doi.org/10.1002/jbio.202100330

BibTeX entry

@article{flotea2022a,
    author = {Flotho, P. and Nomura, S. and Kuhn, B. and Strauss, D. J.},
    title = {Software for Non-Parametric Image Registration of 2-Photon Imaging Data},
    year = {2022},
  journal = {J Biophotonics},
  doi = {https://doi.org/10.1002/jbio.202100330}
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

napari_flowreg-0.1.0a3.tar.gz (4.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

napari_flowreg-0.1.0a3-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file napari_flowreg-0.1.0a3.tar.gz.

File metadata

  • Download URL: napari_flowreg-0.1.0a3.tar.gz
  • Upload date:
  • Size: 4.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for napari_flowreg-0.1.0a3.tar.gz
Algorithm Hash digest
SHA256 2de5c76e8f6b3f98597543c26e82e26dbd585a18aa51df71f1cba8bd65891abb
MD5 6678f5ca94f12a09e9d653d3a33488ad
BLAKE2b-256 363cca8e22dcb7c400e24f29ac68f5a96d537caa8753c7df09ab83b7a3260101

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_flowreg-0.1.0a3.tar.gz:

Publisher: pypi-release.yml on FlowRegSuite/napari-flowreg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file napari_flowreg-0.1.0a3-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_flowreg-0.1.0a3-py3-none-any.whl
Algorithm Hash digest
SHA256 da9b7d3e484d2531b14d409fd637218d2f456696169ed2a4e9aab1975855298c
MD5 689d99432922501d628f8dec714123a6
BLAKE2b-256 8b3685626559c58391a6ca6e7afcfc7428dde8370cbca22da1961b31156b755a

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_flowreg-0.1.0a3-py3-none-any.whl:

Publisher: pypi-release.yml on FlowRegSuite/napari-flowreg

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page