org.openimaj.image.connectedcomponent

Enum ConnectedComponentLabeler.Algorithm

java.lang.Object

java.lang.Enum<ConnectedComponentLabeler.Algorithm>

org.openimaj.image.connectedcomponent.ConnectedComponentLabeler.Algorithm

All Implemented Interfaces:

Serializable, Comparable<ConnectedComponentLabeler.Algorithm>

Enclosing class:

ConnectedComponentLabeler

public static enum ConnectedComponentLabeler.Algorithm
extends Enum<ConnectedComponentLabeler.Algorithm>

Different algorithms for finding ConnectedComponents.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOOD_FILL The flood-fill algorithm
SINGLE_PASS A single-pass algorithm
TWO_PASS The standard two-pass algorithm.

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<ConnectedComponent>	findComponents(FImage image, float bgThreshold, ConnectedComponent.ConnectMode mode) Find the connected components in an image.
static ConnectedComponentLabeler.Algorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConnectedComponentLabeler.Algorithm[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SINGLE_PASS

public static final ConnectedComponentLabeler.Algorithm SINGLE_PASS

A single-pass algorithm

TWO_PASS

public static final ConnectedComponentLabeler.Algorithm TWO_PASS

The standard two-pass algorithm.

FLOOD_FILL

public static final ConnectedComponentLabeler.Algorithm FLOOD_FILL

The flood-fill algorithm

Method Detail

values

public static ConnectedComponentLabeler.Algorithm[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ConnectedComponentLabeler.Algorithm c : ConnectedComponentLabeler.Algorithm.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ConnectedComponentLabeler.Algorithm valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

findComponents

public abstract List<ConnectedComponent> findComponents(FImage image,
                                      float bgThreshold,
                                      ConnectedComponent.ConnectMode mode)

Find the connected components in an image.

Parameters:

image - the image

bgThreshold - the threshold below which pixels should be considered to be background

mode - the ConnectedComponent.ConnectMode.

Returns:

the connected components