{"name":"napari-flowreg","display_name":"Flow-Registration Motion Correction and Analysis for 2P Imaging","visibility":"public","icon":"","categories":[],"schema_version":"0.1.0","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-flowreg.flowreg_widget","title":"open widget","python_name":"napari_flowreg.flowreg_widget:FlowRegWidget","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":null,"writers":null,"widgets":[{"command":"napari-flowreg.flowreg_widget","display_name":"Flow-Registration","autogenerate":false}],"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.4","name":"napari-flowreg","version":"0.1.0a3","dynamic":null,"platform":null,"supported_platform":null,"summary":"napari plugin for Flow-Registration motion correction","description":"[](https://pypi.org/project/napari-flowreg/)\n[](https://pypi.org/project/napari-flowreg/)\n[](LICENSE)\n[](https://pypistats.org/packages/napari-flowreg)\n[](https://github.com/FlowRegSuite/napari-flowreg/actions/workflows/pypi-release.yml)\n\n## 🚧 Under Development\n\nThis project is still in an **alpha stage**. Expect rapid changes, incomplete features, and possible breaking updates between releases. \n\n- The API may evolve as we stabilize core functionality. \n- Documentation and examples are incomplete. \n- Feedback and bug reports are especially valuable at this stage.\n\n# ![\"FlowReg](\"https://raw.githubusercontent.com/FlowRegSuite/pyflowreg/refs/heads/main/img/flowreglogo.png\")
napari-FlowReg\n\nThis repository contains the napari wrapper for the Flow-Registration toolbox, which is a toolbox for the compensation and stabilization of multichannel microscopy videos. \nThe publication for this toolbox can be found [here](https://doi.org/10.1002/jbio.202100330) and the project website with video results [here](https://www.snnu.uni-saarland.de/flow-registration/).\n\n**Related projects**\n- PyFlowReg: https://github.com/FlowRegSuite/pyflowreg\n- Original Flow-Registration repo: https://github.com/FlowRegSuite/flow_registration\n- ImageJ/Fiji plugin: https://github.com/FlowRegSuite/flow_registration_IJ\n\n\n\n\n\n## Installation via pip and conda\n\nTo install the plugin via conda, you can create a new environment and install `napari` along with the plugin:\n\n conda create -n flowreg -c conda-forge python=3.12.0 napari\n\nYou can then install `napari-flowreg` via [pip]:\n\n pip install napari[all] napari-flowreg\n\nor from the directly from the GitHub repository:\n\n pip install git+https://github.com/flowregsuite/napari-flowreg.git\n\n\n## Dataset\n\nThe dataset which we used for our evaluations is available as [2-Photon Movies with Motion Artifacts](https://drive.google.com/drive/folders/1fPdzQo5SiA-62k4eHF0ZaKJDt1vmTVed?usp=sharing).\n\n## Citation\n\nDetails on the original method and video results can be found [here](https://www.snnu.uni-saarland.de/flow-registration/).\n\nIf you use parts of this code or the plugin for your work, please cite\n\n> “Pyflowreg,” (in preparation), 2025.\n\nand \n\n> 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](https://doi.org/10.1002/jbio.202100330)\n\nBibTeX entry\n```\n@article{flotea2022a,\n author = {Flotho, P. and Nomura, S. and Kuhn, B. and Strauss, D. J.},\n title = {Software for Non-Parametric Image Registration of 2-Photon Imaging Data},\n year = {2022},\n journal = {J Biophotonics},\n doi = {https://doi.org/10.1002/jbio.202100330}\n}\n```\n","description_content_type":"text/markdown","keywords":null,"home_page":null,"download_url":null,"author":null,"author_email":"Philipp Flotho ","maintainer":null,"maintainer_email":null,"license":"CC BY-NC-SA 4.0","classifier":["Development Status :: 3 - Alpha","Framework :: napari","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","License :: OSI Approved :: BSD License","Operating System :: OS Independent","Topic :: Scientific/Engineering :: Image Processing"],"requires_dist":["pyflowreg[vis]>=0.1.0a4","qtpy","numpy","scipy>=1.10.0","matplotlib>=3.5.0","pytest>=7.0; extra == \"testing\"","pytest-cov>=4.0; extra == \"testing\"","pytest-qt; extra == \"testing\"","h5py; extra == \"testing\"","tifffile; extra == \"testing\"","napari[pyqt6]; extra == \"testing\"","napari[pyqt5]>=0.4.18; extra == \"dev\"","pre-commit; extra == \"dev\"","black; extra == \"dev\"","ruff; extra == \"dev\""],"requires_python":">=3.10","requires_external":null,"project_url":["Homepage, https://github.com/FlowRegSuite/napari-flowreg","Source, https://github.com/FlowRegSuite/napari-flowreg","Tracker, https://github.com/FlowRegSuite/napari-flowreg/issues","Documentation, https://flowregsuite.github.io/napari-flowreg/"],"provides_extra":["testing","dev"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}