https://github.com/hanjinliu/napari-filaments
A napari plugin for filament analysis
https://github.com/hanjinliu/napari-filaments
napari
Last synced: 8 months ago
JSON representation
A napari plugin for filament analysis
- Host: GitHub
- URL: https://github.com/hanjinliu/napari-filaments
- Owner: hanjinliu
- License: bsd-3-clause
- Created: 2022-06-21T14:16:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-03T03:23:10.000Z (almost 2 years ago)
- Last Synced: 2025-02-02T00:31:46.873Z (8 months ago)
- Topics: napari
- Language: Python
- Homepage:
- Size: 611 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# napari-filaments
[](https://github.com/hanjinliu/napari-filaments/raw/main/LICENSE)
[](https://pypi.org/project/napari-filaments)
[](https://python.org)
[](https://github.com/hanjinliu/napari-filaments/actions)
[](https://codecov.io/gh/hanjinliu/napari-filaments)
[](https://napari-hub.org/plugins/napari-filaments)
A napari plugin for filament analysis.
This plugin helps you to manually track filaments using path shapes of `Shapes` layer.
Currently implemented functions
- Fit paths to filaments in an image as a 2-D spline curve.
- Clip/extend paths.
- Measurement of filament length at sub-pixel precision.
- Basic quantification (mean, std, etc.) along paths.
- Import paths from ImageJ ROI file.
Basic Usage
-----------
Click `Layers > open image` to open a tif file. You'll find the image you chose and a shapes layer are added to the layer list.
- The "target filaments" box shows the working shapes layer.
- The "target image" box shows the image layer on which fitting and quantification will be conducted.
- The "filament" box shows currently selected shape (initially this box is empty).
Add path shapes and push key `F1` to fit the shape to the filament in the target image layer.
- In the "Spline" tab, you can cut/extend or re-fit splines.
- In the "Measure" tab, click "measure property" to measure mean instensity etc along each spline.
How it works
------------
Spline fitting is done as following.
----------------------------------
This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.
## Installation
You can install `napari-filaments` via [pip]:
pip install napari-filaments
To install latest development version :
pip install git+https://github.com/hanjinliu/napari-filaments.git
## Contributing
Contributions are very welcome. Tests can be run with [tox], please ensure
the coverage at least stays the same before you submit a pull request.
## License
Distributed under the terms of the [BSD-3] license,
"napari-filaments" is free and open source software
## Issues
If you encounter any problems, please [file an issue] along with a detailed description.
[napari]: https://github.com/napari/napari
[Cookiecutter]: https://github.com/audreyr/cookiecutter
[@napari]: https://github.com/napari
[MIT]: http://opensource.org/licenses/MIT
[BSD-3]: http://opensource.org/licenses/BSD-3-Clause
[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt
[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt
[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0
[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt
[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin
[file an issue]: https://github.com/hanjinliu/napari-filaments/issues
[napari]: https://github.com/napari/napari
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/