org.openimaj.image.processing.morphology

Class StructuringElement

java.lang.Object

org.openimaj.image.processing.morphology.StructuringElement

public class StructuringElement
extends Object

Morphological structuring element The central element is the pixel 0,0. Other s.e. pixels are relative to this.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static StructuringElement	BOX Standard 3x3 box structuring element
static StructuringElement	CROSS Standard 3x3 cross structuring element
static StructuringElement	HPIT Standard horizontal pit structuring element [x .
Set<Pixel>	negative Set of negative pixels in the structuring element
Set<Pixel>	positive Set of positive pixels in the structuring element

Constructor Summary

Constructors

Constructor and Description
StructuringElement() Construct an empty structuring element
StructuringElement(Pixel[] positive, Pixel[] negative) Construct a structuring element with the given positive and negative pixels
StructuringElement(Set<Pixel> positive, Set<Pixel> negative) Construct a structuring element with the given positive and negative pixels

Method Summary

Modifier and Type	Method and Description
int	countActive() Count the total (positive and negative) number of pixels in this structuring element
static StructuringElement	disk(int radius) Build a disk shaped structuring element with the given radius.
boolean	matches(Pixel p, Set<Pixel> pixels) Determine if this structuring element is completely contained in the pixels centered at p.
static StructuringElement	parseElement(String ele, int cx, int cy) Construct a structuring element from a @link{String} of the form produced by @link{#toString()}.
int[]	size() Get the size of the structuring element in the form [width, height, x, y]
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BOX

public static final StructuringElement BOX

Standard 3x3 box structuring element

CROSS

public static final StructuringElement CROSS

Standard 3x3 cross structuring element

HPIT

public static final StructuringElement HPIT

Standard horizontal pit structuring element [x . x]

positive

public Set<Pixel> positive

Set of positive pixels in the structuring element

negative

public Set<Pixel> negative

Set of negative pixels in the structuring element

Constructor Detail

StructuringElement

public StructuringElement()

Construct an empty structuring element

StructuringElement

public StructuringElement(Set<Pixel> positive,
                          Set<Pixel> negative)

Construct a structuring element with the given positive and negative pixels

Parameters:

positive - the positive pixels

negative - the negative pixels

StructuringElement

public StructuringElement(Pixel[] positive,
                          Pixel[] negative)

Construct a structuring element with the given positive and negative pixels

Parameters:

positive - the positive pixels

negative - the negative pixels

Method Detail

size

public int[] size()

Get the size of the structuring element in the form [width, height, x, y]

Returns:

the size of the structuring element

parseElement

public static StructuringElement parseElement(String ele,
                                              int cx,
                                              int cy)

Construct a structuring element from a @link{String} of the form produced by @link{#toString()}.

Parameters:

ele - the string defining the element

cx - the top-left x-coordinate

cy - the top-left y-coordinate

Returns:

a new structuring element

See Also:

toString()

toString

public String toString()

Overrides:

toString in class Object

matches

public boolean matches(Pixel p,
                       Set<Pixel> pixels)

Determine if this structuring element is completely contained in the pixels centered at p.

Parameters:

p - the centre

pixels - the pixels

Returns:

true if completely contained, false otherwise

countActive

public int countActive()

Count the total (positive and negative) number of pixels in this structuring element

Returns:

the total number of pixels

disk

public static StructuringElement disk(int radius)

Build a disk shaped structuring element with the given radius.

Parameters:

radius - the disk radius

Returns:

the disk shaped S.E.