org.openimaj.image.pixel

Enum ConnectedComponent.ConnectMode

java.lang.Object

java.lang.Enum<ConnectedComponent.ConnectMode>

org.openimaj.image.pixel.ConnectedComponent.ConnectMode

All Implemented Interfaces:

Serializable, Comparable<ConnectedComponent.ConnectMode>

Enclosing class:

ConnectedComponent

public static enum ConnectedComponent.ConnectMode
extends Enum<ConnectedComponent.ConnectMode>

For boundary representations of ConnectedComponents, this enum determines and specifies how the boundary is calculated; either using a 4-connected rule, or an 8-connected rule.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECT_4 4-connected edges in the boundary representation
CONNECT_8 8-connected edges in the boundary representation

Method Summary

Methods

Modifier and Type	Method and Description
List<Pixel>	getNeighbours(FImage image, int x, int y, float bgThreshold) Get the neighbouring pixels
static ConnectedComponent.ConnectMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ConnectedComponent.ConnectMode[]	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

CONNECT_4

public static final ConnectedComponent.ConnectMode CONNECT_4

4-connected edges in the boundary representation

CONNECT_8

public static final ConnectedComponent.ConnectMode CONNECT_8

8-connected edges in the boundary representation

Method Detail

values

public static ConnectedComponent.ConnectMode[] 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 (ConnectedComponent.ConnectMode c : ConnectedComponent.ConnectMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConnectedComponent.ConnectMode 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

getNeighbours

public List<Pixel> getNeighbours(FImage image,
                        int x,
                        int y,
                        float bgThreshold)

Get the neighbouring pixels

Parameters:

image - the image

x - the x ordinate

y - the y ordinate

bgThreshold - the threshold for below which pixels should be ignored

Returns:

the neighbouring pixels