# napari-toska

[![License BSD-3](https://img.shields.io/pypi/l/napari-toska.svg?color=green)](https://github.com/allysonryan/napari-toska/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/napari-toska.svg?color=green)](https://pypi.org/project/napari-toska)
[![Python Version](https://img.shields.io/pypi/pyversions/napari-toska.svg?color=green)](https://python.org)
[![tests](https://github.com/allysonryan/napari-toska/workflows/tests/badge.svg)](https://github.com/allysonryan/napari-toska/actions)
[![codecov](https://codecov.io/gh/allysonryan/napari-toska/branch/main/graph/badge.svg)](https://codecov.io/gh/allysonryan/napari-toska)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-toska)](https://napari-hub.org/plugins/napari-toska)

Extracts and analyses topological skeletons as undirected graphs. For usage instructions and API reference, please refer to the documentation:

## [Documentation](https://allysonryan.github.io/napari-toska/).

![](https://github.com/allysonryan/napari-toska/raw/main/docs/imgs/3d_skeleton_analysis.gif)

The functionality of the plugin comprises the following:

- Extracting the topological skeleton of a binary image using the medial axis transform.
- Extracting the netowrk of the skeleton as an undirected `networkx` graph.
- Computing features of individual skeleton components as well as the entire skeleton network.

----------------------------------

This [napari] plugin was generated with [Cookiecutter] using [@napari]'s [cookiecutter-napari-plugin] template.

<!--
Don't miss the full getting started guide to set up your new package:
https://github.com/napari/cookiecutter-napari-plugin#getting-started

and review the napari docs for plugin developers:
https://napari.org/stable/plugins/index.html
-->

## Installation

You can install `napari-toska` via [pip]:

    pip install napari-toska




## 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-toska" 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

[napari]: https://github.com/napari/napari
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/
