org.openimaj.image.processing.restoration.inpainting

Interface Inpainter<IMAGE extends Image<?,IMAGE>>

Type Parameters:

IMAGE - The type of image that this processor can process

All Superinterfaces:

ImageProcessor<IMAGE>, Processor<IMAGE>

All Known Implementing Classes:

AbstractFMMInpainter, AbstractImageMaskInpainter, EfrosLeungInpainter, TeleaInpainting

public interface Inpainter<IMAGE extends Image<?,IMAGE>>
extends ImageProcessor<IMAGE>

Interface defining an implementation of an inpainting algorithm. Inpainting algorithms are ImageProcessors, but it is expected that a mask showing which pixels need to be painted is provided before the processImage(Image) call.

Inpainters are necessarily not thread safe, but implementations are expected to be reusable once the mask has been reset. It is expected that a call to one of the setMask methods is made before every call to processImage(Image).

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
void	processImage(IMAGE image) Inpaint the given image, painting all the mask pixels set by a prior call to setMask(int,int,Collection), setMask(FImage) or setMask(int,int,PixelSet...)
void	setMask(FImage mask) Set the mask.
void	setMask(int width, int height, Collection<? extends Iterable<Pixel>> mask) Set the mask.
void	setMask(int width, int height, PixelSet... mask) Set the mask.

Method Detail

setMask

void setMask(FImage mask)

Set the mask. The mask configures which pixels need to be painted.

Parameters:

mask - the mask image; should be binary, with 1 values where painting needs to occur.

setMask

void setMask(int width,
             int height,
             Collection<? extends Iterable<Pixel>> mask)

Set the mask. The mask configures which pixels need to be painted.

Parameters:

width - the mask width

height - the mask height

mask - the mask pixels

setMask

void setMask(int width,
             int height,
             PixelSet... mask)

Set the mask. The mask configures which pixels need to be painted.

Parameters:

width - the mask width

height - the mask height

mask - the mask pixels

processImage

void processImage(IMAGE image)

Inpaint the given image, painting all the mask pixels set by a prior call to setMask(int,int,Collection), setMask(FImage) or setMask(int,int,PixelSet...)

Specified by:

processImage in interface ImageProcessor<IMAGE extends Image<?,IMAGE>>

Parameters:

image - the image to perform inpainting on