Metadata-Version: 2.1
Name: lettuceSee
Version: 0.1.1
Summary: A package of image analysis algorithms suited for plants
Home-page: https://github.com/Chizz98/LettuceSee
Author: Chris Dijkstra
Author-email: chris_dijkstra98@hotmail.com
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: Scientific/Engineering :: Image Processing
Classifier: Intended Audience :: Science/Research
Description-Content-Type: text/markdown
Requires-Dist: scikit-image
Requires-Dist: scipy
Requires-Dist: numpy

# LettuceSee
A package with high level functions for analyzing images of plants.

## Example case
The following example showcases a miniature pipeline using lettuceSee and 
scikit-image functions. 

![](https://github.com/Chizz98/LettuceSee/raw/main/readme_images/original_image.png "Input image")

An image of lettuce affected with necrosis is loaded in as a numpy array. 
After removing the alpha layer, applying the shw_segmentation function from the
segment module removes the background of the image. 

```python
from lettuceSee import segment
import skimage
import matplotlib.pyplot as plt

image = skimage.io.imread(
    "Image/path/here.png"
)
image = skimage.util.img_as_ubyte(skimage.color.rgba2rgb(image))
bg_mask = segment.shw_segmentation(image)
```

![](https://github.com/Chizz98/LettuceSee/raw/main/readme_images/bg_mask1.png "Background mask")

The initial segmentation looks decent, however, there is still some background 
noise, as well as other plants intruding from the side. The function 
canny_central_ob is used to remove objects not attached to the central object, 
as well as connected objects with very different coloration.
```python
bg_mask = segment.canny_central_ob(image=image, mask=bg_mask, sigma=2.5)
```

![](https://github.com/Chizz98/LettuceSee/raw/main/readme_images/bg_mask2.png "Cleaned background mask")

After finishing the background segmentation, the function barb_hue is used to 
segment green from brown tissue through the method described in 
[Barbedo, 2016](https://doi.org/10.1007/s40858-016-0090-8).

```python
necrosis_mask = segment.barb_hue(image=image, bg_mask=bg_mask, div=3)
```
![](https://github.com/Chizz98/LettuceSee/raw/main/readme_images/necrosis_mask.png "Background + necrosis mask")

## Installation
The package can be installed from the pypi test distribution through:
```shell
pip install lettuceSee
```

### Anaconda
There is no dedicated lettuceSee installation for anaconda, if you do want to 
install the package within anaconda the following method is recommended:
First create a new environment following the [anaconda documentation](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#creating-an-environment-with-commands). 
Activate your fresh environment and install pip:
```shell
conda install pip
```
Following this run the usual command to install lettuceSee. Note that mixing 
conda and pip can lead to unexpected errors, as both are package managers. As 
such it is recommended to do further installations in this environment trough 
pip.

### Recommended extras
For visualization of the images, matplotlib is recommended. LettuceSee handles 
images as numpy arrays, which can be directly visualized trough 
matplotlib.pyplot. Matplotlib is not included in the installation of lettuceSee,
but can be installed trough:
```shell
pip install matplotlib
```
