---
title: "Introduction to *EBImage*"
author: Andrzej Oleś, Gregoire Pau, Oleg Sklyar, Wolfgang Huber
email: andrzej.oles@gmail.com
package: EBImage
abstract: >
  `r Biocpkg("EBImage")` provides general purpose functionality for image processing and analysis. In the context of (high-throughput) microscopy-based cellular assays, EBImage offers tools to segment cells and extract quantitative cellular descriptors. This allows the automation of such tasks using the R programming language and facilitates the use of other tools in the R environment for signal processing, statistical modeling, machine learning and visualization with image data.
output: 
  BiocStyle::html_document:
    toc_float: true
graphics: yes
vignette: >
  %\VignetteIndexEntry{Introduction to EBImage}
  %\VignetteKeywords{image processing, visualization}
  %\VignettePackage{EBImage}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}  
---

```{r setup, echo=FALSE}
library(knitr)
.dpi = 100
set.seed(0)
opts_chunk$set(comment=NA, fig.align="center", dpi=.dpi)
knit_hooks$set(crop=NULL)
.output = output()
switch(.output,
        html = opts_chunk$set(fig.retina=1),
        latex = opts_chunk$set(out.width=".5\\textwidth")
)

.dev = switch(.output, html="svg", latex="pdf")
options(EBImage.display = "raster")
```

<p>![](logo.png){width=128 style="padding: 0px; margin: auto;"}</p>

# Getting started

`r Biocpkg("EBImage")` is an R package distributed as part of the [Bioconductor](http://bioconductor.org) project. To install the package, start R and enter:

```{r installation, eval=FALSE}
install.packages("BiocManager")
BiocManager::install("EBImage")
```

Once `r Rpackage("EBImage")` is installed, it can be loaded by the following command.

```{r library, message=FALSE}
library("EBImage")
```


# Reading, displaying and writing images

Basic `r Rpackage("EBImage")` functionality includes reading, writing, and displaying of images. Images are read using the function `readImage`, which takes as input a file name or an URL. To start off, let us load a sample picture distributed with the package.

```{r readImage}
f = system.file("images", "sample.png", package="EBImage")
img = readImage(f)
```

`r Rpackage("EBImage")` currently supports three image file formats: `jpeg`, `png` and `tiff`. This list is complemented by the `r Githubpkg("aoles/RBioFormats")` package providing support for a much wider range of file formats including proprietary microscopy image data and metadata.

The image which we just loaded can be visualized by the function `display`.

```{r display}
display(img, method="browser")
```

When called from an interactive R session, `display` opens the image in a JavaScript viewer in your web browser. Using the mouse or keyboard shortcuts, you can zoom in and out of the image, pan, and cycle through multiple image frames. Alternatively, the image can be displayed using R's build-in plotting facilities by calling `display` with the argument `method = "raster"`. The image is then drawn on the current device.  This allows to easily combine image data with other plotting functionality, for instance, add text labels.

```{r display-raster, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
display(img, method="raster")
text(x = 20, y = 20, label = "Parrots", adj = c(0,1), col = "orange", cex = 2)
```

The graphics displayed in an R device can be saved using `r Rpackage("base")` R functions `dev.print` or `dev.copy`. For example, lets save our annotated image as a JPEG file and verify its size on disk.

```{r dev-print, eval=FALSE}
filename = "parrots.jpg"
dev.print(jpeg, filename = filename , width = dim(img)[1], height = dim(img)[2])
```{r dev-print-pre, echo=FALSE, fig.show='hide', fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
display(img, method="raster")
text(x = 20, y = 20, label = "Parrots", adj = c(0,1), col = "orange", cex = 2)
filename = "parrots.jpg"
dev.print(jpeg, filename = filename , width = dim(img)[1], height = dim(img)[2])
```{r filesize}
file.info(filename)$size
```{r dev-print3, echo=FALSE, sfig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
invisible(file.remove(filename))
```

If R is not running interactively, e.g. for code in a package vignette, `"raster"` becomes the default method in `display`.
The default behavior of `display` can be overridden globally be setting the `"options("EBImage.display")` to either `"browser"` or `"raster"`. This is useful, for example, to preview images inside RStudio.

It is also possible to read and view color images,

```{r readImageColor-pre, echo=FALSE}
imgcol = readImage(system.file("images", "sample-color.png", package="EBImage"))
```{r readImageColor, eval=FALSE}
imgcol = readImage(system.file("images", "sample-color.png", package="EBImage"))
display(imgcol)
```{r readImageColor-post, echo=FALSE, fig.width=dim(imgcol)[1L]/.dpi, fig.height=dim(imgcol)[2L]/.dpi, dpi=.dpi/2}
display(imgcol)
```

or images containing several frames. If an image consists of multiple frames, they can be displayed all at once in a grid
arrangement by specifying the function argument `all = TRUE`,

```{r readImageMulti-pre, include=FALSE}
nuc = readImage(system.file("images", "nuclei.tif", package="EBImage"))
```{r readImageMulti, eval=FALSE}
nuc = readImage(system.file("images", "nuclei.tif", package="EBImage"))
display(nuc, method = "raster", all = TRUE)
```{r readImageMulti-post, echo=FALSE, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
display(nuc, method = "raster", all = TRUE)
```

or we can just view a single frame, for example, the second one.

```{r displayFrame, echo=FALSE, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi/2}
display(nuc, method = "raster", frame = 2)
```

Images can be saved to files using the `writeImage` function.  The image that we loaded was a `r toupper(strsplit(basename(f), split=".", fixed=TRUE)[[1L]][2L])` file; suppose now that we want to save this image as a JPEG
file.  The JPEG format allows to set a quality value between 1 and 100 for its
compression algorithm.  The default value of the `quality` argument of
`writeImage` is 100, here we use a smaller value, leading to smaller file size
at the cost of some reduction in image quality.

```{r writeImage, eval=FALSE}
writeImage(imgcol, "sample.jpeg", quality = 85)
```

Similarly, we could have saved the image as a TIFF file and set which 
compression algorithm we want to use. For a complete list of available parameters see `?writeImage`.


# Image data representation

`r Rpackage("EBImage")` uses a package-specific class `Image` to store and process images. It extends the R base class `array`, and all `r Rpackage("EBImage")` functions can also be called directly on matrices and arrays. You can find out more about this class by typing `?Image`.  Let us peek into the internal structure of an `Image` object.

```{r str}
str(img)
```

The `.Data` slot contains a numeric array of pixel intensities. We see that in this case the array is two-dimensional, with `r dim(img)[1L]` times `r dim(img)[2L]` elements, and corresponds to the pixel width and height of the image. These dimensions can be accessed using the `dim` function, just like for regular arrays.

```{r dim}
dim(img)
```

Image data can be accessed as a plain R `array` using the `imageData` accessor,

```{r imageData}
imageData(img)[1:3, 1:6]
```

and the `as.array` method can be used to coerce an `Image` to an `array`.

```{r as.array}
is.Image( as.array(img) )
```

The distribution of pixel intensities can be plotted in a histogram, and their range inspected using the `range` function.

```{r hist, fig.width=6, fig.height=6, dev=.dev}
hist(img)
range(img)
```

A useful summary of `Image` objects is also provided by the `show`
method, which is invoked if we simply type the object's name.

```{r show}
img
```

For a more compact representation without the preview of the intensities array use the `print` method with the argument `short` set to `TRUE`.

```{r print}
print(img, short=TRUE)
```

Let's now have a closer look a our color image.

```{r printcol}
print(imgcol, short=TRUE)
```

It differs from its grayscale counterpart `img` by the property `colorMode` and the number of dimensions. 
The `colorMode` slot turns out to be convenient when dealing with stacks of images.  If
it is set to `Grayscale`, then the third and all higher dimensions of the
array are considered as separate image frames corresponding, for instance, to
different z-positions, time points, replicates, etc.  On the other hand, if
`colorMode` is `Color`, then the third dimension is assumed to hold
different color channels, and only the fourth and higher dimensions---if present---are
used for multiple image frames. `imgcol` contains three color channels, which
correspond to the red, green and blue intensities of the photograph.  However, this does
not necessarily need to be the case, and the number of color channels is arbitrary.

The "frames.total" and "frames.render" fields shown by the object summary correspond to the total number of frames contained in the image, and to the number of rendered frames. These numbers can be accessed using the function `numberOfFrames` by specifying the `type` argument.

```{r numberOfFrames}
numberOfFrames(imgcol, type = "render")
numberOfFrames(imgcol, type = "total")
```

Image frames can be extracted using `getFrame` and `getFrames`. `getFrame` returns the i-th frame contained in the image y. If `type` is `"total"`, the function is unaware of the color mode and returns an xy-plane. For `type="render"` the function returns the i-th image as shown by the display function. While `getFrame` returns just a single frame, `getFrames` retrieves a list of frames which can serve as input to `lapply`-family functions. See the "Global thresholding" section for an illustration of this approach.

Finally, if we look at our cell data,

```{r nuc}
nuc
```
we see that it contains 4 total frames that correspond to the 4 separate greyscale images, as indicated by "frames.render".


# Color management

As described in the previous section, the class `Image` extends the base class `array` and uses
`colorMode` to store how the color information of the multi-dimensional data should be handled. 
The function `colorMode` can be used to access and change this property,
modifying the rendering mode of an image. For example, if we take a `Color` image and change its 
mode to `Grayscale`, then the image won't display as a single color image anymore but rather as three separate 
grayscale frames corresponding to the red, green and blue channels. The function `colorMode` does not change
the actual content of the image but only changes the way the image is rendered by `r Rpackage("EBImage")`.

```{r colorMode, fig.width=dim(imgcol)[1L]/.dpi, fig.height=dim(imgcol)[2L]/.dpi, dpi=.dpi}
colorMode(imgcol) = Grayscale
display(imgcol, all=TRUE)
```

Color space conversions between `Grayscale` and `Color` images are performed using the function `channel`.
It has a flexible interface which allows to convert either way between the modes, and can be used 
to extract color channels. Unlike `colorMode`, `channel` changes the pixel intensity values of the image.

`Color` to `Grayscale` conversion modes include taking a uniform average across the RGB channels,
and a weighted luminance preserving conversion mode better suited for display purposes.

The `asred`, `asgreen` and `asblue` modes convert a grayscale image or array into a color image of the specified hue. 

The convenience function `toRGB` promotes a grayscale image to RGB color space by replicating it across the red, green and blue channels, 
which is equivalent to calling `channel` with mode set to `rgb`. When displayed, this image doesn't look different from its grayscale origin, which is expected because the information between the color channels is the same. To combine three grayscale images into a single rgb image use the function `rgbImage`.

The function `Image` can be used to construct a color image from a character vector or array of named R colors (as listed by `colors()`) and/or hexadecimal strings of the form "\#rrggbb" or "\#rrggbbaa".

```{r Image-character, fig.width=7/.dpi, fig.height=7/.dpi, dpi=10*.dpi}
colorMat = matrix(rep(c("red","green", "#0000ff"), 25), 5, 5)
colorImg = Image(colorMat)
colorImg
display(colorImg, interpolate=FALSE)
```


# Manipulating images

Being numeric arrays, images can be conveniently manipulated by any of R's arithmetic operators. For example, we can produce a negative image by simply subtracting the image from its maximum value.

```{r negative, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
img_neg = max(img) - img
display( img_neg )
```

We can also increase the brightness of an image through addition, adjust the contrast through multiplication, and apply gamma correction through exponentiation.

```{r arithmetic, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
img_comb = combine(
  img,
  img + 0.3,
  img * 2,
  img ^ 0.5
)

display(img_comb, all=TRUE)
```

In the example above we have used `combine` to merge individual images into a single multi-frame image object.

Furthermore, we can crop and threshold images with standard matrix operations.
```{r cropthreshold-pre, echo=FALSE}
img_crop = img[366:749, 58:441]
img_thresh = img_crop > .5
```{r cropthreshold, eval=FALSE}
img_crop = img[366:749, 58:441]
img_thresh = img_crop > .5
display(img_thresh)
```{r cropthreshold-post, echo=FALSE, fig.width=dim(img_thresh)[1L]/.dpi, fig.height=dim(img_thresh)[2L]/.dpi, dpi=.dpi/2}
display(img_thresh)
```

The thresholding operation returns an `Image` object with binarized pixels values. 
The R data type used to store such an image is `logical`.
```{r img_thresh}
img_thresh
```

For image transposition, use `transpose` rather than R's `r Rpackage("base")` function `t`. This is because the former one works also on color and multiframe images by swapping its spatial dimensions.

```{r transpose, fig.width=dim(img)[2L]/.dpi, fig.height=dim(img)[1L]/.dpi, dpi=.dpi/2}
img_t = transpose(img)
display( img_t )
```


# Spatial transformations

We just saw one type of spatial transformation, transposition, but there are many more, for example translation, rotation, reflection and scaling. `translate` moves the image plane by the specified two-dimensional vector in such a way that pixels that end up outside the image region are cropped, and pixels that enter into the image region are set to background.
```{r translate, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
img_translate = translate(img, c(100,-50))
display(img_translate)
```

The background color can be set using the argument `bg.col` common to all relevant spatial transformation functions. The default sets the value of  background pixels to zero which corresponds to black. Let us demonstrate the use of this argument with `rotate` which rotates the image clockwise by the given angle.
```{r rotate-pre, echo=FALSE}
img_rotate = rotate(img, 30, bg.col = "white")
```{r rotate, eval=FALSE}
img_rotate = rotate(img, 30, bg.col = "white")
display(img_rotate)
```{r rotate-post, echo=FALSE, fig.width=dim(img_rotate)[1L]/.dpi, fig.height=dim(img_rotate)[2L]/.dpi, dpi=.dpi/2}
display(img_rotate)
```

To scale an image to desired dimensions use `resize`. If you provide only one of either width or height, the other dimension is automatically computed keeping the original aspect ratio. 
```{r resize-pre, echo=FALSE}
img_resize = resize(img, w=256, h=256)
```{r resize, eval=FALSE}
img_resize = resize(img, w=256, h=256)
display(img_resize )
```{r resize-post, echo=FALSE, fig.width=dim(img_resize)[1L]/.dpi, fig.height=dim(img_resize)[2L]/.dpi, dpi=.dpi/2}
display(img_resize)
```

The functions `flip` and  `flop` reflect the image around the image horizontal and vertical axis, respectively.

```{r flipflop, fig.width=2*dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
img_flip = flip(img)
img_flop = flop(img)

display(combine(img_flip, img_flop), all=TRUE)
```

Spatial linear transformations are implemented using the general `affine` transformation. It maps image pixel coordinates `px` using a 3x2 transformation matrix `m` in the following way: `cbind(px, 1) %*% m`. For example, horizontal sheer mapping can be applied by

```{r affine, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
m =  matrix(c(1, -.5, 128, 0, 1, 0), nrow=3, ncol=2)
img_affine = affine(img, m)
display( img_affine )
```


# Filtering

## Linear filters

A common preprocessing step involves cleaning up the images by removing
local artifacts or noise through smoothing.  An intuitive approach is to
define a window of a selected size around each pixel and average the values within that
neighborhood. After applying this procedure to all pixels, the new, smoothed image is obtained.
Mathematically, this can be expressed as
$$
f'(x,y) = \frac{1}{N} \sum_{s=-a}^{a}\sum_{t=-a}^{a} f(x+s, y+t),
$$
where $f(x,y)$ is the value of the pixel at position $(x, y)$, and $a$ determines the
window size, which is $2a+1$ in each direction.  $N=(2a+1)^2$ is the number of pixels
averaged over, and $f'$ is the new, smoothed image.

More generally, we can replace the moving average by a weighted average, using a weight
function $w$, which typically has the highest value at the window midpoint ($s=t=0$) and then
decreases towards the edges. 
$$
(w * f)(x,y) = \sum_{s=-\infty}^{+\infty} \sum_{t=-\infty}^{+\infty} w(s,t)\, f(x+s, y+s)
$$
For notational convenience, we let the summations range from $-\infty$ to $+\infty$, even if in practice the sums are finite 
and $w$ has only a finite number of non-zero values. In fact, we can think of the weight function $w$ as another image,
and this operation is also called the *convolution* of the images $f$ and $w$, indicated by the the symbol $*$.
Convolution is a linear operation in the sense that $w*(c_1f_1+c_2f_2)=c_1w*f_1 + c_2w*f_2$
for any two images $f_1$, $f_2$ and numbers $c_1$, $c_2$.


In `r Biocpkg("EBImage")`, the 2-dimensional convolution is implemented by the function `filter2`, and the auxiliary 
function `makeBrush` can be used to generate the weight function. 
In fact, `filter2` does not directly perform the summation indicated in the equation above.
Instead, it uses the Fast Fourier Transformation in a way that is mathematically equivalent 
but computationally more efficient.

```{r makeBrush, fig.width=6, fig.height=6, dev=.dev}
w = makeBrush(size = 31, shape = 'gaussian', sigma = 5)
plot(w[(nrow(w)+1)/2, ], ylab = "w", xlab = "", cex = 0.7)
```{r lopass, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
img_flo = filter2(img, w)
display(img_flo)
```

Here we have used a Gaussian filter of width 5 given by `sigma`. 
Other available filter shapes include `"box"` (default), `"disc"`, `"diamond"` and `"line"`, for some of which the kernel can be binary; see `?makeBrush` for details.

If the filtered image contains multiple frames, the filter is applied to each frame separately. For convenience, images can be also smoothed using the wrapper function `gblur` which performs Gaussian smoothing with the filter size automatically adjusted to `sigma`. 

```{r gblur, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
nuc_gblur = gblur(nuc, sigma = 5)
display(nuc_gblur, all=TRUE )
```

In signal processing the operation of smoothing an image is referred to as low-pass filtering. High-pass filtering is the opposite operation which allows to detect edges and sharpen images. This can be done, for instance, using a Laplacian filter.

```{r highpass, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
fhi = matrix(1, nrow = 3, ncol = 3)
fhi[2, 2] = -8
img_fhi = filter2(img, fhi)
display(img_fhi)
```

## Median filter

Another approach to perform noise reduction is to apply a median filter, which is a non-linear technique as opposed to the low pass convolution filter described in the previous section. Median filtering is particularly effective in the case of speckle noise, and has the advantage of removing noise while preserving edges. 

The local median filter works by scanning the image pixel by pixel, replacing each pixel by the median on of its neighbors inside a window of specified size. This filtering technique is provided in `r Rpackage("EBImage")` by the function `medianFilter`. We demonstrate its use by first corrupting the image with uniform noise, and reconstructing the original image by median filtering.

```{r medianFilter, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
l = length(img)
n = l/10
pixels = sample(l, n)
img_noisy = img
img_noisy[pixels] = runif(n, min=0, max=1)
display(img_noisy)
img_median = medianFilter(img_noisy, 1)
display(img_median)
```

## Morphological operations

Binary images are images which contain only two sets of pixels, with values, say 0 and 1, representing the background and foreground pixels. Such images are subject to several non-linear morphological operations: erosion, dilation, opening, and closing. These operations work by overlaying a mask, called the structuring element, over the binary image in the following way:

* erosion: For every foreground pixel, put the mask around it, and if any pixel covered by the mask is from the background, set the pixel to background.

* dilation: For every background pixel, put the mask around it, and if any pixel covered by the mask is from the foreground, set the pixel to foreground.

```{r logo-pre, echo=FALSE}
shapes = readImage(system.file('images', 'shapes.png', package='EBImage'))
logo = shapes[110:512,1:130]
```{r logo, eval=FALSE}
shapes = readImage(system.file('images', 'shapes.png', package='EBImage'))
logo = shapes[110:512,1:130]
display(logo)
```{r logo-post, echo=FALSE, fig.width=dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
display(logo)
```

```{r kern, fig.width=7/.dpi, fig.height=7/.dpi, dpi=10*.dpi}
kern = makeBrush(5, shape='diamond')
display(kern, interpolate=FALSE)
```

```{r morph, fig.width=2*dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
logo_erode= erode(logo, kern)
logo_dilate = dilate(logo, kern)

display(combine(logo_erode, logo_dilate), all=TRUE)
```

Opening and closing are combinations of the two operations above: opening performs erosion followed by dilation, while closing does the opposite, i.e, performs dilation followed by erosion. Opening is useful for morphological noise removal, as it removes small objects from the background, and closing can be used to fill small holes in the foreground. These operations are implemented by `opening` and `closing`.


# Thresholding

## Global thresholding

In the "Manipulating images" section we have already demonstrated how to set a global threshold on an image.
There we used an arbitrary cutoff value.
For images whose distribution of pixel intensities follows a bi-modal histogram a more systematic approach involves using the Otsu's method. Otsu's method is a technique to automatically perform clustering-based image thresholding. Assuming a bi-modal intensity distribution, the algorithm separates image pixels into foreground and background. The optimal threshold value is determined by minimizing the combined intra-class variance.

Otsu's threshold can be calculated using the function `otsu`. When called on a multi-frame image, the threshold is calculated for each frame separately resulting in a output vector of length equal to the total number of frames in the image.

```{r otsu, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
threshold = otsu(nuc)
threshold
nuc_th = combine( mapply(function(frame, th) frame > th, getFrames(nuc), threshold, SIMPLIFY=FALSE) )
display(nuc_th, all=TRUE)
```

Note the use of `getFrames` to split the image into a list of individual frames, and `combine` to merge the results back together.

## Adaptive thresholding

The idea of adaptive thresholding is that, compared to straightforward thresholding from 
the previous section, the threshold is allowed to be different in different
regions of the image. In this way, one can anticipate spatial dependencies of the
underlying background signal caused, for instance, by uneven illumination or by stray
signal from nearby bright objects.

Adaptive thresholding works by comparing each pixel's intensity to the background determined from a 
local neighbourhood. This can be achieved by comparing the image to its smoothed version, where the filtering
window is bigger than the typical size of objects we want to capture.

```{r filter2thresh, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
disc = makeBrush(31, "disc")
disc = disc / sum(disc)
offset = 0.05
nuc_bg = filter2( nuc, disc )
nuc_th = nuc > nuc_bg + offset
display(nuc_th, all=TRUE)
```

This technique assumes that the objects are relatively sparsely
distributed in the image, so that the signal distribution in the neighborhood is dominated
by background. While for the nuclei in our images this assumption makes sense, for other
situations you may need to make different assumptions. The adaptive thresholding 
using a linear filter with a rectangular box is provided by `thresh`,
which uses a faster implementation compared to directly using `filter2`.

```{r thresh, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
display( thresh(nuc, w=15, h=15, offset=0.05), all=TRUE )
```


# Image segmentation

Image segmentation performs partitioning of an image, and is typically used to identify objects in an image. Non-touching connected objects can be segmented using the function `bwlabel`, while `watershed` and `propagate` use more sophisticated algorithms able to separate objects which touch each other.

`bwlabel` finds every connected set of pixels other than the background, and relabels these sets with a unique increasing integer. It can be called on a thresholded binary image in order to extract objects.

```{r bwlabel}
logo_label = bwlabel(logo)
table(logo_label)
```

The pixel values of the `logo_label` image range from 0 corresponding to background to the number of objects it contains, which is given by

```{r max_logolabel}
max(logo_label)
```

To display the image we normalize it to the (0,1) range expected by the display function. This results in different objects being rendered with a different shade of gray.

```{r displaybw, fig.width=dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
display( normalize(logo_label) )
```

The horizontal grayscale gradient which can be observed reflects to the way `bwlabel` scans the image and labels the connected sets: from left to right and from top to bottom. Another way of visualizing the segmentation is to use the `colorLabels` function, which color codes the objects by a random permutation of unique colors.

```{r colorCode, fig.width=dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
display( colorLabels(logo_label) )
```

## Watershed 

Some of the nuclei in `nuc` are quite close to each other and get merged into one big object when thresholded, as seen in `nuc_th`.
`bwlabel` would incorrectly identify them as a single object. The watershed transformation allows to overcome this issue.
The `watershed` algorithm treats a grayscale image as a topographic relief, or heightmap. Objects that stand out of the background
are identified and separated by flooding an inverted source image. In case of a binary image its distance map  can serve as the input heightmap. The distance map, which contains for each pixel the distance to the nearest background pixel, can be obtained by `distmap`.

```{r watershed, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
nmask = watershed( distmap(nuc_th), 2 )
display(colorLabels(nmask), all=TRUE)
```

## Voronoi tesselation

Voronoi tessellation is useful when we have a set of seed points (or regions) and want to
partition the space that lies between these seeds in such a way that each point in the
space is assigned to its closest seed. This function is implemented in `r Rpackage("EBImage")` by the function `propagate`.
Let us illustrate the concept of Voronoi tessalation on a basic example. We use the nuclei mask `nmask` as seeds and
partition the space between them.

```{r voronoiExample, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
voronoiExamp = propagate(seeds = nmask, x = nmask, lambda = 100)
voronoiPaint = colorLabels (voronoiExamp)
display(voronoiPaint)
```

The basic definition of Voronoi tessellation, which we have given above, allows
for two generalizations:

* By default, the space that we partition is the full, rectangular image area, but indeed we could 
    restrict ourselves to any arbitrary subspace. This is akin to finding the shortest distance from each point to the next seed
    not in a simple flat landscape, but in a landscape that is interspersed by lakes and rivers (which you cannot cross), 
    so that all paths need to remain on the land. `propagate` allows for this generalization through its 
    `mask` argument. 

* By default, we think of the space as flat -- but in fact it could have hills and canyons, so that 
    the distance between two points in the landscape not only depends on their x- and y-positions but also on 
    the ascents and descents, up and down in z-direction, 
    that lie in between. You can specify such a landscape to `propagate` through its `x` argument.  
      
Mathematically, we can say that instead of the simple default case (a flat rectangle image with an Euclidean metric), we perform the Voronoi segmentation on a Riemann manifold, which
can have an arbitrary shape and an arbitrary metric.
Let us use the notation $x$ and $y$ for the column and row coordinates
of the image, and $z$ for the elevation of the landscape. For two neighboring points, defined
by coordinates $(x, y, z)$ and $(x+dx, y+dy, z+dz)$, the distance between them is given by
$$
ds = \sqrt{ \frac{2}{\lambda+1} \left[ \lambda \left( dx^2 + dy^2 \right) + dz^2 \right] }.
$$
For $\lambda=1$, this reduces to $ds = ( dx^2 + dy^2 + dz^2)^{1/2}$.
Distances between points further apart are obtained by summing $ds$ along the shortest path between them. 
The parameter $\lambda\ge0$ has been introduced as a convenient control of the relative weighting between sideways movement
(along the $x$ and $y$ axes) and vertical movement.  Intuitively, if you imagine yourself
as a hiker in such a landscape, by choosing $\lambda$ you can specify how much you are prepared to climb up
and down to overcome a mountain, versus sideways walking around it.
When $\lambda$ is large, the expression becomes equivalent to $ds = \sqrt{dx^2 + dy^2}$, i. e., 
the importance of $dz$ becomes negligible. This is what we did when we used `lambda = 100` in our `propagate` example.

A more advanced application of `propagate` to the segmentation of cell bodies is presented in the "Cell segmentation example" section.


# Object manipulation

## Object removal

`r Rpackage("EBImage")` defines an object mask as a set of pixels with the same unique integer value. Typically, images containing object masks are the result of segmentation functions such as `bwalabel`, `watershed`, or `propagate`. Objects can be removed from such images by `rmObject`, which deletes objects from the mask simply by setting their pixel values to 0. By default, after object removal all the remaining objects are relabeled so that the highest object ID corresponds to the number of objects in the mask. The `reenumerate` argument can be used to change this behavior and to preserve original object IDs. 
```{r rmObjects, fig.width=2*dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
objects = list(
    seq.int(from = 2, to = max(logo_label), by = 2),
    seq.int(from = 1, to = max(logo_label), by = 2)
    )
logos = combine(logo_label, logo_label)
z = rmObjects(logos, objects, reenumerate=FALSE)
display(z, all=TRUE)
```

In the example above we demonstrate how the object removal function can be applied to a multi-frame image by providing a list of object indicies to be removed from each frame. Additionally we have set `reenumerate` to `FALSE` keeping the original object IDs.

```{r uniqueIDs}
showIds = function(image) lapply(getFrames(image), function(frame) unique(as.vector(frame)))

showIds(z)
```

Recall that 0 stands for the background. If at some stage we decide to relabel the objects, we can use for this the standalone function `reenumarate`.

```{r reenumeratedIDs}
showIds( reenumerate(z) )
```

## Filling holes and regions

Holes in object masks can be filled using the function `fillHull`.

```{r fillHull, fig.width=dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
filled_logo = fillHull(logo)
display(filled_logo)
```

`floodFill` fills a region of an image with a specified color. The filling starts at the given point, and the filling region is expanded to a connected area in which the absolute difference in pixel intensities remains below `tolerance`. The color specification uses R color names for `Color` images, and numeric values for `Grayscale` images.

```{r floodFill-logo, fig.width=dim(logo)[1L]/.dpi, fig.height=dim(logo)[2L]/.dpi, dpi=.dpi}
rgblogo = toRGB(logo)
points = rbind(c(50, 50), c(100, 50), c(150, 50))
colors = c("red", "green", "blue")
rgblogo = floodFill(rgblogo, points, colors)
display( rgblogo )
```{r floodFill-img, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
display(floodFill(img, rbind(c(200, 300), c(444, 222)), col=0.2, tolerance=0.2))
```

## Highlighting objects

Given an image containing object masks,
the function `paintObjects` can be used to highlight the objects from the mask in the target image provided in the `tgt` argument. 
Objects can be outlined and filled with colors of given opacities specified in the `col` and `opac` arguments, respectively. If the color specification is missing or equals `NA` it is not painted.


```{r paintObjects, fig.width=dim(img)[1L]/.dpi, fig.height=dim(img)[2L]/.dpi, dpi=.dpi/2}
d1 = dim(img)[1:2]
overlay = Image(dim=d1)
d2 = dim(logo_label)-1

offset = (d1-d2) %/% 2

overlay[offset[1]:(offset[1]+d2[1]), offset[2]:(offset[2]+d2[2])] = logo_label

img_logo = paintObjects(overlay, toRGB(img), col=c("red", "yellow"), opac=c(1, 0.3), thick=TRUE)

display( img_logo )
```

In the example above we have created a new mask `overlay` matching the size of our target image `img`, and copied the mask containing the "EBImage" logo into that overlay mask. The output of `paintObjects` retains the color mode of its target image, therefore in order to have the logo highlighted in color it was necessary to convert `img` to an RGB image first, otherwise the result would be a grayscale image. The `thick` argument controls the object contour drawing: if set to `FALSE`, only the inner one-pixel wide object boundary is marked; if set to `TRUE`, also the outer boundary gets highlighted resulting in an increased two-pixel contour width.


# Cell segmentation example

We conclude our vignette by applying the functions described before to the task of segmenting cells. Our goal is to computationally identify and qualitatively characterize the cells in the sample fluorescent microscopy images. Even though this by itself may seem a modest goal, this approach can be applied to collections containing thousands of images, an that need no longer to be an modest aim!

We start by loading the images of nuclei and cell bodies. To visualize the cells we overlay these images as the green and the blue channel of a false-color image.

```{r load, fig.height=dim(nuc)[2L]/.dpi, fig.width=dim(nuc)[1L]/.dpi, warning=FALSE, dpi=.dpi}
nuc = readImage(system.file('images', 'nuclei.tif', package='EBImage'))
cel = readImage(system.file('images', 'cells.tif', package='EBImage'))

cells = rgbImage(green=1.5*cel, blue=nuc)
display(cells, all = TRUE)
```

First, we segment the nuclei using `thresh`, `fillHull`, `bwlabel`
and `opening`.

```{r nmask, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
nmask = thresh(nuc, w=10, h=10, offset=0.05)
nmask = opening(nmask, makeBrush(5, shape='disc'))
nmask = fillHull(nmask)
nmask = bwlabel(nmask)

display(nmask, all=TRUE)
```

Next, we use the segmented nuclei as seeds in the Voronoi segmentation of the cytoplasm.

```{r ctmask, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
ctmask = opening(cel>0.1, makeBrush(5, shape='disc'))
cmask = propagate(cel, seeds=nmask, mask=ctmask)

display(ctmask, all=TRUE)
```

To visualize our segmentation on the we use `paintObject`.

```{r res, fig.width=dim(nuc)[1L]/.dpi, fig.height=dim(nuc)[2L]/.dpi, dpi=.dpi}
segmented = paintObjects(cmask, cells, col='#ff00ff')
segmented = paintObjects(nmask, segmented, col='#ffff00')

display(segmented, all=TRUE)
```

# Session Info

```{r sessionInfo}
sessionInfo()
```
