org.openimaj.image.processing.convolution

Enum FImageGradients.Mode

java.lang.Object

java.lang.Enum<FImageGradients.Mode>

org.openimaj.image.processing.convolution.FImageGradients.Mode

All Implemented Interfaces:

Serializable, Comparable<FImageGradients.Mode>

Enclosing class:

FImageGradients

public static enum FImageGradients.Mode
extends Enum<FImageGradients.Mode>

Modes of operation for signed and unsigned orientations

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
Signed Signed orientations +/- PI computed using atan2.
Unsigned Unsigned orientations in +/- PI/2 computed using atan.

Method Summary

Modifier and Type	Method and Description
float	maxAngle() Get the maximum angular value (in radians) computed by this mode.
float	minAngle() Get the minimum angular value (in radians) computed by this mode.
static FImageGradients.Mode	valueOf(String name) Returns the enum constant of this type with the specified name.
static FImageGradients.Mode[]	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

Unsigned

public static final FImageGradients.Mode Unsigned

Unsigned orientations in +/- PI/2 computed using atan.

Signed

public static final FImageGradients.Mode Signed

Signed orientations +/- PI computed using atan2.

Method Detail

values

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

Returns:

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

valueOf

public static FImageGradients.Mode 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

minAngle

public float minAngle()

Get the minimum angular value (in radians) computed by this mode.

Returns:

the minimum angular value.

maxAngle

public float maxAngle()

Get the maximum angular value (in radians) computed by this mode.

Returns:

the maximum angular value.