org.openimaj.image.processing.restoration.inpainting

Class AbstractImageMaskInpainter<IMAGE extends Image<?,IMAGE>>

java.lang.Object

org.openimaj.image.processing.restoration.inpainting.AbstractImageMaskInpainter<IMAGE>

Type Parameters:

IMAGE - The type of image that this processor can process

All Implemented Interfaces:

Inpainter<IMAGE>, ImageProcessor<IMAGE>, Processor<IMAGE>

Direct Known Subclasses:

AbstractFMMInpainter, EfrosLeungInpainter

public abstract class AbstractImageMaskInpainter<IMAGE extends Image<?,IMAGE>>
extends Object
implements Inpainter<IMAGE>

Abstract base for Inpainter implementations that consume a mask image (rather than connected components or pixel sets). Provides the necessary methods to build the mask image for all the various calls to setMask.

All setMask implementations call initMask(), which subclasses should implement to perform any required initialisation. processImage(Image) performs checks on the image dimensions and then calls performInpainting(Image).

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected FImage	mask The mask image

Constructor Summary

Constructors

Constructor and Description
AbstractImageMaskInpainter()

Method Summary

Modifier and Type	Method and Description
protected void	initMask() Perform any initialisation once the mask has been set.
protected abstract void	performInpainting(IMAGE image) Perform the inpainting of the given image
void	processImage(IMAGE image) Inpaint the given image, painting all the mask pixels set by a prior call to Inpainter.setMask(int,int,Collection), Inpainter.setMask(FImage) or Inpainter.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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mask

protected FImage mask

The mask image

Constructor Detail

AbstractImageMaskInpainter

public AbstractImageMaskInpainter()

Method Detail

setMask

public void setMask(FImage mask)

Description copied from interface: Inpainter

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

Specified by:

setMask in interface Inpainter<IMAGE extends Image<?,IMAGE>>

Parameters:

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

setMask

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

Description copied from interface: Inpainter

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

Specified by:

setMask in interface Inpainter<IMAGE extends Image<?,IMAGE>>

Parameters:

width - the mask width

height - the mask height

mask - the mask pixels

setMask

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

Description copied from interface: Inpainter

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

Specified by:

setMask in interface Inpainter<IMAGE extends Image<?,IMAGE>>

Parameters:

width - the mask width

height - the mask height

mask - the mask pixels

initMask

protected void initMask()

Perform any initialisation once the mask has been set. Does nothing by default; subclasses should override as required.

processImage

public final void processImage(IMAGE image)

Description copied from interface: Inpainter

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

Specified by:

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

Specified by:

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

Parameters:

image - the image to perform inpainting on

performInpainting

protected abstract void performInpainting(IMAGE image)

Perform the inpainting of the given image

Parameters:

image - the image to inpaint