Skip to main content

napari plugin for Flow-Registration motion correction

Project description

🚧 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.0a1.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.0a1-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for napari_flowreg-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 de25f2c3d2bb72baab622d1b0a51d9cc1d2f6ea50ca79edca498dc1a9da9b5e6
MD5 24f240449635bac220fdd98c463ea104
BLAKE2b-256 2dbc7d5d968bcf40c3d134c4e515e4701bc23bd708310abf5ec3d4058a156de2

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_flowreg-0.1.0a1.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.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for napari_flowreg-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 f955cd03ffa11322380012c9afb5d872c0de3027fa2f128a74f51e736fb31be1
MD5 d2543c72b2195d353b3e14a56bbe10c9
BLAKE2b-256 2073cc04a19ee1fd9f98aa927acccd519e59eb0ae256dfebec468d4249e5f60a

See more details on using hashes here.

Provenance

The following attestation bundles were made for napari_flowreg-0.1.0a1-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