inra.ijpb.morphology

Enum Strel.Shape

java.lang.Object

java.lang.Enum<Strel.Shape>

inra.ijpb.morphology.Strel.Shape

All Implemented Interfaces:

Serializable, Comparable<Strel.Shape>

Enclosing interface:

Strel

public static enum Strel.Shape
extends Enum<Strel.Shape>

An enumeration of the different possible structuring element shapes. Each item of the enumeration can create Strel instances of specific class and of given size.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIAMOND Diamond of a given diameter
DISK Disk of a given radius
LINE_DIAG_DOWN Diagonal line of a given length
LINE_DIAG_UP Diagonal line of a given length
LINE_HORIZ Horizontal line of a given length
LINE_VERT Vertical line of a given length
OCTAGON Octagon of a given diameter
SQUARE Square of a given side

Method Summary

Modifier and Type	Method and Description
Strel	fromDiameter(int diam) Creates a structuring element of the given type and with the specified diameter.
static Strel.Shape	fromLabel(String label) Determines the strel shape from its label.
Strel	fromRadius(int radius) Creates a structuring element of the given type and with the specified radius.
static String[]	getAllLabels() Returns a set of labels for most of classical structuring elements.
String	toString()
static Strel.Shape	valueOf(String name) Returns the enum constant of this type with the specified name.
static Strel.Shape[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISK

public static final Strel.Shape DISK

Disk of a given radius

See Also:

DiskStrel

SQUARE

public static final Strel.Shape SQUARE

Square of a given side

See Also:

SquareStrel

DIAMOND

public static final Strel.Shape DIAMOND

Diamond of a given diameter

See Also:

DiamondStrel, Cross3x3Strel

OCTAGON

public static final Strel.Shape OCTAGON

Octagon of a given diameter

See Also:

OctagonStrel

LINE_HORIZ

public static final Strel.Shape LINE_HORIZ

Horizontal line of a given length

See Also:

LinearHorizontalStrel

LINE_VERT

public static final Strel.Shape LINE_VERT

Vertical line of a given length

See Also:

LinearVerticalStrel

LINE_DIAG_UP

public static final Strel.Shape LINE_DIAG_UP

Diagonal line of a given length

See Also:

LinearDiagUpStrel

LINE_DIAG_DOWN

public static final Strel.Shape LINE_DIAG_DOWN

Diagonal line of a given length

See Also:

LinearDiagDownStrel

Method Detail

values

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

Returns:

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

valueOf

public static Strel.Shape 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

toString

public String toString()

Overrides:

toString in class Enum<Strel.Shape>

Returns:

the label associated to this shape.

fromRadius

public Strel fromRadius(int radius)

Creates a structuring element of the given type and with the specified radius. The final size is given by 2 * radius + 1, to take into account the central pixel.

Parameters:

radius - the radius of the structuring element, in pixels

Returns:

a new structuring element

fromDiameter

public Strel fromDiameter(int diam)

Creates a structuring element of the given type and with the specified diameter.

Parameters:

diam - the orthogonal diameter of the structuring element (max of x and y sizes), in pixels

Returns:

a new structuring element

getAllLabels

public static String[] getAllLabels()

Returns a set of labels for most of classical structuring elements.

Returns:

a list of labels

fromLabel

public static Strel.Shape fromLabel(String label)

Determines the strel shape from its label.

Parameters:

label - the shape name of the structuring element

Returns:

a new Shape instance that can be used to create structuring elements

Throws:

IllegalArgumentException - if label is not recognized.