Metadata-Version: 2.1
Name: napari-blob-detection
Version: 0.0.2
Summary: Detects blobs in images
Home-page: https://github.com/andy-sweet/napari-blob-detection
Author: Andy Sweet, Chi-Li Chiu
Author-email: andrewdsweet@gmail.com, cchiu@chanzuckerberg.com
License: BSD-3-Clause
Project-URL: Bug Tracker, https://github.com/andy-sweet/napari-blob-detection/issues
Project-URL: Documentation, https://github.com/andy-sweet/napari-blob-detection#README.md
Project-URL: Source Code, https://github.com/andy-sweet/napari-blob-detection
Project-URL: User Support, https://github.com/andy-sweet/napari-blob-detection/issues
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Framework :: napari
Classifier: Topic :: Software Development :: Testing
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: BSD License
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
License-File: LICENSE

# napari-blob-detection

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

Detects blobs in images

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

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/plugins/stable/index.html
-->

This plugin consists of two widgets:

1. Detects blobs on images
2. Convert points layer to labels layer

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

### Detects blobs on images

This widget uses [scikit-image's blob detection algorithms](https://scikit-image.org/docs/stable/auto_examples/features_detection/plot_blob.html) to detect bright blobs on dark backgrounds.

Parameters

- method: Laplacian of Gaussian (most accurate) or Difference of Gaussian (faster approximation) 
- image: Image layer for blob detection. Can be a 2D, 3D, or higher dimensionality image.
- dimensionality: users can specify if the image is 2D(+t) or 3D(+t).
- min sigma: the smallest blob size to detect
- max sigma: the largest blob size to detect
- threshold: the lower the threshold, the more low intensity blobs are detected. 

Output

Blobs are represented by the Points layer.
The size of each blob is proportional to `Points.feature['sigma']`,
which signifies the scale at which the feature point was found.

### Convert points layer to labels layer

This widget takes a points layer and converts it into a labels layer, with the image dimension matching the selected image layer.
By converting points to labels, users can leverage feature extraction functions that are available to labels to the detected points.

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

## Installation

You can install `napari-blob-detection` via [pip]:

    pip install napari-blob-detection



To install latest development version :

    pip install git+https://github.com/andy-sweet/napari-blob-detection.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-blob-detection" 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/andy-sweet/napari-blob-detection/issues

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


