com.xinapse.filter
Enum SobelFilter.SobelType

java.lang.Object
  java.lang.Enum<SobelFilter.SobelType>
      com.xinapse.filter.SobelFilter.SobelType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SobelFilter.SobelType>

Enclosing class:

SobelFilter

public static enum SobelFilter.SobelType
extends java.lang.Enum<SobelFilter.SobelType>

An enumeration of the types of Sobel filters.

Enum Constant Summary

MAGNITUDE
The SobelType for a filter that computes the magnitude of the gradient.

X
The SobelType for a filter that computes the gradient in the along-row direction.

Y
The SobelType for a filter that computes the gradient in the along-column direction.

Z
The SobelType for a filter that computes the gradient in the through-slice direction.

Method Summary

static SobelFilter.SobelType	getInstance(java.lang.String name) Returns a SolbelType corresponding to the given name.
static SobelFilter.SobelType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SobelFilter.SobelType[]	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

X

public static final SobelFilter.SobelType X

The SobelType for a filter that computes the gradient in the along-row direction.

Y

public static final SobelFilter.SobelType Y

The SobelType for a filter that computes the gradient in the along-column direction.

Z

public static final SobelFilter.SobelType Z

The SobelType for a filter that computes the gradient in the through-slice direction.

MAGNITUDE

public static final SobelFilter.SobelType MAGNITUDE

The SobelType for a filter that computes the magnitude of the gradient.

Method Detail

values

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

Returns:

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

valueOf

public static SobelFilter.SobelType valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getInstance

public static SobelFilter.SobelType getInstance(java.lang.String name)

Returns a SolbelType corresponding to the given name.

Parameters:

name - the name of one of the SobelTypes.

Returns:

a SobelType with the given name, or the default type if the name is not recognised.