org.openimaj.image.analysis.algorithm

Class FloodFill<I extends Image<?,I> & SinglebandImageProcessor.Processable<Float,FImage,I>>

java.lang.Object

org.openimaj.image.analysis.algorithm.FloodFill<I>

Type Parameters:

I - type of image

All Implemented Interfaces:

ImageAnalyser<I>

public class FloodFill<I extends Image<?,I> & SinglebandImageProcessor.Processable<Float,FImage,I>>
extends Object
implements ImageAnalyser<I>

Flood-fill of @link{FImage}s or @link{MBFImage}s.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FloodFill(int x, int y, float threshold) Construct flood-fill processor with the given threshold and starting coordinate.
FloodFill(Pixel startPixel, float threshold) Construct flood-fill processor with the given threshold and starting coordinate.

Method Summary

Modifier and Type	Method and Description
protected static <T> boolean	accept(Image<T,?> image, Pixel n, T initial, float threshold)
void	analyseImage(I image) Analyse an image.
static <T> FImage	floodFill(Image<T,?> image, int startx, int starty, float threshold) Flood-fill an image from the given starting pixel position with the given threshold.
static <T> FImage	floodFill(Image<T,?> image, Pixel start, float threshold) Flood-fill an image from the given starting pixel position with the given threshold.
FImage	getFlooded() Get the binary flooded image map

Methods inherited from class java.lang.Object

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

Constructor Detail

FloodFill

public FloodFill(int x,
                 int y,
                 float threshold)

Construct flood-fill processor with the given threshold and starting coordinate.

Parameters:

x - x-coordinate of start pixel

y - y-coordinate of start pixel

threshold - threshold for determing whether a pixel should be flooded

FloodFill

public FloodFill(Pixel startPixel,
                 float threshold)

Construct flood-fill processor with the given threshold and starting coordinate.

Parameters:

startPixel - coordinate of start pixel

threshold - threshold for determing whether a pixel should be flooded

Method Detail

analyseImage

public void analyseImage(I image)

Description copied from interface: ImageAnalyser

Analyse an image.

Specified by:

analyseImage in interface ImageAnalyser<I extends Image<?,I> & SinglebandImageProcessor.Processable<Float,FImage,I>>

Parameters:

image - The image to process in place.

getFlooded

public FImage getFlooded()

Get the binary flooded image map

Returns:

flooded image

accept

protected static <T> boolean accept(Image<T,?> image,
                                    Pixel n,
                                    T initial,
                                    float threshold)

floodFill

public static <T> FImage floodFill(Image<T,?> image,
                                   int startx,
                                   int starty,
                                   float threshold)

Flood-fill an image from the given starting pixel position with the given threshold.

Type Parameters:

T - The pixel type of the image

Parameters:

image - the image

startx - the x-coordinate of the start pixel

starty - the y-coordinate of the start pixel

threshold - the threshold for determining with a pixel should be filled

Returns:

a binary @link{FImage} with filled pixels from the input set to 1

floodFill

public static <T> FImage floodFill(Image<T,?> image,
                                   Pixel start,
                                   float threshold)

Flood-fill an image from the given starting pixel position with the given threshold.

Type Parameters:

T - The pixel type of the image

Parameters:

image - the image

start - the start pixel

threshold - the threshold for determining with a pixel should be filled

Returns:

a binary @link{FImage} with filled pixels from the input set to 1