org.openimaj.image.connectedcomponent

Class ConnectedComponentLabeler

java.lang.Object

org.openimaj.image.connectedcomponent.ConnectedComponentLabeler

All Implemented Interfaces:

org.openimaj.image.analyser.ImageAnalyser<org.openimaj.image.FImage>

public class ConnectedComponentLabeler
extends Object
implements org.openimaj.image.analyser.ImageAnalyser<org.openimaj.image.FImage>

A connected component labeler.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConnectedComponentLabeler.Algorithm Different algorithms for finding ConnectedComponents.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectedComponentLabeler.Algorithm	algorithm
protected float	bgThreshold
protected List<org.openimaj.image.pixel.ConnectedComponent>	components
protected org.openimaj.image.pixel.ConnectedComponent.ConnectMode	mode

Constructor Summary

Constructors

Constructor and Description
ConnectedComponentLabeler(org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode) Construct using the default (two-pass) algorithm, background pixels having a value of 0 or less, and the given ConnectedComponent.ConnectMode.
ConnectedComponentLabeler(ConnectedComponentLabeler.Algorithm algorithm, org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode) Construct using the given algorithm, background pixels having a value of 0 or less, and the given ConnectedComponent.ConnectMode.
ConnectedComponentLabeler(ConnectedComponentLabeler.Algorithm algorithm, float bgThreshold, org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode) Construct using the given algorithm, background pixel threshold, and the given ConnectedComponent.ConnectMode.

Method Summary

Modifier and Type	Method and Description
void	analyseImage(org.openimaj.image.FImage image)
List<org.openimaj.image.pixel.ConnectedComponent>	findComponents(org.openimaj.image.FImage image) Syntactic sugar for calling analyseImage(FImage) followed by getComponents();
List<org.openimaj.image.pixel.ConnectedComponent>	getComponents()

Methods inherited from class java.lang.Object

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

Field Detail

bgThreshold

protected float bgThreshold

algorithm

protected ConnectedComponentLabeler.Algorithm algorithm

mode

protected org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode

components

protected List<org.openimaj.image.pixel.ConnectedComponent> components

Constructor Detail

ConnectedComponentLabeler

public ConnectedComponentLabeler(org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode)

Construct using the default (two-pass) algorithm, background pixels having a value of 0 or less, and the given ConnectedComponent.ConnectMode.

Parameters:

mode - the connection mode.

ConnectedComponentLabeler

public ConnectedComponentLabeler(ConnectedComponentLabeler.Algorithm algorithm,
                                 org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode)

Construct using the given algorithm, background pixels having a value of 0 or less, and the given ConnectedComponent.ConnectMode.

Parameters:

algorithm - the algorithm to use

mode - the connection mode.

ConnectedComponentLabeler

public ConnectedComponentLabeler(ConnectedComponentLabeler.Algorithm algorithm,
                                 float bgThreshold,
                                 org.openimaj.image.pixel.ConnectedComponent.ConnectMode mode)

Construct using the given algorithm, background pixel threshold, and the given ConnectedComponent.ConnectMode.

Parameters:

algorithm - the algorithm to use

bgThreshold - threshold at which pixels with lower values are considered to be the background

mode - the connection mode.

Method Detail

findComponents

public List<org.openimaj.image.pixel.ConnectedComponent> findComponents(org.openimaj.image.FImage image)

Syntactic sugar for calling analyseImage(FImage) followed by getComponents();

Parameters:

image - the image to extract components from

Returns:

the extracted components.

analyseImage

public void analyseImage(org.openimaj.image.FImage image)

Specified by:

analyseImage in interface org.openimaj.image.analyser.ImageAnalyser<org.openimaj.image.FImage>

getComponents

public List<org.openimaj.image.pixel.ConnectedComponent> getComponents()

Returns:

the list of components found in the last call to analyseImage(FImage).