flood-napari 0.0.2
A simple plugin to flood 8-bit 2D images by means of a big blue label
License: BSD-3-Clause
Requires Python: >=3.7

# flood-napari

[![License](https://img.shields.io/pypi/l/flood-napari.svg?color=green)](https://github.com/zoccoler/flood-napari/raw/main/LICENSE)
[![PyPI](https://img.shields.io/pypi/v/flood-napari.svg?color=green)](https://pypi.org/project/flood-napari)
[![Python Version](https://img.shields.io/pypi/pyversions/flood-napari.svg?color=green)](https://python.org)
[![tests](https://github.com/zoccoler/flood-napari/workflows/tests/badge.svg)](https://github.com/zoccoler/flood-napari/actions)
[![codecov](https://codecov.io/gh/zoccoler/flood-napari/branch/main/graph/badge.svg)](https://codecov.io/gh/zoccoler/flood-napari)
[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/flood-napari)](https://napari-hub.org/plugins/flood-napari)

A simple plugin to flood 8-bit 2D images by means of a big blue label.

Essentially, it creates a label by manual thresholding the image. It can be used as a visual feedback to probe background heterogeneities.

This plugin was created as result of a teachig material. Each of the 3 modules was implemented differently (check this [blog post](https://biapol.github.io/blog/marcelo_zoccoler/entry_user_interf3/) for more information about each implementation), but the result is similar.

![](https://github.com/zoccoler/flood-napari/raw/main/images/flood_napari_demo.gif)

----------------------------------

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/docs/plugins/index.html
-->

## Installation

First install napari with:

    pip install napari[all]

Then, you can install `flood-napari` via [pip]:

    pip install flood-napari



To install latest development version :

    pip install git+https://github.com/zoccoler/flood-napari.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,
"flood-napari" 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/zoccoler/flood-napari/issues

[napari]: https://github.com/napari/napari
[tox]: https://tox.readthedocs.io/en/latest/
[pip]: https://pypi.org/project/pip/
[PyPI]: https://pypi.org/