napari-labels-overlap 0.0.3
create an overlap labels layer from two labels layers
License: BSD-3-Clause
Requires Python: >=3.7

# napari-labels-overlap

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

create an overlap labels layer from two labels layers

## Description

This plugin takes two labels layers (layerA, layerB) as inputs, and generate the overlapped regions as a binary labels layer.
Three modes:<br>
(1) A_OR_B: new layer = layerA OR layerB (union)<br>
(2) A_AND_B: new layer = layerA AND layerB (intersection)<br>
(3) A_OUTSIDE_B: new layer = layerA OUTSIDE layerB (complement)<br>

[comment]: <need to update the gif>

![labels_overlap](https://user-images.githubusercontent.com/89602983/144129087-9a88d55f-f1a0-4825-bd01-770909bfc64f.gif)

## Applicaions
- Object colocalization
- Merge separately identified objects

## Future work
- Support N labels layers
- Basic coloc stats (% volume overlap)
- Output Labels with distinct IDs and links to original label IDs

## Release log
- 0.0.2<br>
-- Run on npe2<br>
-- Add output types: binary/connected component<br>
- 0.0.1<br>
-- Run on npe1<br>


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

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

You can install `napari-labels-overlap` via [pip]:

    pip install napari-labels-overlap



To install latest development version :

    pip install git+https://github.com/chili-chiu/napari-labels-overlap.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-labels-overlap" 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/chili-chiu/napari-labels-overlap/issues

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